4.206
Bearbeitungen
Nicht angemeldeter Benutzer - Bearbeiten von Seiten ist nur als angemeldeter Benutzer möglich.
Änderungen
Zur Navigation springen
Zur Suche springen
Hilfe:TemplateData/Anwendung (Quelltext anzeigen)
Version vom 14. Dezember 2019, 08:29 Uhr
, 08:29, 14. Dez. 2019Die Seite wurde neu angelegt: „{{Hilfe}} Dieses Hilfeseite erläutert Wikipedia-Autoren die Bedeutung von Datentypen und Wertformatierungen, die in den Dokumentationsseiten zu Hilfe:Vorlag…“
{{Hilfe}}
Dieses Hilfeseite erläutert Wikipedia-Autoren die Bedeutung von Datentypen und Wertformatierungen, die in den Dokumentationsseiten zu [[Hilfe:Vorlagen|Vorlagen]] erwähnt werden, insbesondere wenn dabei '''[[Hilfe:TemplateData|TemplateData]]''' verwendet wird. Die '''Anwendung''' einer bestimmten Vorlageneinbindung soll dadurch erleichtert werden.
== Datentypen einzelner Parameter ==
=== {{Anker|user}} {{int:templatedata-doc-param-type-wiki-user-name}} ===
Der Nickname eines registrierten Benutzers ''ohne'' vorangestelltes <code>Benutzer:</code>.
Gelegentlich käme auch die IP-Adresse nicht angemeldeter Benutzer in Frage.
=== {{Anker|boolean}} {{int:templatedata-doc-param-type-boolean}} ===
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 <code>nein</code> oder <code>0</code> usw.
* Der [[Hilfe:VisualEditor|VisualEditor]] schreibt und versteht in einer international üblichen Form:
** <code>1</code> – „ja“ (und alle sonstigen Werte)
** <code>0</code> – „nein“
** ''leer'' – jeweiliger Vorgabewert
* Manche Vorlagen erwarten ausdrücklich bestimmte Zeichenketten; verstehen alle anderen Werte falsch: Es müsse <code>ja</code> oder woanders <code>JA</code> oder bei einer anderen Vorlage <code>Ja</code> oder bei einer weiteren ausdrücklich <code>nein</code> heißen.
* Moderne Vorlagenprogrammierungen sind robust und „verstehen“ unterschiedliche Werte sinngemäß.
=== {{Anker|file}} {{int:templatedata-doc-param-type-wiki-file-name}} ===
Der Bezeichner einer Mediendatei ''ohne'' vorangestelltes <code>Datei:</code>.
Es ist unzulässig, hieran Parameter für eine Einbindung anzuhängen (mittels maskierter Pipe-Symbole).
=== {{Anker|date}} {{int:templatedata-doc-param-type-date}} ===
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ünschte Format sollte immer explizit angegeben sein:
* Standardformate des Projekts:
** <code>{{LOCALDATE}}</code> – ortsübliche Darstellung wie auch für Leser.
** <code>{{#time:Y-m-d}}</code> – [[ISO 8601|ISO-Format]] ''JJJJ-MM-TT'': Gut sortierbar, mittels [[Hilfe:Suche/Cirrus|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 ''<span style="white-space:nowrap">{{LOCALDATE}}</span>'' 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.
=== {{Anker|wikitext}} {{int:templatedata-doc-param-type-content}} ===
Beliebiger [[Wikitext]] ist zulässig. Allerdings sollte er eine syntaktische Einheit bilden. Öffnende Elemente (z. B. eckige Klammern) sollen also wieder geschlossen werden.
=== {{Anker|number}} Nummer (Zahl) ===
Eine Zahl, wobei das Zahlenformat aber von Vorlage zu Vorlage abweichen kann. In Frage kommen:
* <code>12345678,9</code> – ortsübliche Darstellung, jedoch ohne [[Tausendertrennzeichen]], mit Komma <code>,</code> als [[Dezimaltrennzeichen]].
* <code>12345678.9</code> – Computer-geeignetes (internationales) Format, mit Punkt <code>.</code> als Dezimaltrennzeichen, ohne Tausendertrennzeichen.
* <code>12.345.678,9</code> – ortsüblich, Tausendertrennzeichen erlaubt.
* ''ggf. weitere''
Siehe dazu auch: [[Wikipedia:Schreibweise von Zahlen]]
Ein [[American Standard Code for Information Interchange|ASCII]]-Minuszeichen <code>-</code> („Bindestrich“) ist in der Regel unproblematisch, wenn dies auch inhaltlich sinnvoll ist.
=== {{Anker|page}} {{int:templatedata-doc-param-type-wiki-page-name}} ===
Der [[Hilfe:Seitenname|Name einer Seite]], womöglich auch in einem anderen Projekt ([[Hilfe:Interwiki-Links|Interwiki]]).
In der Regel wird gewünscht und sinnvoll sein, eine bereits existierende Seite anzugeben; das ist jedoch keine zwingende Voraussetzung.
=== {{Anker|lang}} Sprachen ===
Gelegentlich kommen als Parameter menschliche Sprachen (also keine Programmiersprachen usw.) vor.
Oft werden dabei [[Wikipedia:Technik/MediaWiki/Sprachen|Sprachcodes]] erwartet. Das hat folgende Gründe:
* Sie lassen sich einheitlich auswerten (<code>nl</code> 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:
{|
|-
|
* <code>de</code> – {{deS}}
* <code>de-AT</code> – [[{{#language:de-AT}}]]
* <code>de-CH</code> – [[{{#language:de-CH}}]]
|style="padding-left:2em"|
* <code>en</code> – {{enS}}
* <code>fr</code> – {{frS}}
* <code>es</code> – {{esS}}
|}
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.
=== {{Anker|url}} {{int:templatedata-doc-param-type-url}} ===
Eine syntaktisch gültige [[Uniform Resource Locator|URL]] – Leerzeichen können also nicht enthalten sein. Einklammern als Weblink ist hier nicht erlaubt (im Gegensatz zum Daten-Typ "Line/ Zeile" beispielsweise).
=== {{Anker|template}} {{int:templatedata-doc-param-type-wiki-template-name}} ===
Der Bezeichner einer [[Hilfe:Vorlagen|Vorlage]] ''ohne'' vorangestelltes <code>Vorlage:</code>.
=== {{Anker|string}} {{int:templatedata-doc-param-type-string}} ===
Eine längere Zeichenkette. Möglicherweise ist [[Wikitext]]-Formatierung nicht erwünscht; siehe dazu „[[#wikitext|{{int:templatedata-doc-param-type-content}}]]“.
=== {{Anker|line}} {{int:templatedata-doc-param-type-line}} ===
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 „[[#wikitext|{{int:templatedata-doc-param-type-content}}]]“ angegeben worden.
Es wird nur ein einzeiliges Eingabefeld angezeigt, und die Eingabe wird in einer einzigen Zeile in den Quelltext zurückgeschrieben.
== {{Anker|aliases}} Aliasnamen von Parametern ==
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.
== {{Anker|optMand}} Optionale und Pflichtparameter ==
Für die Erfordernis von Parameterangaben gibt es vier Stufen:
# ''{{int:templatedata-doc-param-status-required}}''
#* 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.
# ''{{int:templatedata-doc-param-status-suggested}}''
#* 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.
# ''{{int:templatedata-doc-param-status-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.
# ''{{int:templatedata-doc-param-status-deprecated}}''
#* 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 „{{int:templatedata-doc-param-default}}“ und ggf. auch ein „{{int:templatedata-doc-param-example}}“ angegeben sein. In der Vorlage wird „{{int:templatedata-doc-param-default}}“ verwendet, falls kein Wert ausdrücklich angegeben ist.
== {{Anker|layout}} Quelltext-Layout ==
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 [[Wikipedia:Lua/Modul/TemplateData/Wikitext|Erweiterung in der deutschsprachigen Wikipedia]] ermöglicht weitere menschenfreundlichere Schlüsselwörter.
* Freie Vereinbarung von Leerzeichen und Zeilenumbruch durch spezielle Codes wie <code style="white-space:nowrap"><nowiki>{{_\n| _=_\n}}</nowiki></code>
** Dieser Hinweis ist eher an Vorlagenprogrammierer adressiert.
** Siehe [[../JSON#layout|JSON-Spezifikation]] zu Einzelheiten.
<noinclude>
[[Kategorie:Hilfe:Vorlagen]]
</noinclude>
Dieses Hilfeseite erläutert Wikipedia-Autoren die Bedeutung von Datentypen und Wertformatierungen, die in den Dokumentationsseiten zu [[Hilfe:Vorlagen|Vorlagen]] erwähnt werden, insbesondere wenn dabei '''[[Hilfe:TemplateData|TemplateData]]''' verwendet wird. Die '''Anwendung''' einer bestimmten Vorlageneinbindung soll dadurch erleichtert werden.
== Datentypen einzelner Parameter ==
=== {{Anker|user}} {{int:templatedata-doc-param-type-wiki-user-name}} ===
Der Nickname eines registrierten Benutzers ''ohne'' vorangestelltes <code>Benutzer:</code>.
Gelegentlich käme auch die IP-Adresse nicht angemeldeter Benutzer in Frage.
=== {{Anker|boolean}} {{int:templatedata-doc-param-type-boolean}} ===
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 <code>nein</code> oder <code>0</code> usw.
* Der [[Hilfe:VisualEditor|VisualEditor]] schreibt und versteht in einer international üblichen Form:
** <code>1</code> – „ja“ (und alle sonstigen Werte)
** <code>0</code> – „nein“
** ''leer'' – jeweiliger Vorgabewert
* Manche Vorlagen erwarten ausdrücklich bestimmte Zeichenketten; verstehen alle anderen Werte falsch: Es müsse <code>ja</code> oder woanders <code>JA</code> oder bei einer anderen Vorlage <code>Ja</code> oder bei einer weiteren ausdrücklich <code>nein</code> heißen.
* Moderne Vorlagenprogrammierungen sind robust und „verstehen“ unterschiedliche Werte sinngemäß.
=== {{Anker|file}} {{int:templatedata-doc-param-type-wiki-file-name}} ===
Der Bezeichner einer Mediendatei ''ohne'' vorangestelltes <code>Datei:</code>.
Es ist unzulässig, hieran Parameter für eine Einbindung anzuhängen (mittels maskierter Pipe-Symbole).
=== {{Anker|date}} {{int:templatedata-doc-param-type-date}} ===
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ünschte Format sollte immer explizit angegeben sein:
* Standardformate des Projekts:
** <code>{{LOCALDATE}}</code> – ortsübliche Darstellung wie auch für Leser.
** <code>{{#time:Y-m-d}}</code> – [[ISO 8601|ISO-Format]] ''JJJJ-MM-TT'': Gut sortierbar, mittels [[Hilfe:Suche/Cirrus|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 ''<span style="white-space:nowrap">{{LOCALDATE}}</span>'' 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.
=== {{Anker|wikitext}} {{int:templatedata-doc-param-type-content}} ===
Beliebiger [[Wikitext]] ist zulässig. Allerdings sollte er eine syntaktische Einheit bilden. Öffnende Elemente (z. B. eckige Klammern) sollen also wieder geschlossen werden.
=== {{Anker|number}} Nummer (Zahl) ===
Eine Zahl, wobei das Zahlenformat aber von Vorlage zu Vorlage abweichen kann. In Frage kommen:
* <code>12345678,9</code> – ortsübliche Darstellung, jedoch ohne [[Tausendertrennzeichen]], mit Komma <code>,</code> als [[Dezimaltrennzeichen]].
* <code>12345678.9</code> – Computer-geeignetes (internationales) Format, mit Punkt <code>.</code> als Dezimaltrennzeichen, ohne Tausendertrennzeichen.
* <code>12.345.678,9</code> – ortsüblich, Tausendertrennzeichen erlaubt.
* ''ggf. weitere''
Siehe dazu auch: [[Wikipedia:Schreibweise von Zahlen]]
Ein [[American Standard Code for Information Interchange|ASCII]]-Minuszeichen <code>-</code> („Bindestrich“) ist in der Regel unproblematisch, wenn dies auch inhaltlich sinnvoll ist.
=== {{Anker|page}} {{int:templatedata-doc-param-type-wiki-page-name}} ===
Der [[Hilfe:Seitenname|Name einer Seite]], womöglich auch in einem anderen Projekt ([[Hilfe:Interwiki-Links|Interwiki]]).
In der Regel wird gewünscht und sinnvoll sein, eine bereits existierende Seite anzugeben; das ist jedoch keine zwingende Voraussetzung.
=== {{Anker|lang}} Sprachen ===
Gelegentlich kommen als Parameter menschliche Sprachen (also keine Programmiersprachen usw.) vor.
Oft werden dabei [[Wikipedia:Technik/MediaWiki/Sprachen|Sprachcodes]] erwartet. Das hat folgende Gründe:
* Sie lassen sich einheitlich auswerten (<code>nl</code> 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:
{|
|-
|
* <code>de</code> – {{deS}}
* <code>de-AT</code> – [[{{#language:de-AT}}]]
* <code>de-CH</code> – [[{{#language:de-CH}}]]
|style="padding-left:2em"|
* <code>en</code> – {{enS}}
* <code>fr</code> – {{frS}}
* <code>es</code> – {{esS}}
|}
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.
=== {{Anker|url}} {{int:templatedata-doc-param-type-url}} ===
Eine syntaktisch gültige [[Uniform Resource Locator|URL]] – Leerzeichen können also nicht enthalten sein. Einklammern als Weblink ist hier nicht erlaubt (im Gegensatz zum Daten-Typ "Line/ Zeile" beispielsweise).
=== {{Anker|template}} {{int:templatedata-doc-param-type-wiki-template-name}} ===
Der Bezeichner einer [[Hilfe:Vorlagen|Vorlage]] ''ohne'' vorangestelltes <code>Vorlage:</code>.
=== {{Anker|string}} {{int:templatedata-doc-param-type-string}} ===
Eine längere Zeichenkette. Möglicherweise ist [[Wikitext]]-Formatierung nicht erwünscht; siehe dazu „[[#wikitext|{{int:templatedata-doc-param-type-content}}]]“.
=== {{Anker|line}} {{int:templatedata-doc-param-type-line}} ===
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 „[[#wikitext|{{int:templatedata-doc-param-type-content}}]]“ angegeben worden.
Es wird nur ein einzeiliges Eingabefeld angezeigt, und die Eingabe wird in einer einzigen Zeile in den Quelltext zurückgeschrieben.
== {{Anker|aliases}} Aliasnamen von Parametern ==
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.
== {{Anker|optMand}} Optionale und Pflichtparameter ==
Für die Erfordernis von Parameterangaben gibt es vier Stufen:
# ''{{int:templatedata-doc-param-status-required}}''
#* 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.
# ''{{int:templatedata-doc-param-status-suggested}}''
#* 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.
# ''{{int:templatedata-doc-param-status-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.
# ''{{int:templatedata-doc-param-status-deprecated}}''
#* 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 „{{int:templatedata-doc-param-default}}“ und ggf. auch ein „{{int:templatedata-doc-param-example}}“ angegeben sein. In der Vorlage wird „{{int:templatedata-doc-param-default}}“ verwendet, falls kein Wert ausdrücklich angegeben ist.
== {{Anker|layout}} Quelltext-Layout ==
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 [[Wikipedia:Lua/Modul/TemplateData/Wikitext|Erweiterung in der deutschsprachigen Wikipedia]] ermöglicht weitere menschenfreundlichere Schlüsselwörter.
* Freie Vereinbarung von Leerzeichen und Zeilenumbruch durch spezielle Codes wie <code style="white-space:nowrap"><nowiki>{{_\n| _=_\n}}</nowiki></code>
** Dieser Hinweis ist eher an Vorlagenprogrammierer adressiert.
** Siehe [[../JSON#layout|JSON-Spezifikation]] zu Einzelheiten.
<noinclude>
[[Kategorie:Hilfe:Vorlagen]]
</noinclude>