Vorlage:Var/Doku
Dies ist eine nachgeordnete Seite der Dokumentation von Vorlage:Var. Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Vorlage-Seite ist. |
Funktion
BearbeitenDiese Vorlage dient der Darstellung von Variablennamen (in Mathemathik, Programmcode, Wiki-Markup) mit dem semantisch korrekten Tag <var>...</var>
. Browser stellen dies standardmäßig kursiv dar. Dieses Tag wird benutzt, um z. B. künstliche und unbekannte Namen, Platzhalter, Variablen usw. auszugeben. Hier auf Wikivoyage dürfte sich die Benutzung auf die Beschreibung von und Hilfe für Vorlagen beschränken.
Verwendung
BearbeitenNeben dem eigentlichen Text können optional auch HTML-Attribute für das Tag übergeben werden.
{{Var|<auszugebender Text>|class=<Klasse(n)>|title=<Titel>|lang=<Sprache>}}
Für die Verwendung hier drüber wurde die Vorlage bereits genutzt. Das verwendete Markup sieht (auch infolge der Maskierung der Gleichheitszeichen) etwas sperrig aus:
{{Tlc|Var|<auszugebender Text>|{{Var|class{{=}}<Klasse(n)>}}|{{Var|title{{=}}<Titel>}}|{{Var|lang{{=}}<Sprache>}}}}
Beispiel
Bearbeiten{{Var|Variable}}
ergibt: Variable
Siehe auch
BearbeitenHilfeseiten
Bearbeiten- Textgestaltung – Eine Anleitung, wie man Teile von Artikeln mit Mitteln der Wikisoftware und ihres Markups formatiert.
Vorlagen
BearbeitenDie semantischen Vorlagen dienen der Kennzeichnung von Text. Der Text wird in spezielle HTML-Tags eingebettet, die die Bedeutung des Inhalts kennzeichnen. Browser, Robots und Werkzeuge für Barrierefreiheit können entsprechend darauf reagieren. Folgende semantische Vorlagen können in Wikivoyage-Artikeln eingesetzt werden:
- {{em}} – Die Vorlage kennzeichnet Text, der besonders betont werden soll. Browser stellen ihn im Regelfall kursiv dar.
- {{strong}} – Dient der starken Hervorhebung von Wörtern und Passagen. Die Darstellung erfolgt standardmäßig in Fettschrift.
In Artikeln außerhalb des Haupt- und Nachrichtennamensraums (Diskusssionen, Projekt- und Hilfeseiten) können weitere Vorlagen Anwendung finden:
- {{strongbad}} – Wie
{{strong}}
aber rot wie in dem Beispiel: „Benutze{{strongbad}}
niemals in Artikeln.“ - {{stronggood}} – Wie
{{strongbad}}
aber grün wie in dem Beispiel: „Benutze{{stronggood}}
nur außerhalb des Artikelnamensraums.“ - {{var}} – Zusammen mit {{varserif}} dient die Vorlage der Kennzeichnung und Visualisierung von Variablen bzw. Platzhaltern in Dokumentationen und Hilfetexten.
Die folgenden Vorlagen stellen lediglich eine Formatierungshilfe dar, erzeugen aber keine speziellen [X]HTML-Tags, um Inhalte maschinenlesbar eine Bedeutung zu geben.
- {{wikivar}} – Stellt Text als Magisches Wort dar und erleichtert damit die Dokumentation und Erstellung von Hilfeseiten. Beispiele:
{{PAGENAME}}
,{{DEFAULTSORT:Lastname, Firstname}}
. - {{para}} – Dient der Ausgabe von Vorlagenparametern (
|title=
) oder Parametern mit Werten (|year=2008
). - {{tlx}} and related – For displaying entire templates (with or without parameters and values) as code.
- {{tag}} – For using HTML elements ("tags") in prose (e.g. "When coding HTML
<img>...</img>
tags, always include …"). - {{code}} – For computer source code (e.g. "always include the
alt=
parameter"). (Note: to nest other templates like{{var}}
inside, use<code>...</code>
instead of{{code}}
.) - {{syntaxhighlight}} or {{sxhl}} – Wrapper for
<syntaxhighlight>...</syntaxhighlight>
, but will wrap overflowing text. - {{pre}} – For larger blocks of source code and other pre-formatted text.
- {{pre2}}, a template with similar functionality but induces optional line wrap and optional scroll bars.
- {{bq}} – For indented blocks of content, such as block quotations, examples, poems, etc.
- {{kbd}} – For indicating user input.
- {{key press}} – For indicating the input of specific keystrokes, e.g. ⎈ CtrlX.
- {{samp}} – For example output.
<syntaxhighlight>