Article (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(28 dazwischenliegende Versionen von 6 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 
==Name==
 
==Name==
−
article - Objekt, dessen Daten mit einem [[Publisher]] publiziert werden können.
+
Article - Objekt, dessen Daten mit einem [[Publisher]] publiziert werden können.
  
 
==Beschreibung==
 
==Beschreibung==
−
Artikel sind Objekte, dessen Daten mit einem [[Publisher]] publiziert werden können. Sie benötigen ein Ausgabe-[[Template]] das bestimmt, in welcher Form die Daten Publiziert werden sollen. Im Gegensatz zu [[Resourcen]] können für Artikel keine [[Symbolischer Link|Sysmbolischen Links]] erzeugt werden (Artikel liegt in mehreren [[ArticlePool|ArticlePools]]). Die [[ArticlePool|ArticlePools]] definieren in welchem Verzeichnis der Artikel als Seite generiert wird. Läge der Artikel in mehreren [[ArticlePool|ArticlePools]] wäre diese Angabe nicht mehr eindeutig.
+
Artikel sind Objekte, dessen Daten mit einem [[Publisher]] publiziert werden können. Sie benötigen ein Ausgabe-[[Template]] das bestimmt, in welcher Form die Daten publiziert werden sollen. Im Gegensatz zu [[Resource|Resourcen]] können für Artikel keine [[Symbolischer Link|Symbolischen Links]] erzeugt werden (ein Symbolischer Link würde hier bedeuten, dass ein Artikel in mehreren [[ArticlePool|ArticlePools]] liegt). Die [[ArticlePool|ArticlePools]] definieren in welchem Verzeichnis der Artikel als Seite generiert wird. Läge der Artikel in mehreren [[ArticlePool|ArticlePools]] wäre diese Angabe nicht mehr eindeutig.
  
 
==Attribute==
 
==Attribute==
−
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 17: Zeile 17:
 
| original
 
| original
 
| [[ID]]
 
| [[ID]]
−
| ist identisch mit <code>id</code>, da es für Artikel keine [[Symbolischer Link|symbolischen Links]] gibt.
+
| ist identisch mit <code>id</code>, da es für Artikel keine [[Symbolischer Link|Symbolischen Links]] gibt.
 
| 1
 
| 1
 
|-
 
|-
Zeile 24: Zeile 24:
 
| ID-Teil ohne Typ-Definition
 
| ID-Teil ohne Typ-Definition
 
| 1
 
| 1
 +
|-
 +
| withoutSignature
 +
| [[Number]]
 +
| ID-Teil ohne Signatur- und Typ-Definition
 +
| 2.1.0.13
 
|-
 
|-
 
| type
 
| type
Zeile 47: Zeile 52:
 
| name
 
| name
 
| [[String]]
 
| [[String]]
−
| Name des Artikels in der default-Sprache.
+
| Name des Artikels in der default-Sprache
 
| 1
 
| 1
 
|-
 
|-
 
| localeName
 
| localeName
 
| [[String]]
 
| [[String]]
−
| Sprachenspezifischer Name. Welche Sprache verwendet wird, wird über das <code>locale</code>-Attribute der Ausgabe-Tags bestimmt.
+
| Sprachenspezifischer Name. Welche Sprache verwendet wird, wird über das <code>locale</code>-Attribute der Ausgabe-Tags bestimmt
−
| 2
+
| 1
 
|-
 
|-
 
| comment
 
| comment
Zeile 62: Zeile 67:
 
| localeComment
 
| localeComment
 
| [[Text]]
 
| [[Text]]
−
| Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, wird über das <code>locale</code>-Attribute der Ausgabe-Tags bestimmt.
+
| Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, wird über das <code>locale</code>-Attribute der Ausgabe-Tags bestimmt
−
| 2
+
| 1
 
|-
 
|-
 
| parent
 
| parent
Zeile 72: Zeile 77:
 
| filename
 
| filename
 
| [[String]]
 
| [[String]]
−
| Dateiname des Artikels, nachdem das System diesen angepasst hat um gültige und URL-sichere Dateinamen zu erzeugen.
+
| Dateiname des Artikels, nachdem das System diesen angepasst hat, um gültige und URL-sichere Dateinamen zu erzeugen
 
| 1
 
| 1
 
|-
 
|-
Zeile 81: Zeile 86:
 
|-
 
|-
 
| stepParents
 
| stepParents
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[ArticlePool]]>
 
| Liefert eine leere Liste, da es für Artikel keine [[Symbolischer Link|symbolischen Links]] gibt
 
| Liefert eine leere Liste, da es für Artikel keine [[Symbolischer Link|symbolischen Links]] gibt
 
| 1
 
| 1
 
|-
 
|-
 
| path
 
| path
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[ArticlePool]]/[[Article]]>
−
| Liste aller übergeordenten [[ArticlePool|Articlepools] und dieser Artikel. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist <code>parent</code>. Das letzte Element der Liste ist dieser Artikel
+
| Liste aller übergeordneten [[ArticlePool|Articlepools] und dieses Artikels. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist <code>parent</code>. Das letzte Element der Liste ist dieser Artikel
 
| 1
 
| 1
 
|-
 
|-
Zeile 119: Zeile 124:
 
| Wenn dieses Attribut gesetzt ist, ist das Objekt von einem anderen Nutzer gelockt
 
| Wenn dieses Attribut gesetzt ist, ist das Objekt von einem anderen Nutzer gelockt
 
| 2
 
| 2
 +
|-
 +
| password
 +
| [[String]]
 +
| Das verschlüsselte Passwort des Artikels (optional)
 +
| 1
 
|-
 
|-
 
| isReadOnly
 
| isReadOnly
 
| [[Boolean]]
 
| [[Boolean]]
−
| true, wenn der Nutzer, der dieses Objekt angefordert hat nur lesend darauf zugreifen darf. Dies ist der Fall, wenn der Nutzer nur Leserechte auf diese Objekt hat oder das Objekt von einem anderen Nutzer gelockt wurde
+
| true, wenn der Nutzer, der dieses Objekt angefordert hat, nur lesend darauf zugreifen darf. Dies ist nicht nur der Fall, wenn der Nutzer nur Leserechte auf diese Objekt hat, sondern auch falls das Objekt von einem anderen Nutzer gelockt wurde
 
| 1
 
| 1
 
|-
 
|-
Zeile 141: Zeile 151:
 
|-
 
|-
 
| history
 
| history
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[HistoryEntry]]>
−
| Liste von [[HistoryEntry]]-Objekten, die alle Aktionen auf dieses Objekte beschreiben
+
| Liste von [[HistoryEntry]]-Objekten, die alle Aktionen auf dieses Objekt beschreiben
 
| 1
 
| 1
 
|-
 
|-
Zeile 151: Zeile 161:
 
|-
 
|-
 
| all
 
| all
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Information]]>
−
| Liefert eine Liste alle [[Information|Informations]]-Objekte
+
| Liefert eine Liste aller [[Information|Informations]]-Objekte
 
| 1
 
| 1
 
|-
 
|-
 
| flat
 
| flat
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Information]]>
 
| Liefert eine Liste aller [[Information|Informations]]-Objekte ohne Struktierungs-Objekt wie [[ListInformation|ListInformations]], [[ListItemInformation|ListItemInformations]] oder [[SubInformation|SubInformations]]
 
| Liefert eine Liste aller [[Information|Informations]]-Objekte ohne Struktierungs-Objekt wie [[ListInformation|ListInformations]], [[ListItemInformation|ListItemInformations]] oder [[SubInformation|SubInformations]]
 
| 1
 
| 1
Zeile 172: Zeile 182:
 
| url
 
| url
 
| [[URL]]
 
| [[URL]]
−
| Liefert im [[Template-Modus|Out-Modus]] die [[URL]] des Artikels, wenn der Artikel für den aktuellen [[Publisher]] freigegeben ist. Mit diesem Attribute wird die [[URL]] '''ohne''' <code>http://www.domain.de</code> ausgegeben. Sie beginnt mit <code>/</code> ab dem Dokument-Root
+
| Liefert im [[Template-Modus|Out-Modus]] die [[URL]] des Artikels, wenn der Artikel für den aktuellen [[Publisher]] freigegeben ist. Mit diesem Attribute wird die [[URL]] '''ohne''' <code><nowiki>http://www.domain.de</nowiki></code> ausgegeben. Sie beginnt mit <code>/</code> ab dem Dokument-Root
 
| 1
 
| 1
 
|-
 
|-
 
| absoluteUrl
 
| absoluteUrl
 
| [[URL]]
 
| [[URL]]
−
| Liefert im [[Template-Modus|Out-Modus]] die [[URL]] des Artikels, wenn der Artikel für den aktuellen [[Publisher]] freigegeben ist. Mit diesem Attribute wird die [[URL]] '''mit''' <code>http://www.domain.de</code> ausgegeben.
+
| Liefert im [[Template-Modus|Out-Modus]] die [[URL]] des Artikels, wenn der Artikel für den aktuellen [[Publisher]] freigegeben ist. Mit diesem Attribute wird die [[URL]] '''mit''' <code><nowiki>http://www.domain.de</nowiki></code> ausgegeben
 
| 1
 
| 1
 
|-
 
|-
 
| relativeUrl
 
| relativeUrl
 
| [[URL]]
 
| [[URL]]
−
| Liefert im [[Template-Modus|Out-Modus]] die [[URL]] des Artikels, wenn der Artikel für den aktuellen [[Publisher]] freigegeben ist. Mit diesem Attribut wird die [[URL]] relativ zu dem aktuellen Aritkel ausgegeben.
+
| Liefert im [[Template-Modus|Out-Modus]] die [[URL]] des Artikels, wenn der Artikel für den aktuellen [[Publisher]] freigegeben ist. Mit diesem Attribut wird die [[URL]] relativ zu dem aktuellen Artikel ausgegeben
 
| 1
 
| 1
 
|-
 
|-
 
| publicationStates
 
| publicationStates
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[PublicationState]]>
−
| Liste von [[PublicationState]]-Objekten, die die Stati für jeden [[Publisher]], in denen dieser Artikel publiziert ist, enhalten.
+
| Liste von [[PublicationState]]-Objekten, die die Stati für jeden [[Publisher]], in denen dieser Artikel publiziert ist, enthalten
 
| 1
 
| 1
 
|-
 
|-
−
| ???
+
| publishedIn
−
| ???
+
| [[Collection]]&nbsp;<[[Publisher]]>
−
| Ein Artikel kann beliebig viele weitere Attribute enthalten. Dies können normale Textfelder, aber auch Listen-, BinärInformation usw. sein. Alleine das [[Template]] zur Erzeugung und Änderung von Artikeln bestimmt diese Attribute.
+
| Liste von [[Publisher]]-Objekten, in denen der Artikel publiziert ist
−
| 1
+
| 2.1.0
 +
|-
 +
| referrerLinks
 +
| [[Collection]]&nbsp;<[[IDLink]]>
 +
| Liste von [[IDLink]]-Objekten der Links, die auf diese Artikel verweisen.
 +
| 2.1.0
 +
|-
 +
| referenceLinks
 +
| [[Collection]]&nbsp;<[[IDLink]]>
 +
| Liste von [[IDLink]]-Objekten der Links, auf die der Artikel verweist
 +
| 2.1.0.13
 +
|-
 +
| external
 +
| [[String]]
 +
| Dieses Feld kann eine externe [[URL]] enhalten, die der Artikel repräsentiert. Dieses Feld wird auch für <code>hasValidUrl</code> ausgewertet
 +
| 2.18
 +
|-
 +
! colspan="4" |<div class="note">
 +
Ein Artikel kann beliebig viele weitere Attribute enthalten.  
 +
Dies können normale Textfelder, aber auch Listen-, BinärInformation usw. sein.  
 +
Alleine das [[Template]] zur Erzeugung und Änderung von Artikeln bestimmt diese Attribute
 +
</div>
 
|}
 
|}
  
Zeile 201: Zeile 232:
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
|-
 
|-
−
| <code>isPublished([[Publisher]])</code>
+
| <code>isPublished([[Publisher]] publisher)</code>
 
| [[Boolean]]
 
| [[Boolean]]
−
| Liefert <code>true</code>, wenn der Artikel für den angegebenen [[Publisher]] publiziert ist.
+
| Liefert <code>true</code>, wenn der Artikel für den angegebenen Publisher publiziert ist
 
| 1
 
| 1
 
|-
 
|-
−
| <code>hasValidUrl([[Publisher]])</code>
+
| <code>hasValidUrl([[Publisher]] publisher)</code>
 
| [[Boolean]]
 
| [[Boolean]]
−
| Liefert <code>true</code>, wenn der Artikel für den angegebenen [[Publisher]] publiziert ist und eine [[URL]] zurückliefert.
+
| Liefert <code>true</code>, wenn der Artikel für den angegebenen Publisher publiziert ist und eine URL zurückliefert
 
| 1
 
| 1
 
|-
 
|-
−
| <code>url([[Publisher]])</code>
+
| <code>url([[Publisher]] publisher)</code>
 
| [[URL]]
 
| [[URL]]
−
| Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben.
+
| Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben
 
| 1
 
| 1
 
|-
 
|-
−
| <code>absoluteUrl([[Publisher]])</code>
+
| <code>absoluteUrl([[Publisher]] publisher)</code>
 
| [[URL]]
 
| [[URL]]
−
| Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] mit vorangestelltem <code>http://www.domain.de</code> ausgegeben.
+
| Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit vorangestelltem <code><nowiki>http://www.domain.de</nowiki></code> ausgegeben
 
| 1
 
| 1
 
|-
 
|-
−
| <code>relativeUrl([[Publisher]])</code>
+
| <code>relativeUrl([[Publisher]] publisher)</code>
 
| [[URL]]
 
| [[URL]]
−
| Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] relativ zu dem aktuellen Artikel ausgegeben.
+
| Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zu dem aktuellen Artikel ausgegeben
 
| 1
 
| 1
 
|-
 
|-
−
| <code>publicationState([[Publisher]])</code>
+
| <code>publicationState([[Publisher]] publisher)</code>
 
| [[PublicationState]]
 
| [[PublicationState]]
−
| Liefert für den angegebenen Publisher das Publikationsstatus.
+
| Liefert für den angegebenen Publisher den Publikationsstatus
 
| 1
 
| 1
 +
|-
 +
| <code>referrerLinks([[String]] name)</code>
 +
| [[Collection]]<[[IDLink]]>
 +
| Liste von [[IDLink]]-Objekten der Links, die auf diesen Artikel verweisen.
 +
| 2.1.0
 +
|-
 +
| <code>referenceLinks([[String]] name)</code>
 +
| [[Collection]]<[[IDLink]]>
 +
| Liste von [[IDLink]]-Objekten der Links auf die dieser Artikel verweist.
 +
| 2.1.0.13
 
|}
 
|}
  
−
;<code>isPublished([[Publisher]])</code>
+
;<code>[[Boolean]] isPublished([[Publisher]] publisher)</code>
−
:Liefert <code>true</code>, wenn der Artikel für den angegebenen [[Publisher]] publiziert ist.
+
:Liefert <code>true</code>, wenn der Artikel für den angegebenen Publisher publiziert ist.
 +
:;Parameter
 +
::;<code>Publisher</code>
 +
:::Publisher, für den geprüft werden soll, ob der Artikel für diesen publiziert ist.
 +
:;Rückgabewert
 +
::;Boolean
 +
:::<code>true</code>, wenn der Artikel in dem angegebenen Publisher publiziert ist.
 +
 
 +
;<code>[[Boolean]] hasValidUrl([[Publisher]] publisher)</code>
 +
:Liefert <code>true</code>, wenn der Artikel für den angegebenen Publisher publiziert ist und eine URL zurückliefert.
 +
:;Parameter
 +
::;<code>Publisher</code>
 +
:::Publisher, für den die URL geprüft werden soll.
 +
:;Rückgabewert
 +
::;Boolean
 +
:::<code>true</code>, wenn der Artikel für den angegebenen Publisher publiziert ist.
 +
 
 +
;<code>[[URL]] url([[Publisher]] publisher)</code>
 +
:Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben.
 
:;Parameter
 
:;Parameter
−
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
−
:::[[Publisher]], für den geprüft werden soll, ob der Artikel für diesen publiziert ist.
+
:::Publisher, für den die URL zurückgegeben werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[Boolean]]
+
::;URL
−
:::<code>true</code>, wenn der Artikel in dem angegebenen [[Publisher]] publiziert ist.
+
:::URL des Artikels für den angegebenen Publisher ausgehend vom Dokument-Root (<code>/</code>).
  
−
;<code>hasValidUrl([[Publisher]])</code>
+
;<code>[[URL]] absoluteUrl([[Publisher]] publisher)</code>
−
:Liefert <code>true</code>, wenn der Artikel für den angegebenen [[Publisher]] publiziert ist und eine [[URL]] zurückliefert.
+
:Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit <code><nowiki>http://www.domain.de</nowiki></code> ausgegeben.
 
:;Parameter
 
:;Parameter
−
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
−
:::[[Publisher]], für den die [[URL]] geprüft werden soll.
+
:::Publisher, für den die URL zurückgegeben werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[Boolean]]
+
::;URL
−
:::<code>true</code>, wenn der Artikel für den angegebenen [[Publisher]] publiziert ist.
+
:::URL des Artikels für den angegebenen Publisher mit <code><nowiki>http://www.domain.de</nowiki></code>.
  
−
;<code>url([[Publisher]])</code>
+
;<code>[[URL]] relativeUrl([[Publisher]] publisher)</code>
−
:Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben.
+
:Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zu dem aktuellen Aritkel ausgegeben.
 
:;Parameter
 
:;Parameter
−
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
−
:::[[Publisher]], für den die [[URL]] zurückgegeben werden soll.
+
:::Publisher, für den die URL zurückgegeben werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[URL]]
+
::;URL
−
:::[[URL]] des Artikels für den angegebenen [[Publisher]] ausgehend vom Dokument-Root (<code>/</code>).
+
:::URL des Artikels für den angegebenen Publisher relativ zu dem aktuellen Aritkel.
  
−
;<code>absoluteUrl([[Publisher]])</code>
+
;<code>[[PublicationState]] publicationState([[Publisher]] publisher)</code>
−
:Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] mit <code>http://www.domain.de</code> ausgegeben.
+
:Liefert den Publikations-Status des Artikels für den angegebenen Publisher.
 
:;Parameter
 
:;Parameter
−
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
−
:::[[Publisher]], für den die [[URL]] zurückgegeben werden soll.
+
:::Publisher für den der Publikations-Status ausgegeben werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[URL]]
+
::;PublicationState
−
:::[[URL]] des Artikels für den angegebenen [[Publisher]] mit  http://www.domain.de.
+
:::Publikations-Status des Artikels für den angegebenen Publisher.
  
−
;<code>relativeUrl(P[[Publisher]])</code>
+
;<code>[[Collection]]<[[IDLink]]> referrerLinks([[String]] name)</code>
−
:Liefert die [[URL]] des Artikels, wenn der Artikel für den angegebenen [[Publisher]] freigegeben ist. Mit dieser Methode wird die [[URL]] relativ zu dem aktuellen Aritkel ausgegeben.
+
:Liste von [[IDLink]]-Objekten, die die Links auf diesen Artikel beschreiben.
 
:;Parameter
 
:;Parameter
−
::;<code>[[Publisher]]</code>
+
::;<code>name</code>
−
:::[[Publisher]], für den die [[URL]] zurückgegeben werden soll.
+
:::Name des Feldes über den der Link angelegt wurde. Hier wird wie bei Suchabfragen der 'Suchname' angegeben. Z.B. <code>mylink.link</code>
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[URL]]
+
::;Collection<IDLink>
−
:::[[URL]] des Artikels für den angegebenen [[Publisher]] relativ zu dem aktuellen Aritkel.
+
:::Liste der Links, die auf den Artikel verweisen
  
−
;<code>publicationState([[Publisher]])</code>
+
;<code>[[Collection]]<[[IDLink]]> referenceLinks([[String]] name)</code>
−
:Liefert den [[PublicationState|Publikations-Status]] des Artikels für den angegebenen [[Publisher]].
+
:Liste von [[IDLink]]-Objekten, die die Links auf andere Artikel beschreiben.
 
:;Parameter
 
:;Parameter
−
::;<code>[[Publisher]]</code>
+
::;<code>name</code>
−
:::[[Publisher]] für den der [[PublicationState|Publikations-Status]] ausgegeben werden soll.
+
:::Name des Feldes über den der Link angelegt wurde. Hier wird wie bei Suchabfragen der 'Suchname' angegeben. Z.B. <code>mylink.link</code>
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[PublicationState]]
+
::;Collection<IDLink>
−
:::[[PublicationState|Publikations-Status]] des Artikels für den angegebenen [[Publisher]].
+
:::Liste der Links, die auf andere Artikel verweisen
 +
 
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
−
[[Category:Qualität_des_Inhalts_prüfen]]
 
−
[[Category:Qualität_der_Sprache_prüfen]]
 
−
[[Category:Qualität_des_Codes_prüfen]]
 
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 22. August 2016, 13:20 Uhr

Name

Article - Objekt, dessen Daten mit einem Publisher publiziert werden können.

Beschreibung

Artikel sind Objekte, dessen Daten mit einem Publisher publiziert werden können. Sie benötigen ein Ausgabe-Template das bestimmt, in welcher Form die Daten publiziert werden sollen. Im Gegensatz zu Resourcen können für Artikel keine Symbolischen Links erzeugt werden (ein Symbolischer Link würde hier bedeuten, dass ein Artikel in mehreren ArticlePools liegt). Die ArticlePools definieren in welchem Verzeichnis der Artikel als Seite generiert wird. Läge der Artikel in mehreren ArticlePools wäre diese Angabe nicht mehr eindeutig.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Artikels 1
original ID ist identisch mit id, da es für Artikel keine Symbolischen Links gibt. 1
withoutType Number ID-Teil ohne Typ-Definition 1
withoutSignature Number ID-Teil ohne Signatur- und Typ-Definition 2.1.0.13
type system.constants.ARTICLE Typ des Artikels 1
category system.constants.INFORMATION Typ des Objektes 1
version Date Die Version des Artikels entspricht dem Zeitstempel, zu dem dieser Stand erzeugt wurde 1
anchor Anchor Anchor des Artikels 1
name String Name des Artikels in der default-Sprache 1
localeName String Sprachenspezifischer Name. Welche Sprache verwendet wird, wird über das locale-Attribute der Ausgabe-Tags bestimmt 1
comment String Kommentar zu dem Artikel in der default-Sprache 1
localeComment Text Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, wird über das locale-Attribute der Ausgabe-Tags bestimmt 1
parent ArticlePool Artikelpool in dem der Artikel liegt 1
filename String Dateiname des Artikels, nachdem das System diesen angepasst hat, um gültige und URL-sichere Dateinamen zu erzeugen 1
originalFilename String Dateiname, der nicht vom System angepasst wurde 1
stepParents Collection <ArticlePool> Liefert eine leere Liste, da es für Artikel keine symbolischen Links gibt 1
path Collection <ArticlePool/Article> Liste aller übergeordneten [[ArticlePool|Articlepools] und dieses Artikels. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist parent. Das letzte Element der Liste ist dieser Artikel 1
createdBy User Nutzer, der diesen Artikel erzeugt hat 1
created Date Datum und Uhrzeit, zu dem dieser Artikel erzeugt wurde 1
changedBy User Nutzer, der diesen Artikel zuletzt geändert hat 1
changed Date Datum und Uhrzeit, zu dem dieser Artikel das letzte mal geändert wurde 1
permissions Permission Gibt an, welche Rechte der Nutzer, der dieses Objekt angefordert hat, auf dieses Objekt besitzt 1
lock Lock Wenn dieses Attribut gesetzt ist, ist das Objekt von einem anderen Nutzer gelockt 2
password String Das verschlüsselte Passwort des Artikels (optional) 1
isReadOnly Boolean true, wenn der Nutzer, der dieses Objekt angefordert hat, nur lesend darauf zugreifen darf. Dies ist nicht nur der Fall, wenn der Nutzer nur Leserechte auf diese Objekt hat, sondern auch falls das Objekt von einem anderen Nutzer gelockt wurde 1
isElement Boolean ist immer true 1
isPool Boolean ist immer false 1
isSymbolicLink Boolean immer false, da es für Artikel keine symbolischen Links gibt 1
history Collection <HistoryEntry> Liste von HistoryEntry-Objekten, die alle Aktionen auf dieses Objekt beschreiben 1
isEmpty Boolean true, wenn der Artikel keine Informations-Objekte enthält 1
all Collection <Information> Liefert eine Liste aller Informations-Objekte 1
flat Collection <Information> Liefert eine Liste aller Informations-Objekte ohne Struktierungs-Objekt wie ListInformations, ListItemInformations oder SubInformations 1
isPublished Boolean Dieses Attribute ist im Out-Modus gültig. Es zeigt an, ob dieser Artikel für den aktuellen Publisher freigegeben ist 1
hasValidUrl (deprecated) Boolean Liefert true im Out-Modus, wenn der Artikel für den aktuellen Publisher freigegeben ist 1
url URL Liefert im Out-Modus die URL des Artikels, wenn der Artikel für den aktuellen Publisher freigegeben ist. Mit diesem Attribute wird die URL ohne http://www.domain.de ausgegeben. Sie beginnt mit / ab dem Dokument-Root 1
absoluteUrl URL Liefert im Out-Modus die URL des Artikels, wenn der Artikel für den aktuellen Publisher freigegeben ist. Mit diesem Attribute wird die URL mit http://www.domain.de ausgegeben 1
relativeUrl URL Liefert im Out-Modus die URL des Artikels, wenn der Artikel für den aktuellen Publisher freigegeben ist. Mit diesem Attribut wird die URL relativ zu dem aktuellen Artikel ausgegeben 1
publicationStates Collection <PublicationState> Liste von PublicationState-Objekten, die die Stati für jeden Publisher, in denen dieser Artikel publiziert ist, enthalten 1
publishedIn Collection <Publisher> Liste von Publisher-Objekten, in denen der Artikel publiziert ist 2.1.0
referrerLinks Collection <IDLink> Liste von IDLink-Objekten der Links, die auf diese Artikel verweisen. 2.1.0
referenceLinks Collection <IDLink> Liste von IDLink-Objekten der Links, auf die der Artikel verweist 2.1.0.13
external String Dieses Feld kann eine externe URL enhalten, die der Artikel repräsentiert. Dieses Feld wird auch für hasValidUrl ausgewertet 2.18 
Ein Artikel kann beliebig viele weitere Attribute enthalten. 
Dies können normale Textfelder, aber auch Listen-, BinärInformation usw. sein. 
Alleine das Template zur Erzeugung und Änderung von Artikeln bestimmt diese Attribute

Methoden

Methode Rückgabewert Beschreibung ab IES Version
isPublished(Publisher publisher) Boolean Liefert true, wenn der Artikel für den angegebenen Publisher publiziert ist 1
hasValidUrl(Publisher publisher) Boolean Liefert true, wenn der Artikel für den angegebenen Publisher publiziert ist und eine URL zurückliefert 1
url(Publisher publisher) URL Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (/) ausgegeben 1
absoluteUrl(Publisher publisher) URL Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit vorangestelltem http://www.domain.de ausgegeben 1
relativeUrl(Publisher publisher) URL Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zu dem aktuellen Artikel ausgegeben 1
publicationState(Publisher publisher) PublicationState Liefert für den angegebenen Publisher den Publikationsstatus 1
referrerLinks(String name) Collection<IDLink> Liste von IDLink-Objekten der Links, die auf diesen Artikel verweisen. 2.1.0
referenceLinks(String name) Collection<IDLink> Liste von IDLink-Objekten der Links auf die dieser Artikel verweist. 2.1.0.13
Boolean isPublished(Publisher publisher)
Liefert true, wenn der Artikel für den angegebenen Publisher publiziert ist.
Parameter
Publisher
Publisher, für den geprüft werden soll, ob der Artikel für diesen publiziert ist.
Rückgabewert
Boolean
true, wenn der Artikel in dem angegebenen Publisher publiziert ist.
Boolean hasValidUrl(Publisher publisher)
Liefert true, wenn der Artikel für den angegebenen Publisher publiziert ist und eine URL zurückliefert.
Parameter
Publisher
Publisher, für den die URL geprüft werden soll.
Rückgabewert
Boolean
true, wenn der Artikel für den angegebenen Publisher publiziert ist.
URL url(Publisher publisher)
Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (/) ausgegeben.
Parameter
Publisher
Publisher, für den die URL zurückgegeben werden soll.
Rückgabewert
URL
URL des Artikels für den angegebenen Publisher ausgehend vom Dokument-Root (/).
URL absoluteUrl(Publisher publisher)
Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit http://www.domain.de ausgegeben.
Parameter
Publisher
Publisher, für den die URL zurückgegeben werden soll.
Rückgabewert
URL
URL des Artikels für den angegebenen Publisher mit http://www.domain.de.
URL relativeUrl(Publisher publisher)
Liefert die URL des Artikels, wenn der Artikel für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zu dem aktuellen Aritkel ausgegeben.
Parameter
Publisher
Publisher, für den die URL zurückgegeben werden soll.
Rückgabewert
URL
URL des Artikels für den angegebenen Publisher relativ zu dem aktuellen Aritkel.
PublicationState publicationState(Publisher publisher)
Liefert den Publikations-Status des Artikels für den angegebenen Publisher.
Parameter
Publisher
Publisher für den der Publikations-Status ausgegeben werden soll.
Rückgabewert
PublicationState
Publikations-Status des Artikels für den angegebenen Publisher.
Collection<IDLink> referrerLinks(String name)
Liste von IDLink-Objekten, die die Links auf diesen Artikel beschreiben.
Parameter
name
Name des Feldes über den der Link angelegt wurde. Hier wird wie bei Suchabfragen der 'Suchname' angegeben. Z.B. mylink.link
Rückgabewert
Collection<IDLink>
Liste der Links, die auf den Artikel verweisen
Collection<IDLink> referenceLinks(String name)
Liste von IDLink-Objekten, die die Links auf andere Artikel beschreiben.
Parameter
name
Name des Feldes über den der Link angelegt wurde. Hier wird wie bei Suchabfragen der 'Suchname' angegeben. Z.B. mylink.link
Rückgabewert
Collection<IDLink>
Liste der Links, die auf andere Artikel verweisen
Abgerufen von „https://wiki.sitepark.com/index.php?title=Article_(Objekt)&oldid=8145“