Hilfe:TemplateData

Aus PokéWiki
Hilfeseiten
Allgemein:
Seitengestaltung
Community:
Spezielles:

Auf dieser Hilfeseite wird die Funktion TemplateData erklärt. Ziel ist es, dass TemplateData für möglichst viele Vorlagen anhand dieses Leitfadens angelegt wird, damit die Bearbeitung der Vorlagen im Visuellen Editor deutlich leichter wird.

Grundinformationen

TemplateData ist eine Erweiterung, mit deren Hilfe man Vorlagendaten wie Parameter im Visuellen Editor verständlicher darstellen kann. Außerdem ermöglicht die Einrichtung von TemplateData in jeder Vorlage die korrekte Nutzung im Visuellen Editor. Geboten werden Funktionen wie die Vorlagenbeschreibung, Parameterbeschreibungen mit Standard-/Autowerten, Verpflichtung einiger Parameter und vieles mehr. Diese Funktionen werden hier heruntergebrochen, damit nicht immer auf den Hilfeseiten von MediaWiki nachgeschaut werden muss.

Alle Schritte zur Erstellung von TemplateData

Vorlagendaten bearbeiten: Zwei Wege

Dialogfeld für Daten

Der Knopf zum Bearbeiten


Wie im Bild gezeigt, befindet sich der Einstiegspunkt in den TemplateData-Editor ganz oben im Bearbeitungsfenster. Bei vorhandenen Vorlagen werden alle Parameter automatisch in die Liste eingetragen. Lediglich neue Parameter müssen nachgetragen werden. Bei neuen Vorlagen empfehlen wir, die Vorlagendaten erst hinzuzufügen, wenn die Vorlage fertig geschrieben ist.

Dieser Weg der Bearbeitung wird ausdrücklich empfohlen, da im Dialogfenster alle Einstellmöglichkeiten vorhanden sind und dieser Weg fehlerfreier ist, als eine manuelle JSON anzulegen.

Rohe JSON

Vorab sei erwähnt, dass das manuelle Hinzufügen von Vorlagendaten mit Vorsicht zu genießen ist, da dabei mehrere Fehler passieren können, die zeitfressend sind und nicht abgespeichert werden können, solange sie nicht korrigiert sind. Das Dialogfenster wird an dieser Stelle erneut unbedingt empfohlen.

Dennoch ist es möglich, die Vorlagendaten mit einer reinen JSON anzulegen, da die JSON letztendlich durch das Dialogfeld angelegt wird. Die hinzugefügte JSON muss dabei korrekt formatiert sein, da sonst Fehler angezeigt werden und die Einbindung so nicht abgespeichert werden kann.

Im PokéWiki ist es gängig, dass Kategorien und andere Zusätze auf Vorlagenseiten in einem <noinclude> stehen. In jedem Fall muss TemplateData in <noinclude> eingefügt werden, da sonst unerwünschte Effekte auftreten. Die umgekehrte Logik, also das Einschließen der Vorlagenlogik in <onlyinclude> und die anschließend freie Einbindung von weiteren Zusätzen, ist ebenfalls möglich.

Die JSON sollte wie folgt aussehen (Beispiel anhand Vorlage:Episode):

<noinclude>
<templatedata>
{
	"params": {
		"Linknamen1": {},
		"Linknamen2": {},
		"Episodentitel_de": {},
		"Name_ja": {
			"label": "Bezeichnung",
			"description": "Beschreibung",
			"example": "Beispiel",
			"type": "line",
			"suggestedvalues": [
				"Vorgeschlagener Wert1",
				"Vorgeschlagener Wert2"
			],
			"default": "Standard",
			"autovalue": "Autowert",
			"required": true
		},
		"Name_en": {}
	},
	"format": "{{_\n|_=_\n}}",
	"paramOrder": [Linknamen1, Linknamen2, Episodentitel_de, "Name_ja", "Name_en", ...]
}
</templatedata>
</noinclude>

Erklärung des Dialogfelds

Von nun an wird nur noch auf das Dialogfeld, das über „Vorlagendaten bearbeiten“ erreichbar ist, eingegangen.

Sprachauswahl

Diese Auswahl ist uninteressant für das PokéWiki, da wir keine weitere Sprache unterstützen. Theoretisch wäre es hierüber möglich, Beschreibungen der Vorlage und der Parameter auf anderen Sprachen zu hinterlegen. Damit könnten Nutzer, die bspw. Englisch in den Einstellungen hinterlegt haben, eine englische Beschreibung aller Inhalte kriegen.

Vorlagenbeschreibung

Bei der Vorlagenbeschreibung ist es wichtig, kurz und prägnant zu Beginn zu erklären, was die Vorlage tut, damit man bei der Suche bereits erkennt, um welche Vorlage es sich handelt. Weitere Details können danach folgen, da die komplette Vorlagenbeschreibung angezeigt wird, wenn die Vorlage eingefügt wurde.

  • Die Beschreibung in der Vorlagensuche
    Die Beschreibung in der Vorlagensuche
  • Die Beschreibung in der Einbindung
    Die Beschreibung in der Einbindung

Zuordnungen bearbeiten

Parameterzuordnungen werden von uns nicht angewendet.

Wikitext-Formatierung

In diesem Teil des Dialogfeldes ist es möglich zu beschreiben, wie die Vorlage vom Visuellen Editor angelegt und im Quelltext ausgeschrieben wird. Diese Angabe sollte unbedingt getätigt werden, da viele unserer Vorlagen mit Zeilenumbrüchen arbeiten, damit die Parameter untereinander stehen. Es gibt folgende Optionen:

  • Inline {{_|_=_}}: Die Vorlage wird in einer Zeile erstellt.
  • Block {{_↵|_ = _↵}}: Die Parameter der Vorlage werden untereinander stehen, aber ein Leerzeichen vor und nach dem Gleichheitszeichen haben.
  • Benutzerdefiniert: Hier ist es möglich, eine eigene Zeichenfolge einzugeben. Gültig sind dabei diese Zeichen:
    • {{: Vorlage öffnen
    • _: Gibt die Position des Vorlagennamens, Parameternamens oder -werts an. Ein einziger Unterstrich genügt, wobei es möglich ist, mit mehreren Unterstrichen eine Mindestlänge anzugeben, wenn man erreichen möchte, dass die Parameter alle dieselbe Länge haben, was sich positiv auf die Übersichtlichkeit im Quelltext auswirken kann.
    • |: Separiert den Vorlagennamen vom Parameter.
    • =: Weist dem Parameter einen Wert zu.
    • \n oder ↵ (eingetipptes Enter): Zeilenumbruch
    • : Erzeugt ein Leerzeichen.
    • }}: Schließt die Vorlage.

Gibt man benutzerdefinierte Zeichenfolgen ein, muss darauf geachtet werden, dass das Minimum {{_|_=_}} angegeben wird. Es ist nicht möglich, eine spezielle Formatierung für jeden Parameter anzugeben. Es kann lediglich dieses eine Schema vorgegeben werden.

ParamOrder

Die Parameterreihenfolge kann relativ einfach bestimmt werden. Dazu können die Parameter einfach an den drei Linien links gegriffen und per Drag&Drop sortiert werden. Diese Reihenfolge legt die Parameterreihenfolge im Quelltext fest, jedoch nicht die angezeigte Reihenfolge im Visuellen Editor.

Vorlagenparameter

Parametereinstellung Erklärung
Name Hier wird der Name des Parameters angegeben. Beim Erstellen von TemplateData wird dieser normalerweise automatisch generiert, wenn der Parameter vorhanden ist.
Aliasse Diese Eigenschaft lassen wir im PokéWiki aus, da dadurch nur weitere Namen für denselben Parameter gegeben werden können und das zu Verwirrung führen wird.
Bezeichnung Ändert den Namen des Parameters in der Parameterliste und in der Überschrift der Parametereinstellungen. Wird nicht empfohlen.
Beschreibung Zeigt eine Beschreibung des Parameters beim Hinzufügen an.
Beispiel Zeigt ein Beispiel unter der Beschreibung an.
Typ unbekannt: Hat keine Auswirkungen und ist der Standard.

Wahrheitswert: Hat keine Auswirkungen.

Wikitext: Hat keine Auswirkungen.

Datei: Hat keine Auswirkungen.

Einzeiliger Text: Lässt eingegebenen Text nicht über mehrere Zeilen gehen.

Zahlenwert: Hat keine Auswirkungen.

Datum: Hat keine Auswirkungen.

Seitenname: Erzeugt ein Eingabefeld mit einem Dropdown, aus dem Seitentitel von existieren Artikeln ausgewählt werden können.

Mehrzeiliger Text: Erlaubt mehrzeiligen Text.

Vorlage: Verwenden wir nicht. Erzeugt zwar ein Dropdownmenü für Vorlagen, bindet diese allerdings nicht ein.

Unausgeglichener Wikitext: Hat keine Auswirkungen.

URL: Färbt den Kasten rot, wenn keine gültige URL eingegeben wird. Hindert den Benutzer allerdings nicht daran, die Vorlage abzuspeichern. Wird vom Autowert überschrieben, wenn dieser angegeben wird.

Benutzer: Wird nicht benutzt, da dadurch lediglich Benutzernamen eingetragen werden können.

Vorgeschlagene Werte In TemplateData können mehrere Werte hinterlegt werden. Diese werden in Form eines Dropdownmenüs bei der Parametereinstellung angezeigt. Dennoch kann eigener Text eingegeben werden.
Standard Zeigt unter der Parameterbeschreibung einen Standardwert an. Setzt nicht per se einen Standardwert in den Quelltext.
Autowert Ist der Autowert angegeben, nimmt der Parameter immer diesen Wert an, es sei denn, es wird etwas anderes eingegeben.
Status Hier können verschiedene Angaben gemacht werden:

optional: Macht den Parameter optional.

veraltet: Entfernt den Parameter aus der Auswahl der hinzufügbaren Parameter.

erforderlich: Setzt automatisch den Haken bei erforderlichen Parametern und setzt unter der Beschreibung die Anmerkung „Parameter ist erforderlich.“

vorgeschlagen: Setzt automatisch den Haken bei dem Parameter, sodass die Parameterbearbeitung sofort möglich ist und der Benutzer dazu aufgefordert wird, die Informationen einzutragen. Der Parameter kann jedoch im Gegensatz zu erforderlich entfernt werden.

Parameter hinzufügen

Sollen neue Parameter hinzugefügt werden, kann das über die Schaltfläche ganz unten im Dialogfeld der Vorlagendaten getan werden.

Abgerufen von „https://www.pokewiki.de/index.php?title=Hilfe:TemplateData&oldid=2931669“