Article (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
Zeile 1: Zeile 1:
 
==Name==
 
==Name==
−
article - Daten, die mit einem [[Publisher]] publiziert werden können.
+
article - Objekt, dessen Daten mit einem [[Publisher]] publiziert werden können.
  
 
==Beschreibung==
 
==Beschreibung==
−
Artikel sind Daten, die 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 Sysmbolischen Links erzeugt werden (Artikel liegt in mehreren ArticlePools). 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.
+
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.
  
 
==Attribute==
 
==Attribute==
Zeile 17: Zeile 17:
 
| original
 
| original
 
| [[ID]]
 
| [[ID]]
−
| ist identisch mit <code>id</code>, da es für Artikel keine symbolischen Links gibt.
+
| ist identisch mit <code>id</code>, da es für Artikel keine [[Symbolischer Link|symbolischen Links]] gibt.
 
| 1
 
| 1
 
|-
 
|-
Zeile 72: Zeile 72:
 
| filename
 
| filename
 
| [[String]]
 
| [[String]]
−
| Dateiname des Artikels, nachdem das System diesen angepasst hat
+
| Dateiname des Artikels, nachdem das System diesen angepasst hat um gültige und URL-sichere Dateinamen zu erzeugen.
 
| 1
 
| 1
 
|-
 
|-
 
| originalFilename
 
| originalFilename
 
| [[String]]
 
| [[String]]
−
| Dateiname, so wie die Datei beim Upload ursprünglich hieß
+
| Dateiname, der nicht vom System angepasst wurde
 
| 1
 
| 1
 
|-
 
|-
 
| stepParents
 
| stepParents
 
| [[Collection]]
 
| [[Collection]]
−
| Liefert eine leere Liste, da es für Artikel keine symbolischen Links gibt
+
| Liefert eine leere Liste, da es für Artikel keine [[Symbolischer Link|symbolischen Links]] gibt
 
| 1
 
| 1
 
|-
 
|-
 
| path
 
| path
 
| [[Collection]]
 
| [[Collection]]
−
| Liste aller übergeordenten 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 ü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
 
| 1
 
| 1
 
|-
 
|-
Zeile 147: Zeile 147:
 
| isEmpty
 
| isEmpty
 
| [[Boolean]]
 
| [[Boolean]]
−
| <code>true</code>, wenn der Artikel keine Informations-Objekte enthält
+
| <code>true</code>, wenn der Artikel keine [[Information|Informations]]-Objekte enthält
 
| 1
 
| 1
 
|-
 
|-
 
| all
 
| all
 
| [[Collection]]
 
| [[Collection]]
−
| Liefert eine Liste alle Informations-Objekte
+
| Liefert eine Liste alle [[Information|Informations]]-Objekte
 
| 1
 
| 1
 
|-
 
|-
Zeile 171: Zeile 171:
 
|-
 
|-
 
| url
 
| url
−
| [[String]]
+
| [[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>http://www.domain.de</code> ausgegeben. Sie beginnt mit <code>/</code> ab dem Dokument-Root
 
| 1
 
| 1
 
|-
 
|-
 
| absoluteUrl
 
| absoluteUrl
−
| [[String]]
+
| [[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>http://www.domain.de</code> ausgegeben.
 
| 1
 
| 1
 
|-
 
|-
 
| relativeUrl
 
| relativeUrl
−
| [[String]]
+
| [[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 Aritkel ausgegeben.
 
| 1
 
| 1
 
|-
 
|-
Zeile 203: Zeile 203:
 
| <code>isPublished([[Publisher]])</code>
 
| <code>isPublished([[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]])</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]])</code>
−
| [[String]]
+
| [[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]])</code>
−
| [[String]]
+
| [[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>http://www.domain.de</code> ausgegeben.
 
| 1
 
| 1
 
|-
 
|-
 
| <code>relativeUrl([[Publisher]])</code>
 
| <code>relativeUrl([[Publisher]])</code>
−
| [[String]]
+
| [[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
 
|-
 
|-
Zeile 232: Zeile 232:
 
|}
 
|}
  
−
;<code>isPublished(Publisher)</code>
+
;<code>isPublished([[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
 
:;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 geprüft werden soll, ob der Artikel für diesen publiziert ist.
 
:;Rückgabewert
 
:;Rückgabewert
 
::;[[Boolean]]
 
::;[[Boolean]]
−
:::<code>true</code>, wenn der Artikel in dem angegebenen Publisher publiziert ist.
+
:::<code>true</code>, wenn der Artikel in dem angegebenen [[Publisher]] publiziert ist.
  
−
;<code>hasValidUrl(Publisher)</code>
+
;<code>hasValidUrl([[Publisher]])</code>
−
: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.
 
:;Parameter
 
:;Parameter
−
::;<code>Publisher</code>
+
::;<code>[[Publisher]]</code>
−
:::Publisher, für den die URL geprüft werden soll.
+
:::[[Publisher]], für den die [[URL]] geprüft werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
 
::;[[Boolean]]
 
::;[[Boolean]]
−
:::<code>true</code>, wenn der Artikel für den angegebenen Publisher publiziert ist.
+
:::<code>true</code>, wenn der Artikel für den angegebenen [[Publisher]] publiziert ist.
  
−
;<code>url(Publisher)</code>
+
;<code>url([[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]] beginnend ab dem Dokument-Root (<code>/</code>) 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
−
::;[[String]]
+
::;[[URL]]
−
:::URL des Artikels für den angegebenen Publisher ausgehend vom Dokument-Root (<code>/</code>).
+
:::[[URL]] des Artikels für den angegebenen [[Publisher]] ausgehend vom Dokument-Root (<code>/</code>).
  
−
;<code>absoluteUrl(Publisher)</code>
+
;<code>absoluteUrl([[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 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.
 
:;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
−
::;[[String]]
+
::;[[URL]]
−
:::URL des Artikels für den angegebenen Publisher mit  http://www.domain.de.
+
:::[[URL]] des Artikels für den angegebenen [[Publisher]] mit  http://www.domain.de.
  
−
;<code>relativeUrl(Publisher)</code>
+
;<code>relativeUrl(P[[Publisher]])</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.
+
: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
−
::;[[String]]
+
::;[[URL]]
−
:::URL des Artikels für den angegebenen Publisher relativ zu dem aktuellen Aritkel.
+
:::[[URL]] des Artikels für den angegebenen [[Publisher]] relativ zu dem aktuellen Aritkel.
  
−
;<code>publicationState(Publisher)</code>
+
;<code>publicationState([[Publisher]])</code>
−
:Liefert den Publikations-Status des Artikels für den angegebenen Publisher.
+
:Liefert den [[PublicationState|Publikations-Status]] des Artikels für den angegebenen [[Publisher]].
 
:;Parameter
 
:;Parameter
−
::;<code>Publisher</code>
+
::;<code>[[Publisher]]</code>
−
:::Publisher für den der Publikations-Status ausgegeben werden soll.
+
:::[[Publisher]] für den der [[PublicationState|Publikations-Status]] ausgegeben werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
−
::;PublicationState
+
::;[[PublicationState]]
−
:::[[PublicationState|Publikations-Status]] des Artikels für den angegebenen Publisher.
+
:::[[PublicationState|Publikations-Status]] des Artikels für den angegebenen [[Publisher]].
  
 
<noinclude>
 
<noinclude>

Version vom 16. Juni 2008, 10:15 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 Sysmbolischen Links erzeugt werden (Artikel liegt in mehreren ArticlePools). 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
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. 2
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. 2
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 Liefert eine leere Liste, da es für Artikel keine symbolischen Links gibt 1
path Collection Liste aller übergeordenten [[ArticlePool|Articlepools] und dieser Artikel. 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
isReadOnly 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 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 Liste von HistoryEntry-Objekten, die alle Aktionen auf dieses Objekte beschreiben 1
isEmpty Boolean true, wenn der Artikel keine Informations-Objekte enthält 1
all Collection Liefert eine Liste alle Informations-Objekte 1
flat Collection 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 Aritkel ausgegeben. 1
publicationStates Collection Liste von PublicationState-Objekten, die die Stati für jeden Publisher, in denen dieser Artikel publiziert ist, enhalten. 1
??? ??? 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. 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
isPublished(Publisher) Boolean Liefert true, wenn der Artikel für den angegebenen Publisher publiziert ist. 1
hasValidUrl(Publisher) Boolean Liefert true, wenn der Artikel für den angegebenen Publisher publiziert ist und eine URL zurückliefert. 1
url(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) 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) 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) PublicationState Liefert für den angegebenen Publisher das Publikationsstatus. 1
isPublished(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.
hasValidUrl(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(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 (/).
absoluteUrl(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.
relativeUrl(PPublisher)
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(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.
Abgerufen von „https://wiki.sitepark.com/index.php?title=Article_(Objekt)&oldid=1118“