XIP Template: Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: ==Templates== Die Eigenschaften für Templates werden ebenfalls über Attribute bestimmt. Zusäzliche Inhalte (z.B. das Layout) werden über eine Resource beschrieben. ...)
 
Zeile 1: Zeile 1:
==Templates==
+
=<code><template></code>=
Die Eigenschaften für Templates werden ebenfalls über Attribute bestimmt. Zusäzliche Inhalte (z.B. das Layout) werden über eine Resource beschrieben. Hier gelten die selben Bedingungen wie bei Resource-Artikeln.
+
===Beschreibung===
 +
Dieses XML-Element wird verwendet um IES-Templates zu definieren.
 +
===Erlaubte übergerodnete XML-Elemente===
 +
<code><xip></code>, <code><templatepool></code>
 +
===Attribute===
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Name || XML-Element || Beschreibung
 +
|-
 +
| <code>parent</code>
 +
| Anchor des Template-Pools für dieses Template. 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>
 +
| Der Anchor des Elementes
 +
|-
 +
| <code>name</code>
 +
| Der Name des Templates
 +
|-
 +
| <code>type</code>
 +
| Optionaler Typ des Templates (Template: 6000, Tag: 6001)
 +
|-
 +
| <code>name</code>
 +
| Der Name des Templates
 +
|-
 +
| <code>spml-version</code>
 +
| Angabe der SPML-Version. Dieser Wert wird beim Import ignoriert. Zur Zeit existiert nur Version 1.
 +
|-
 +
| <code>suffix</code>
 +
| Dateiendung für Artikel die mit diesem Template angelegt werden
 +
|}
 +
===Unterelemente===
 +
====<code><source></code>====
 +
=====Beschreibung=====
 +
Der Template Quell-Code
 +
=====Attribute=====
 +
keine
 +
====<code><resource></code>====
 +
=====Beschreibung=====
 +
Beliebiger Content, der für das Template definiert werden soll. Wie die einzelnen Content-Elemente definiert werden, ist unter[[XIP Content]] beschrieben.
  
Attribute bzw. Unterelemente des XML-Elements "<code>template</code>"
+
Für Templates, die in Infosite 5 verwendet werden sollen, können folgende Content-Elemente hinzugefügt werden, um das Verhalten des Templates in Infosite 5 zu steueren.
;<code>anchor</code>
+
{| class="prettytable sortable"
:Anker des Templates. Dient beim wiederholten Import als Primärschlüssel dieser Daten und als Parent für die Artikel ([[String]]).
+
|- class="hintergrundfarbe1"
;<code>name</code>
+
! Name || Feldname || Beschreibung || Beispiel
:Name des Templates ([[String]]).
+
|-
;<code>parent</code>
+
| <code>layout</code>
:Anker des Parentpools. Die Angabe muss über einen Anker erfolgen ([[String]]).
+
| Typ des Templates. Folgende Werte sind möglich
;<code>type</code>
 
:Optionaler Typ des Templates (Template: 6000, Tag: 6001) ([[Integer]]).
 
;<code>spml-version</code>
 
:Optionale Angabe der SPML-Version, auf der das Template basiert ([[String]]).
 
;<code>suffix</code>
 
:Dateiendung für Artikel die mit diesem Template angelegt werden ([[String]]).
 
;<code>source</code>
 
:Der SPML-Quellcode des Templates als sog. Body-Tag: <code>< source > ... < /source ></code> ([[String]]).
 
 
 
 
 
Das Feld "<code>layout</code>" wird als "<code>text</code>" innerhalb einer "<code>resource</code>" definiert und hat folgende Werte:
 
 
;<code>common</code>
 
;<code>common</code>
 
:Normales Template.
 
:Normales Template.
Zeile 25: Zeile 52:
 
:Template welches eigene Handler-Aufrufe enthält.
 
:Template welches eigene Handler-Aufrufe enthält.
 
;<code>tag</code>
 
;<code>tag</code>
:Ein Tag-Template.
+
:Ein Tag-Template. Wird dieser Wert gesetzt muß auch das Type-Attribut des <code><template></code>-Elementes auf 6001 gesetzt werden
 
;<code>container</code>
 
;<code>container</code>
 
:Ein Template mit Angaben zum Container.
 
:Ein Template mit Angaben zum Container.
 +
| <code><text name="layout">common</text></code>
 +
|-
 +
| <code>multilingualism</code>
 +
| Wert ist <code>true</code> oder <code>false</code> und zeigt an, ob das Template Mehrsprachig ist.
 +
| <code><text name="multilingualism">false</text></code>
 +
|-
 +
| <code>menutext</code>
 +
| Menütext für das Template, der im Redaktionsbereich angezeigt werden soll. Mit Angabe eines <code>locale</code>-Attributes kann ein Mehrsprachiger Menütext angegeben werden
 +
| <code><text name="menutext">Haupttext</text></code>
 +
|-
 +
=====Attribute=====
 +
keine
 +
===Beispiel für eine Template===
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
 +
<template anchor="template.xip.example.1" name="Template Example 1" parent="standard.container.editing" suffix="html" type="6000">
 +
  <source>&lt;sp:io type="in"&gt;&#xD;
 +
  Eingabetext&lt;br&gt;&#xD;
 +
  &lt;spt:text name="sp_text"/&gt;&#xD;
 +
&lt;/sp:io&gt;&lt;sp:io type="out"&gt;&lt;sp:print name="sp_text"/&gt;&lt;/sp:io&gt;</source>
 +
 +
  <resource>
 +
    <text name="layout">common</text>
 +
  </resource>
 +
 +
</template>
 +
</source>
  
 
<noinclude>
 
<noinclude>

Version vom 11. Mai 2009, 09:16 Uhr

<template>

Beschreibung

Dieses XML-Element wird verwendet um IES-Templates zu definieren.

Erlaubte übergerodnete XML-Elemente

<xip>, <templatepool>

Attribute

Name XML-Element Beschreibung
parent Anchor des Template-Pools für dieses Template. 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 Der Anchor des Elementes
name Der Name des Templates
type Optionaler Typ des Templates (Template: 6000, Tag: 6001)
name Der Name des Templates
spml-version Angabe der SPML-Version. Dieser Wert wird beim Import ignoriert. Zur Zeit existiert nur Version 1.
suffix Dateiendung für Artikel die mit diesem Template angelegt werden

Unterelemente

====

</code>====
=====Beschreibung=====
Der Template Quell-Code
=====Attribute=====
keine
====<code><resource></code>====
=====Beschreibung=====
Beliebiger Content, der für das Template definiert werden soll. Wie die einzelnen Content-Elemente definiert werden, ist unter[[XIP Content]] beschrieben.

Für Templates, die in Infosite 5 verwendet werden sollen, können folgende Content-Elemente hinzugefügt werden, um das Verhalten des Templates in Infosite 5 zu steueren.
{| class="prettytable sortable"
|- class="hintergrundfarbe1"
! Name || Feldname || Beschreibung || Beispiel
|-
| <code>layout</code>
| Typ des Templates. Folgende Werte sind möglich
;<code>common</code>
:Normales Template.
;<code>handler</code>
:Template welches eigene Handler-Aufrufe enthält.
;<code>tag</code>
:Ein Tag-Template. Wird dieser Wert gesetzt muß auch das Type-Attribut des <code><template></code>-Elementes auf 6001 gesetzt werden
;<code>container</code>
:Ein Template mit Angaben zum Container.
| <code><text name="layout">common</text></code>
|-
| <code>multilingualism</code>
| Wert ist <code>true</code> oder <code>false</code> und zeigt an, ob das Template Mehrsprachig ist.
| <code><text name="multilingualism">false</text></code>
|-
| <code>menutext</code>
| Menütext für das Template, der im Redaktionsbereich angezeigt werden soll. Mit Angabe eines <code>locale</code>-Attributes kann ein Mehrsprachiger Menütext angegeben werden
| <code><text name="menutext">Haupttext</text></code>
|-
=====Attribute=====
keine
===Beispiel für eine Template===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<template anchor="template.xip.example.1" name="Template Example 1" parent="standard.container.editing" suffix="html" type="6000">
  <source>&lt;sp:io type="in"&gt;&#xD;
  Eingabetext&lt;br&gt;&#xD;
  &lt;spt:text name="sp_text"/&gt;&#xD;
&lt;/sp:io&gt;&lt;sp:io type="out"&gt;&lt;sp:print name="sp_text"/&gt;&lt;/sp:io&gt;
 <resource>
   <text name="layout">common</text>
 </resource>

</template> </source>