XIP Article: Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
Zeile 34: Zeile 34:
 
|-
 
|-
 
| <code>template</code>
 
| <code>template</code>
| <code><article></code>
+
| <code><article></code>, <code><resource></code>
 
| Anchor des Template für den Artikel
 
| Anchor des Template für den Artikel
 
|}
 
|}
Zeile 122: Zeile 122:
 
</source>
 
</source>
  
===Medien===
+
===Beispiel für einen Medien-Artikel===
Um ein Medium zu importieren, muss neben dem eigentlichen Medium eine XML-Datei erstellt werden, die das Root-Element "<code>media</code>" verwendet. In dieser Datei wird das Medium beschrieben und ein Anker zugewiesen. Alle Angaben neben Systemwerten werden über den oben beschriebenen Tag vorgenommen.
 
 
 
Hier ein vollständiges Beispiel eines Medienimports:
 
 
<source lang="xml">
 
<source lang="xml">
<!--
+
<media anchor="article.example.xip.2" name="Example 2" parent="pool.tutorial.xip">
Einen Artikel anlegen:
 
 
 
<article    legt einen Artikel an
 
<media      legt ein Medium an
 
<resource  legt einen Resource-Artikel an
 
 
 
anchor      Anker des Artikels (dient beim wiederholten Import als Primärschlüssel)
 
name        Name des Artikels
 
parent      Anker des Parentpools (Angabe muss über einen Anker erfolgen)
 
template    Anker des verwendeten Templates (Angabe muss über einen Anker erfolgen)
 
filename    Dateiname des Artikels (nur für den Typ <article)
 
-->
 
<media
 
  anchor="image.america"
 
  name="The World according to America (IMAGE)"
 
  parent="import.pool.media">
 
  
 
     <!-- Kommantarfeld des Artikels -->
 
     <!-- Kommantarfeld des Artikels -->
Zeile 149: Zeile 130:
  
 
     <!-- Publikationsstatus des Artikels -->
 
     <!-- Publikationsstatus des Artikels -->
     <publication-state publisher-id="pub1" status="1" />
+
     <publication-state anchor="www" status="1" />
     <publication-state publisher-id="pub2" status="1" />
+
     <publication-state anchor="preview" status="1" />
  
     <!--  
+
     <!-- Die Binäredaten des Mediums (kein <code>name</code>-Attribut) -->
      ein Upload-Feld (das Medium wird beim Import von der angegebenen URL
+
     <binary url="file://./logo.gif"/>
      (extern oder relativ) geladen)
 
    -->
 
     <binary url="file://./america.gif"/>
 
 
</media>
 
</media>
 
</source>
 
</source>
  
===Resourcen===
+
===Beispiel für einen Resource-Artikel===
Falls Resourceartikel importiert werden sollen, steht der Tag "<code>resource</code>" zur Verfügung. Die Beschreibung der Daten erfolgt analog zu den anderen Artikeltypen. Lediglich das Root-Element muss vom Typ "<code>resource</code>" sein.
 
 
 
Hier ein vollständiges Beispiel eines Medienimports:
 
 
<source lang="xml">
 
<source lang="xml">
<!--
+
<resource anchor="article.example.xip.3" name="Example 3" parent="pool.tutorial.xip" template="tpl.external">
Einen Artikel anlegen:
 
 
 
<article    legt einen Artikel an
 
<media      legt ein Medium an
 
<resource   legt einen Resource-Artikel an
 
 
 
anchor      Anker des Artikels (dient beim wiederholten Import als Primärschlüssel)
 
name        Name des Artikels
 
parent      Anker des Parentpools (Angabe muss über einen Anker erfolgen)
 
template    Anker des verwendeten Templates (Angabe muss über einen Anker erfolgen)
 
filename    Dateiname des Artikels (nur für den Typ <article>)
 
-->
 
<resource
 
  anchor="article.externe.url"
 
  name="Eine externe URL"
 
  parent="import.pool.1"
 
  template="tpl.external">
 
  
 
     <!-- Kommantarfeld des Artikels -->
 
     <!-- Kommantarfeld des Artikels -->
Zeile 196: Zeile 154:
 
       der richtigen URL
 
       der richtigen URL
 
     -->
 
     -->
     <text name="external">www.google.de</text>
+
     <text name="external">www.sitepark.com</text>
     <url name="external">http://www.google.de</url>
+
     <url name="external">http://www.sitepark.com</url>
  
 
</resource>
 
</resource>

Version vom 8. Mai 2009, 14:56 Uhr

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>, <resource>, <media>

Beschreibung

  • <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) oder Dateiname des Medien-Artikels
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 eines name-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 Feldnamen external 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">
   <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 <code>name</code>-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>