XIP Content

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen

Content ist der Teil des XIP, mit dem beliebige Daten und Datenstrukturen z.B. für einen Artikel definiert werden. Content-XML-Elemente müssten unterhalb der folgenden XML-Elemente liegen


Liste der Content-XML-Elemente:



<text>

Beschreibung

Mit diesem XML-Element wird allgemeiner Text-Content definiert. Der Text-Content wird im Body des Elementes angegeben (XML encodet). Um eine ID als Text-Content zu definieren, sollte das Attribute anchor verwendet werden. Der Anchor wird gegen die ID aufgelöst und anstatt des Element-Bodys als Text-Content verwendet.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
anchor Der Anchor wird verwendet, um ID's als Text-Content zu verwenden. Bei einem Import wird der Anchor gegen die ID aufgelöst und als Text-Content verwendet. Wird dieses Attribut angegeben, wird der Body des Elementes ignoriert.
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<text name="sp_title">Einfache XIP-Datei</text>

<text name="editorTemplatePool" anchor="standard.container.editing"/>




<date>

Beschreibung

Mit diesem XML-Element werden Datum-Informationen definiert. Ein Datum wird in Millisekunden ab dem 1.1.1970 00:00 Uhr (UTC) angegeben.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<date name="sp_date">163119600000</date>




<number>

Beschreibung

Mit diesem XML-Element wird Nummerischer Content definiert.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<number name="sp_number">100</number>




<mail>

Beschreibung

Mit diesem XML-Element werden Email-Adressen definiert. Inhalte werden nicht validiert und können über ".mail" ausgegeben werden.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<mail name="sp_mail">Email: support@sitepark.com</mail>




<email>

Beschreibung

Mit diesem XML-Element werden Email-Adressen definiert. Inhalte können validiert werden. Dieser Typ wird in der Regel vom Newsletter oder ähnlichen Modulen verwendet und kann über ".email" ausgegeben werden.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<text name="sp_mail">Email vom Sitepark Support</text>
<email name="sp_mail">support@sitepark.com</email>




<query>

Beschreibung

Mit diesem XML-Element werden Queries definiert. Die Queries müssen der SPQL-Syntax entsprechen.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<query name="sp_query">parent = !{myparent}</query>




<url>

Beschreibung

Mit diesem XML-Element werden URL's definiert.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<url name="sp_url">http://www.sitepark.com</url>




<link>, <navlink>, <systemlink>

Beschreibung

Mit diesem XML-Element werden Verknüpfungen von z.B. Artikeln untereinander definiert. Eine genaue Beschreibung der verschiedenen Link-Typen ist auf der Seite Link-Service zu finden. Verknüpfungen von Artikeln (oder anderen Elementen) untereinander werden immer über ihre Anchor angegeben. Existiert bei einem Import der angegebene Anchor im System nicht, wird die Verknüpfung ignoriert.

Es ist aber möglich mehrere Artikel innerhalb eines XIP zu importieren, die untereinander Verknüpft sind, da der Import in zwei Schritten erfolgt. Zunächst werden die Artikel ohne Content angelegt, so das auch die neuen Anchor im System verfügbar sind. Im zweiten Durchlauf wird dann der Content importiert und die Artikel können untereinander Verknüpft werden, da die Anchor dann im System bekannt sind.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
anchor Anchor des Elementes, mit dem Verknüpft werden soll.
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Beispiel

<link name="sp_link" anchor="article.medium1">


<list>

Beschreibung

Mit diesenm XML-Element werden Listen definiert. Eine Liste enthält Listen-Elemente die mit <item>-XML-Elementen definiert werden. Innerhalb eines <item>-XML-Elementes können dann wieder alle Content-XML-Elemente enthalten sein.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name der Liste

Unterelement

<item>

Beschreibung

Mit diesem XML-Element wird ein Listen-Eintrag definiert. Innerhalb eines <item>-XML-Elementes können dann wieder alle Content-XML-Elemente enthalten sein.

Attribute

keine

Beispiel

<list name="sp_main_iterate">
  <item>
    <text name="sp_subheadline">Content:</text>
    <text name="sp_part">Link auf die Rubrikseite</text>
    <link name="sp_link" anchor="article.rubric"/>
  </item>
</list>




<binary> oder <image>

Beschreibung

Mit diesem XML-Element werden Medien/Binäredaten definiert. Die Verwendung von <binary> und <image> ist für den Import äquivalent. Es existieren zwei XML-Elemente für Medien, da der Exporter zwischen Bildern und anderen Medien unterscheidet. Wird ein Medium mit einem MIME-Type "image/*" exportiert wird anstatt des <binary>-XML-Elementes das <image>-XML-Element verwendet. Für Bilder werden noch zusätzliche Attribute exportiert, die aber beim Import ignoriert werden.

Es gibt zwei Möglichkeiten die Daten des Mediums anzugeben.

url Attribut

Über das Attribute url kann auf eine externe Resource verwiesen werden, die bei einem Import eingelesen wird. Diese Resource kann eine HTTP-Adresse sein. Voraussetzung für einen import ist allerdings, das diese Resouce vom IES-Server aus erreichbar ist (Möglicherweise erforderliche Proxy-Einstellungen müssen im IES vorgenommen werden). 

<binary ... url="http://www.sitepark.com/img/sitepark-logo_home.gif"/>

Bei einer Datei, die im gleichen XIP-Verzeichnis liegt kann der Pfad zu dieser Datei relativ mit Angabe des Protokolls file:// angegeben werden 

<binary ... url="file://./img.jpg"/>
<binary ... url="file://../img/image.jpg"/>
<binary ... url="file://./bin/img/image.jpg"/>

Der Exporter verwendet immer das url Attribut

BASE64

Die Daten des Mediums können auch direkt im XML-Element angegeben werden. Dazu müssen die Daten zunächste BASE64 encodet werden. Die BASE64 Zeichenkette wird dann im Body des XML-Element angegeben 

<binary ... >
RGllIEVudHdpY2tsZXIgdm9uIFNpdGVwYXJrIHfDvG5zY2hlbiB2aWVsIFNwYXNzIG1pdCBkZXIg
WElQLVNjaG5pdHRzdGVsbGUgOi0pCg==
</binary>

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes. Um die Binäredaten für einen Medien-Artikel (<media>) zu definieren wird dieses Attribut nicht mit angegeben. In allen anderen Fällen muss der Name des Feldes angegeben werden.
filename Dateiname für das Medium
mime MIME-Type des Mediums
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes
Attribute die exportiert, aber bei einem Import ignoriert werden
size Größe des Mediums
format Grafikformat des Bildes (png, gif, jpeg, ...)
width Breite des Bildes in Pixel
height Höhe des Bildes in Pixel

Beispiel

<binary name="sp_image">
RGllIEVudHdpY2tsZXIgdm9uIFNpdGVwYXJrIHfDvG5zY2hlbiB2aWVsIFNwYXNzIG1pdCBkZXIg
WElQLVNjaG5pdHRzdGVsbGUgOi0pCg==
</binary>




<calendar>

Beschreibung

Dieses XML-Element dient zur Beschreibung von Terminen. Auch Angaben zur Freischaltung erfolgen über diesen Tag. Zu beachten ist, dass die Zeiten als Millisekunden seit dem 1.1.1979 00:00:00 Uhr (UTC) angegeben werden müssen. Details zu Terminen werden über das <entry>-XML-Element beschrieben.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
locale Dieses Attribut bestimmt die Mehrsprachigkeit des Feldes

Unterelement

<entry>

Beschreibung

Über dieses XML-Elementes werden die Details des Termins angegeben

Attribute
Name Beschreibung
from Long Wert für den Beginn des Termins
to Long Wert für das Ende des Termins
type Typ des Termins (day, daily, weekly, monthlyByDay, monthlyByOccurrence, yearlyByDay, yearlyByOccurrence, yearlyByMonth)
interval Wiederholungsintervall des Termins (z.B. jeden 2-ten Tag)
all-day Ganztägiger Termin (true, false)
repetition-count Anzahl der Wiederholungen
repetition-date Long Wert für das Ende der Wiederholungen
dow Tage der Woche, an denen der Termin stattfindet (sun,mon,tue,wed,thu,fri,sat)
dom Zahl für den Tag des Monats
doy Zahl für den Tag des Jahres
oom Zahl für das Vorkommen in der Woche (z.B. 1. Freitag im Monat)
moy Zahl für den Monat des Jahres (0=Januar, 11=Dezember)

Beispiel

<calendar name="sp_date">
  <entry from="1208296800000" to="1208296800000"
    type="weekly"
    interval="0"
    all-day="true"
    repetition-date="1208383200000"
    dow="wed,thu"/>
</calendar>




<linktree> (ab Version 2.0.1)

Beschreibung

Mit diesem XML-Element werden LinkTrees wie z.B. Sitemaps definiert.

Erlaubte übergerodnete XML-Elemente

<article>, <media>, <resource>, <item>

Attribute

Name Beschreibung
name Name des Feldes
parentlink Name des Links (z.B. sp_parent.link), der auf einen, in der zu erstellenden Struktur, übergeordneten Artikel verweist.
rootelement-anchor Anchor des Root-Elements des Baums. Ist kein Root-Element angegeben, wird der dazugehörige Artikel als Root-Element verwendet.
attributes (deprecated ab Version 2.1) Eine Kommaseparierte Liste von Attributen, die der Artikel enthalten und auf dessen Änderungen er reagieren soll.

Deprecated. Dieses Attribut wird nicht mehr benötigt. Die Abhängigkeiten werden automatisch erkannt (siehe Dependencies-Service, LinkTree-Service)

localelink Mit diesem Attribut kann angegeben werden, ob ein Linktree sprachabhängig aufgebaut werden soll. Wird localelink auf true gesetzt, wird die Sprache des Publikationsbereichs für den Tree verwendet. Die Parentlinks, die den Baum ergeben, müssen dann mit einer Sprache definiert werden.
sortkeys Attribute des Artikels, nach denen der Baum sortiert werden soll. Jede Ebene des Baums wird für sich sortiert.
sortsequences Für jedes Sortierkriterium muss eine Sortierreihenfolge festgelegt werden, mit der bestimmt wird, ob mit dem Sortierkriterium aufsteigend (desc), absteigend (asc) oder zufällig (random) sortiert wird.
sorttypes Für jedes Sortierkriterium kann ein Sortiertyp festgelegt werden, der bestimmt, wie sortiert wird. Dabei ist eine Sortierung von Zeichenketten (text) oder eine Sortierung von Zahlen (number) möglich.

Beispiel

<linktree
  name="sp_sitemap" parentlink="sp_parent.link" rootelement-anchor="information.sg.homepage"
  localelink="true" attributes="sp_title,sp_tooltip,sp_menuSperre,sp_parent.link,editor_template"
  sortkeys="name"/>
Abgerufen von „https://wiki.sitepark.com/index.php?title=XIP_Content&oldid=3448“