Hilfe:Vorlagen-Editor

Aus GaretienWiki
Zur Navigation springen Zur Suche springen

Wenn man möchte, dass der Inhalt einer Vorlage (nennen wir sie hier mal "Vorlage:Test") im Vorlageneditor editierbar ist, muss man eine Seite mit der Editor-Definition (unter dem Artikel "Vorlage:Test/Editor") erstellen.

Für jedes Feld und jede Überschrift muss darin eine Zeile geschrieben sein, damit das ganze besser lesbar, sollte man die Zeile mit einem Leerzeichen beginnen. Leerzeilen werden ignoriert und können zur Strukturierung und besseren Lesbarkeit benutzt werden.

Eine Zeile folgt dieser Syntax

|Feldname=Typ!Pflichtfeld!Beschreibung!Auswahlwert1;Auswahlwert2;...!Standardwert!Migrationswert1;Migrationswert2;...

Feldname ist ein Pflichtfeld und entspricht dem Feld in der Vorlage bzw. dem Titel für die Sektion. Der Feldname muss auf jeden Fall eindeutig sein.

Typ ist ebenfalls ein Pflichtfeld und kann die folgenden Felder enthalten:

  • TITLE ist eine Sektionsüberschrift im Editor
  • TEXT ist ein einzeiliges Eingabefeld
  • TEXTAREA ist ein mehrzeiliges Eingabefeld
  • PICK ist eine Auswahlliste
  • NUMBER erwartet einen ganzzahligen Wert
  • LINK erwartet einen Link zu einem Artikel inklusive Namensraum, wird im Zweifel von der Software entsprechend reduziert
  • LINKNONS erwartet einen Link zu einem Artikel inklusive Namensraum, wird im Zweifel von der Software entsprechend reduziert
  • COORDS erwartet ein oder mehrere Koordinatenpaare in der Form "X1 Y1, X2 Y2, ..." Alte Koordinaten der Form "X1;Y1;X2;Y2;..." werden automatisch konvertiert

Pflichtfeld wird beim Abspeichern nicht geprüft, zeigt aber im Editor dem Benutzer an, dass dies ein Pflichtfeld ist und zu füllen ist, dazu muss "MUST" eingegeben werden. In allen anderen Fällen ist das Feld kein Pflichtfeld.

Bei Beschreibung können weitere Erklärungen zum Feld eingetragen werden, allerdings Wiki-Syntax kann eingeschränkt benutzt werden (es dürfen keine "|" und "!" vorkommen, kompliziertere Eingaben könnten die Editor Anzeige zerlegen).

Wenn der Typ des Feldes eine Auswahlliste ist ("PICK"), können mit Semikolon getrennte Auswahlwerte eingegeben werden.

Mit dem Standardwert wird das Feld gefüllt, wenn es vorher noch nicht existiert hat, war es vorher leer, passiert das allerdings nicht.

Die ebenfalls durch Semikolon getrennten Migrationswerte geben Felder an, die - durch Leerzeichen getrennt - an dieses Feld angehängt werden können. Das ist vor allem dann hilfreich, wenn alte Vorlagen auf neue Migriert werden sollen (z.B. das "Vorname" und "Nachname" ins Feld "Langname" kopiert werden sollen).