Zum Inhalt springen

Vorlage:Para/Doku

Aus Wikivoyage

Funktion

[Bearbeiten]

Die Vorlage erleichtert die Dokumentation von Vorlagen. Mit Hilfe der Vorlage können Parameter auf einfache Weise formatiert werden.

Verwendung

[Bearbeiten]
  1.   {{para|name}}
    wird dargestellt als
    |name=
  2.   {{para|title|<var>book title</var>}}
    wird dargestellt als
    |title=book title
  3.   {{para| |section}}
    wird dargestellt als
    |section
    für namenlose Parameter im Beispielcode. Beachte den leeren ersten Parameter in der Verwendung der Vorlage.
  4.   {{para|<var>parameter</var>|<var>value</var>}}
    wird dargestellt als
    |parameter=value

Siehe auch

[Bearbeiten]
Vorlagen
[Bearbeiten]

Die 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>