Hilfe:TemplateData/Anwendung

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen

Dieses Hilfeseite erläutert Wikipedia-Autoren die Bedeutung von Daten-Typen und Wertformatierungen, die in den Dokumentationsseiten zu Vorlagen erwähnt werden, insbesondere wenn dabei TemplateData verwendet wird. Die Anwendung einer bestimmten Vorlageneinbindung soll dadurch erleichtert werden.

Datentypen einzelner Parameter[Bearbeiten | Quelltext bearbeiten]

Benutzer[Bearbeiten | Quelltext bearbeiten]

Der Nickname eines registrierten Benutzers ohne vorangestelltes Benutzer:.

Gelegentlich käme auch die IP-Adresse nicht angemeldeter Benutzer in Frage.

Boolesch[Bearbeiten | Quelltext bearbeiten]

Ein Parameterwert, der nur die Bedeutungen „ja“ oder „nein“ haben soll (Boolesche Logik).

Das Format, das Vorlagen erwarten und richtig verarbeiten können, kann sehr unterschiedlich sein:

  • Herkömmliche Programmierung interpretiert jeden nicht-leeren Wert als „ja“ – also auch nein oder 0 usw.
  • Der VisualEditor schreibt und versteht in einer international üblichen Form:
    • 1 – „ja“ (und alle sonstigen Werte)
    • 0 – „nein“
    • leer – jeweiliger Vorgabewert
  • Manche Vorlagen erwarten ausdrücklich bestimmte Zeichenketten; verstehen alle anderen Werte falsch: Es müsse ja oder woanders JA oder bei einer anderen Vorlage Ja oder bei einer weiteren ausdrücklich nein heißen.
  • Moderne Vorlagenprogrammierungen sind robust und „verstehen“ unterschiedliche Werte sinngemäß.

Datei[Bearbeiten | Quelltext bearbeiten]

Der Bezeichner einer Mediendatei ohne vorangestelltes Datei:.

Es ist unzulässig, hieran Parameter für eine Einbindung anzuhängen (mittels maskierter Pipe-Symbole).

Datum[Bearbeiten | Quelltext bearbeiten]

Ein Datum; möglicherweise ist auch nur eine Jahreszahl oder der Monat in einem Jahr gewünscht, vielleicht aber auch ein bestimmter Tag.

Es gibt unterschiedliche Möglichkeiten, welches Format erwünscht ist und richtig verarbeitet werden kann. Das gewünsche Format sollte immer explizit angegeben sein:

  • Standardformate des Projekts:
    • 18. November 2018 – ortsübliche Darstellung wie auch für Leser.
    • 2018-11-18ISO-Format JJJJ-MM-TT: Gut sortierbar, mittels Cirrus-Suche leicht eingrenzbar, filterbar. International austauschbare Zuweisungen.
  • Viele Vorlagenprogrammierungen können mit beiden Eingabeformaten arbeiten, stellen sie für die Leser dann immer als 18. November 2018 dar.
    • Hier sollte im Zweifelsfall zum ISO-Format übergegangen werden, wenn nichts dagegen spricht, und dies in der Dokumentation auch so angegeben werden.
  • Moderne Vorlagenprogrammierungen sind robust und „verstehen“ noch weitere Formate. Trotzdem sollte das angegebene Format benutzt werden, um Auswertungen nicht zu behindern.

Inhalt[Bearbeiten | Quelltext bearbeiten]

Beliebiger Wikitext ist zulässig. Allerdings sollte er eine syntaktische Einheit bilden. Öffnende Elemente (z. B. eckige Klammern) sollen also wieder geschlossen werden.

Nummer (Zahl)[Bearbeiten | Quelltext bearbeiten]

Eine Zahl, wobei das Zahlenformat aber von Vorlage zu Vorlage abweichen kann. In Frage kommen:

  • 12345678,9 – ortsübliche Darstellung, jedoch ohne Tausendertrennzeichen, mit Komma , als Dezimaltrennzeichen.
  • 12345678.9 – Computer-geeignetes (internationales) Format, mit Punkt . als Dezimaltrennzeichen, ohne Tausendertrennzeichen.
  • 12.345.678,9 – ortsüblich, Tausendertrennzeichen erlaubt.
  • ggf. weitere

Ein ASCII-Minuszeichen - („Bindestrich“) ist in der Regel unproblematisch, wenn dies auch inhaltlich sinnvoll ist.

Seite[Bearbeiten | Quelltext bearbeiten]

Der Name einer Seite, womöglich auch in einem anderen Projekt (Interwiki).

In der Regel wird gewünscht und sinnvoll sein, eine bereits existierende Seite anzugeben; das ist jedoch keine zwingende Voraussetzung.

Sprachen[Bearbeiten | Quelltext bearbeiten]

Gelegentlich kommen als Parameter menschliche Sprachen (also keine Programmiersprachen usw.) vor.

Oft werden dabei Sprachcodes erwartet. Das hat folgende Gründe:

  • Sie lassen sich einheitlich auswerten (nl statt: holl., holländ., ndl., niederl., niederländ., niederländisch usw.).
  • Sie können durch Werkzeuge im Klartext ausgewählt und dann kodiert eingefügt werden.
  • Manche Angaben werden an externe Software exportiert oder für externe Software verfügbar gemacht (Zitationen, Rechtschreibprogramme, Screenreader) – dafür sind standardisierte Werte erforderlich.
  • Einbindungen können international ausgetauscht werden; die Darstellung für Leser erfolgt jeweils in der Sprache der Seite.
  • Sie sind kürzer.

Typische Werte wären:

Theoretisch sind etwa 8500 verschiedene Codes möglich, die von Software verstanden werden könnten. Dabei gehört zu jeder Sprachvariante nur genau ein gültiger Code.

  • Zu etwa 700 davon kennt die MediaWiki-Software ihren Namen.
  • Zu etwa 250 ist in der deutschsprachigen Wikipedia eine Verlinkung zu einem Artikel über diese Sprache bekannt.

URL[Bearbeiten | Quelltext bearbeiten]

Eine syntaktisch gültige URL – Leerzeichen können also nicht enthalten sein. Einklammern als Weblink ist hier nicht erlaubt (im Gegensatz zum Daten-Typ "Line/ Zeile" beispielsweise).

Vorlage[Bearbeiten | Quelltext bearbeiten]

Der Bezeichner einer Vorlage ohne vorangestelltes Vorlage:.

Zeichenfolge[Bearbeiten | Quelltext bearbeiten]

Eine längere Zeichenkette. Möglicherweise ist Wikitext-Formatierung nicht erwünscht; siehe dazu „Inhalt“.

Zeile[Bearbeiten | Quelltext bearbeiten]

Ein kurzer Text, etwa ein Bezeichner, ein Code, ein Name, ein Schlagwort.

Wikisyntax kann möglich sein oder auch nicht, je nach Anwendungsfall. Meist ist das jedoch explizit unerwünscht; dann wäre vermutlich „Inhalt“ angegeben worden.

Es wird nur ein einzeiliges Eingabefeld angezeigt, und die Eingabe wird in einer einzigen Zeile in den Quelltext zurückgeschrieben.

Aliasnamen von Parametern[Bearbeiten | Quelltext bearbeiten]

In den Zeilen unter dem vorlagentechnischen Parameternamen in der zweiten Spalte könnten alternative Parameternamen aufgelistet werden.

  • Oft handelt es sich um veraltende und deshalb unerwünschte Varianten.
  • Damit einheitliche Auswertungen möglich sind, ist oft wünschenswert, dies gelegentlich auf den Standardnamen umzustellen.

Optionale und Pflichtparameter[Bearbeiten | Quelltext bearbeiten]

Für die Erfordernis von Parameterangaben gibt es vier Stufen:

  1. erforderlich
    • Ohne eine Wertangabe ist keine sinnvolle Umsetzung der Vorlageneinbindung möglich.
    • „Pflichtparameter“
    • Fehlende Angaben lösen oft Fehlermeldungen und/oder Wartungskategorien aus.
    • Auch bei fehlender Wertangabe wird in den Quelltext eine leere Wertzuweisung geschrieben.
    • Kennfarbe: hellblau unterlegt.
  2. vorgeschlagen
    • Eine Wertangabe ist häufig sinnvoll, aber nicht zwingend erforderlich.
    • Im VisualEditor wird dieses Feld im Menü angeboten.
    • Auch bei fehlender Wertangabe wird in den Quelltext eine leere Wertzuweisung geschrieben, damit dort später leichter ein Wert nachgetragen werden kann.
    • Kennfarbe: weiß unterlegt.
  3. optional
    • Eine Wertangabe ist manchmal notwendig, in der Regel jedoch nicht sinnvoll.
    • Im VisualEditor wird dieses Feld im Menü zunächst nicht angeboten; dieses kann jedoch auf Anforderung erweitert werden.
    • Bei fehlender Wertangabe wird nichts in den Quelltext geschrieben.
    • Kennfarbe: grau unterlegt.
  4. veraltet
    • Diese Parameterverwendung sollte im Zuge der Bearbeitung möglichst ersetzt werden.
    • Bei fehlender Wertangabe wird nichts in den Quelltext geschrieben.
    • Kennfarbe: rötlich unterlegt.

Zu allen Werten kann ein „Standard“ und ggf. auch ein „Beispiel“ angegeben sein. In der Vorlage wird „Standard“ verwendet, falls kein Wert ausdrücklich angegeben ist.

Quelltext-Layout[Bearbeiten | Quelltext bearbeiten]

Das Quelltext-Format, in dem Skripte die Einbindung schreiben, und das für Benutzer in der Regel auch empfohlen wird, ist zum Schluss der TemplateData-Informationen angegeben.

  • inline – alles auf einer Zeile, ohne Leerzeichen (Standard)
  • block – ein Parameter je Zeile, wie auch bei Infoboxen üblich
  • Eine Erweiterung in der deutschsprachigen Wikipedia ermöglicht weitere menschenfreundlichere Schlüsselwörter.
  • Freie Vereinbarung von Leerzeichen und Zeilenumbruch durch spezielle Codes wie {{_\n| _=_\n}}
    • Dieser Hinweis ist eher an Vorlagenprogrammierer adressiert.
    • Siehe JSON-Spezifikation zu Einzelheiten.