XIP Article: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
(10 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | == | + | =<code><article></code>, <code><resource></code>, <code><media></code>= |
− | Für die drei Artikeltypen steht jeweils ein | + | ===Beschreibung=== |
+ | Für die drei Artikeltypen des IES (Artikel, Medien-Artikel und Resource-Artikel) steht jeweils ein eigenes XML-Element zur Verfügung, über den die Daten definiert werden. | ||
− | + | * <article> - Definiert einen Artikel | |
+ | * <resource> - Definiert einen Resource-Artikel | ||
+ | * <media> - Definiert einen Medien-Artikel | ||
− | + | ===Erlaubte übergerodnete XML-Elemente=== | |
− | + | <code><xip></code>, <code><articlepool></code> | |
− | + | ===Attribute=== | |
− | + | {| class="prettytable sortable" | |
+ | |- class="hintergrundfarbe1" | ||
+ | ! Name || XML-Element || Beschreibung | ||
+ | |- | ||
+ | | <code>parent</code> | ||
+ | | <code><article></code>, <code><resource></code>, <code><media></code> | ||
+ | | Anchor des Artikel-Pools für diesen Artikel. Die Angabe eines Parents ist nicht nötig, wenn die XML-Datei in einem Verzeichnis liegt, das als Pool definiert wurde (siehe [[XIP Format#XIP-INF_Verzeichnis|XIP-INF]]). Elemente können auch ohne Angabe eines Parents importiert werden, wenn mit dem Parameter <code>ies.xip.import.root</code> ein Parent definiert wurde. | ||
+ | |- | ||
+ | | <code>anchor</code> | ||
+ | | <code><article></code>, <code><resource></code>, <code><media></code> | ||
+ | | Der Anchor des Elementes | ||
+ | |- | ||
+ | | <code>name</code> | ||
+ | | <code><article></code>, <code><resource></code>, <code><media></code> | ||
+ | | Name des Artikels | ||
+ | |- | ||
+ | | <code>filename</code> | ||
+ | | <code><article></code> | ||
+ | | Dateiname des Artikels (ohne Suffix, wenn ein Template mit Suffix verwendet wird) | ||
+ | |- | ||
+ | | <code>original-filename</code> | ||
+ | | <code><article></code> | ||
+ | | Originaler Dateiname des Artikels (ohne Suffix, wenn ein Template mit Suffix verwendet wird). <code>original-filename</code> ist zu <code>filename</code> unterschiedlich, wenn in dem vergebenen Dateinamen Sonderzeichen enthalten sind. | ||
+ | |- | ||
+ | | <code>template</code> | ||
+ | | <code><article></code>, <code><resource></code> | ||
+ | | Anchor des Template für den Artikel | ||
+ | |} | ||
− | + | ===Unterelemente=== | |
− | + | ====<code><comment></code>==== | |
− | + | =====Beschreibung===== | |
− | + | Kommentare zu dem Artikel | |
− | + | =====Attribute===== | |
− | + | keine | |
− | + | ====<code><publication-state></code>==== | |
− | + | =====Beschreibung===== | |
− | + | Publikations-Definitionen zu einem Artikel. Für jeden Publikationsbereich wird ein <code><publication-state></code>-XML-Element verwendet. | |
− | + | =====Attribute===== | |
− | + | {| class="prettytable sortable" | |
− | + | |- class="hintergrundfarbe1" | |
− | + | ! Name || Beschreibung | |
− | + | |- | |
− | + | | <code>anchor</code> | |
− | + | | Anchor des Publikationsbereiches, für den der Status definiert ist | |
− | + | |- | |
− | + | | <code>status</code> | |
− | + | | Status der Publikation. <code>1</code> bedeutet der Artikel ist publiziert bzw. soll publiziert werden, <code></code> bedeutet der Artikel ist nicht publiziert bzw. soll depubliziert werden. | |
− | + | |} | |
− | + | ====Weitere Elemente==== | |
− | + | Alle weiteren möglichen Unterelemente sind unter [[XIP Content]] beschrieben. | |
− | + | =====Sonderfälle===== | |
− | + | * Um die Binäredaten eines Medien-Artikels zu definieren, wird das <code>name</code>-Attribut des <code><binary></code>-XML-Elementes nicht mit angegeben. In allen anderen Fällen ist die Angabe eines <code>name</code>-Attributes verpflichtend. | |
− | + | * Ein Resource-Artikel kann als 'Externe URL' definiert werden. (Im Template kann dann mit <code>.url</code> auf die definierte URL zugegriffen werden. Dazu muss mit dem <code><url></code>-XML-Element und dem Feldnamen <code>external</code> die URL definiert werden | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<source lang="xml"> | <source lang="xml"> | ||
− | < | + | <url name="external">http://www.sitepark.com</url> |
− | |||
− | |||
− | |||
</source> | </source> | ||
− | + | ===Beispiel für einen Artikel=== | |
− | === | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<source lang="xml"> | <source lang="xml"> | ||
− | < | + | <article anchor="article.example.xip.1" name="Example 1" parent="pool.tutorial.xip" template="tpl.content" filename="article.example"> |
− | |||
− | + | <!-- Kommantarfeld des Artikels --> | |
− | < | + | <comment>Beispiel für einen Kommentar</comment> |
− | < | ||
− | + | <publication-state anchor="www" status="1" /> | |
− | + | <publication-state anchor="preview" status="1" /> | |
− | |||
− | |||
− | |||
− | - | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | <!-- Einfache Inhaltsfelder --> | |
− | + | <text name="sp_headline">The World According To America</text> | |
− | + | <text name="sp_intro"> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Kleine Zeichnung zum amerikanischen Verständnis der Welt. | Kleine Zeichnung zum amerikanischen Verständnis der Welt. | ||
− | + | </text> | |
− | + | <!-- Beispiel für einer Checkbox true/false --> | |
− | + | <text name="sp_textHTML">true</text> | |
− | + | <!-- Beispiel für eine Selectbox --> | |
− | + | <text name="sp_select">left</text> | |
− | + | <!-- ein Iterator (hier für Texte und Links) --> | |
− | + | <list name="sp_main_iterate"> | |
− | + | <item> | |
− | + | <!-- Einfache Inhaltsfelder --> | |
− | + | <text name="sp_subheadline">The World:</text> | |
− | + | <text name="sp_part"> | |
− | + | Hier kommt die Grafik und ein Link auf die Rubrikseite | |
− | + | </text> | |
− | + | <!-- Systemlink auf einen anderen Artikel --> | |
− | + | <systemlink name="sp_mon_link" anchor="article.rubric"/> | |
− | + | <!-- Navlink auf einen anderen Artikel --> | |
− | + | <systemlink name="sp_nav_link" anchor="article.content.2"/> | |
− | + | <!-- Link auf einen anderen Artikel --> | |
− | + | <link name="sp_link" anchor="article.rubric"/> | |
− | + | <text name="sp_link">link auf article.rubric</text> | |
− | + | <!-- Link auf ein Medium --> | |
− | + | <systemlink name="sp_image" anchor="image.america"/> | |
− | + | <!-- Externe URL und Linktext --> | |
− | + | <text name="sp_external">www.google.de</text> | |
− | + | <url name="sp_external">http://www.google.de</url> | |
− | + | </item> | |
− | + | </list> | |
− | + | <!-- | |
ein Upload-Feld (das Medium wird beim Import von der angegebenen URL | ein Upload-Feld (das Medium wird beim Import von der angegebenen URL | ||
(extern oder relativ) geladen) | (extern oder relativ) geladen) | ||
− | + | --> | |
− | + | <binary name="sp_externalmedia" url="http://www.sitepark.com/btn_ies.gif"/> | |
+ | |||
</article> | </article> | ||
</source> | </source> | ||
− | ===Medien=== | + | ===Beispiel für einen Medien-Artikel=== |
− | |||
− | |||
− | |||
<source lang="xml"> | <source lang="xml"> | ||
− | + | <media anchor="article.example.xip.2" name="Example 2" parent="pool.tutorial.xip"> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <media | ||
− | |||
− | |||
− | |||
<!-- Kommantarfeld des Artikels --> | <!-- Kommantarfeld des Artikels --> | ||
Zeile 280: | Zeile 134: | ||
<!-- Publikationsstatus des Artikels --> | <!-- Publikationsstatus des Artikels --> | ||
− | <publication-state | + | <publication-state anchor="www" status="1" /> |
− | <publication-state | + | <publication-state anchor="preview" status="1" /> |
+ | |||
+ | <!-- Die Binäredaten des Mediums (kein name-Attribut) --> | ||
+ | <binary url="file://./logo.gif"/> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
</media> | </media> | ||
</source> | </source> | ||
− | === | + | ===Beispiel für einen Resource-Artikel=== |
− | |||
− | |||
− | |||
<source lang="xml"> | <source lang="xml"> | ||
− | + | <resource anchor="article.example.xip.3" name="Example 3" parent="pool.tutorial.xip" template="tpl.external"> | |
− | |||
− | |||
− | |||
− | |||
− | <resource | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<!-- Kommantarfeld des Artikels --> | <!-- Kommantarfeld des Artikels --> | ||
Zeile 327: | Zeile 159: | ||
der richtigen URL | der richtigen URL | ||
--> | --> | ||
− | <text name="external">www. | + | <text name="external">www.sitepark.com</text> |
− | <url name="external">http://www. | + | <url name="external">http://www.sitepark.com</url> |
</resource> | </resource> |
Aktuelle Version vom 15. Juni 2009, 07:55 Uhr
<article>
, <resource>
, <media>
Beschreibung
Für die drei Artikeltypen des IES (Artikel, Medien-Artikel und Resource-Artikel) steht jeweils ein eigenes XML-Element zur Verfügung, über den die Daten definiert werden.
- <article> - Definiert einen Artikel
- <resource> - Definiert einen Resource-Artikel
- <media> - Definiert einen Medien-Artikel
Erlaubte übergerodnete XML-Elemente
<xip>
, <articlepool>
Attribute
Name | XML-Element | Beschreibung |
---|---|---|
parent
|
<article> , <resource> , <media>
|
Anchor des Artikel-Pools für diesen Artikel. Die Angabe eines Parents ist nicht nötig, wenn die XML-Datei in einem Verzeichnis liegt, das als Pool definiert wurde (siehe XIP-INF). Elemente können auch ohne Angabe eines Parents importiert werden, wenn mit dem Parameter ies.xip.import.root ein Parent definiert wurde.
|
anchor
|
<article> , <resource> , <media>
|
Der Anchor des Elementes |
name
|
<article> , <resource> , <media>
|
Name des Artikels |
filename
|
<article>
|
Dateiname des Artikels (ohne Suffix, wenn ein Template mit Suffix verwendet wird) |
original-filename
|
<article>
|
Originaler Dateiname des Artikels (ohne Suffix, wenn ein Template mit Suffix verwendet wird). original-filename ist zu filename unterschiedlich, wenn in dem vergebenen Dateinamen Sonderzeichen enthalten sind.
|
template
|
<article> , <resource>
|
Anchor des Template für den Artikel |
Unterelemente
<comment>
Beschreibung
Kommentare zu dem Artikel
Attribute
keine
<publication-state>
Beschreibung
Publikations-Definitionen zu einem Artikel. Für jeden Publikationsbereich wird ein <publication-state>
-XML-Element verwendet.
Attribute
Name | Beschreibung |
---|---|
anchor
|
Anchor des Publikationsbereiches, für den der Status definiert ist |
status
|
Status der Publikation. 1 bedeutet der Artikel ist publiziert bzw. soll publiziert werden, bedeutet der Artikel ist nicht publiziert bzw. soll depubliziert werden.
|
Weitere Elemente
Alle weiteren möglichen Unterelemente sind unter XIP Content beschrieben.
Sonderfälle
- Um die Binäredaten eines Medien-Artikels zu definieren, wird das
name
-Attribut des<binary>
-XML-Elementes nicht mit angegeben. In allen anderen Fällen ist die Angabe einesname
-Attributes verpflichtend. - Ein Resource-Artikel kann als 'Externe URL' definiert werden. (Im Template kann dann mit
.url
auf die definierte URL zugegriffen werden. Dazu muss mit dem<url>
-XML-Element und dem Feldnamenexternal
die URL definiert werden
<url name="external">http://www.sitepark.com</url>
Beispiel für einen Artikel
<article anchor="article.example.xip.1" name="Example 1" parent="pool.tutorial.xip" template="tpl.content" filename="article.example">
<!-- Kommantarfeld des Artikels -->
<comment>Beispiel für einen Kommentar</comment>
<publication-state anchor="www" status="1" />
<publication-state anchor="preview" status="1" />
<!-- Einfache Inhaltsfelder -->
<text name="sp_headline">The World According To America</text>
<text name="sp_intro">
Kleine Zeichnung zum amerikanischen Verständnis der Welt.
</text>
<!-- Beispiel für einer Checkbox true/false -->
<text name="sp_textHTML">true</text>
<!-- Beispiel für eine Selectbox -->
<text name="sp_select">left</text>
<!-- ein Iterator (hier für Texte und Links) -->
<list name="sp_main_iterate">
<item>
<!-- Einfache Inhaltsfelder -->
<text name="sp_subheadline">The World:</text>
<text name="sp_part">
Hier kommt die Grafik und ein Link auf die Rubrikseite
</text>
<!-- Systemlink auf einen anderen Artikel -->
<systemlink name="sp_mon_link" anchor="article.rubric"/>
<!-- Navlink auf einen anderen Artikel -->
<systemlink name="sp_nav_link" anchor="article.content.2"/>
<!-- Link auf einen anderen Artikel -->
<link name="sp_link" anchor="article.rubric"/>
<text name="sp_link">link auf article.rubric</text>
<!-- Link auf ein Medium -->
<systemlink name="sp_image" anchor="image.america"/>
<!-- Externe URL und Linktext -->
<text name="sp_external">www.google.de</text>
<url name="sp_external">http://www.google.de</url>
</item>
</list>
<!--
ein Upload-Feld (das Medium wird beim Import von der angegebenen URL
(extern oder relativ) geladen)
-->
<binary name="sp_externalmedia" url="http://www.sitepark.com/btn_ies.gif"/>
</article>
Beispiel für einen Medien-Artikel
<media anchor="article.example.xip.2" name="Example 2" parent="pool.tutorial.xip">
<!-- Kommantarfeld des Artikels -->
<comment>kann: Ein kleiner Kommentar</comment>
<!-- Publikationsstatus des Artikels -->
<publication-state anchor="www" status="1" />
<publication-state anchor="preview" status="1" />
<!-- Die Binäredaten des Mediums (kein name-Attribut) -->
<binary url="file://./logo.gif"/>
</media>
Beispiel für einen Resource-Artikel
<resource anchor="article.example.xip.3" name="Example 3" parent="pool.tutorial.xip" template="tpl.external">
<!-- Kommantarfeld des Artikels -->
<comment>kann: Ein kleiner Kommentar</comment>
<!-- Publikationsstatus des Artikels -->
<publication-state publisher-id="pub1" status="1" />
<publication-state publisher-id="pub2" status="1" />
<!--
Externe URL und Linktext.
name "external" sorgt bei Resource-Artikeln automatisch für die Ausgabe
der richtigen URL
-->
<text name="external">www.sitepark.com</text>
<url name="external">http://www.sitepark.com</url>
</resource>