Zum Inhalt springen

Vorlage:Em/Doku

Aus Wikivoyage

Funktion

[Bearbeiten]

Diese Vorlage bietet die Möglichkeit, Textpassagen zu betonen und diese Information für externe Programme (Vorlesefunktion, Robots usw.) verfügbar zu machen.Dabei wird aucf das [X]HTML's-Tag <em>...</em> zurückgegriffen welches für die Betonung (englisch: Emphasis) von Text zuständig ist. Das gängige Wiki-MArkup zu Kursivschreibung ist für diesen Zweck ungeeignet. Hervorhebungen werden in grafischen Browsern in der Regel in einer kursiven (schrägen) Schriftart dargestellt, können aber mit Style Sheets, Anwendungen und Text-to-Speech-Screenreadern auf anpassbare Weise geparst und verarbeitet werden. Es handelt sich um semantisches Markup, d. h. Markup, das Bedeutung oder Kontext vermittelt, nicht nur visuelles Aussehen. Einfache Kursivierung ist rein typografisch und semantisch bedeutungslos. Sie wird am häufigsten für Titel von Veröffentlichungen (Bücher, Filme, Alben usw.), Fremdwörter und -sätze), Fremdwörter und -sätze, words as words (wenn die Anführungszeichen nicht für diesen Zweck verwendet werden), Schiffsnamen, Wissenschaftliche Namen von Organismen und andere Fälle, in denen stilistische Konventionen Kursivschrift verlangen, diese aber keine Betonung vermittelt.

Verwendung

[Bearbeiten]
{{em|zu betonender Text}}

oder, wenn der zu betonende Text ein Gleichheitszeichen enthält:

{{em|1=zu betonender Text}}

Diese werden beide folgendermaßen ausgegeben:

zu betonender Text

Diese Vorlage setzt absichtlich und ausdrücklich das <em>...</em> (Hervorhebung) [X]HTML-Tag um den als ersten Parameter angegebenen Text. Am sichersten ist es, immer die Syntax |1= zu verwenden.

Optionale Parameter

[Bearbeiten]

Erweiterte HTML-Werte können über die Vorlage an den HTML-Code übergeben werden:

  • |class= fügt einen Klassennamen (oder mehrere Klassennamen, getrennt durch Leerzeichen); fügt class="classname[s]" im HTML-Code ein
  • |title= nimmt Text, der nicht in irgendeiner Weise gekennzeichnet werden kann, und zeigt ihn als Pop-up-Tooltip (in den meisten Browsern) an, wenn der Mauszeiger über den Bereich bewegt wird

Anwendungsfälle

[Bearbeiten]

Diese Vorlage dient dazu, in wichtiges Wort oder einen wichtigen Satz in einer Passage auf eine Weise zu betonen, und die (im Gegensatz zur einfachen Kursivierung) semantisch korrektes Markup erzeugt.. Mit dieser Technik hebt sich der hervorgehobene Text in den meisten, wenn nicht sogar in allen visuellen Browsern und einigen Text-to-Speech-Screenreadern (die in der Regel die rein typografische Kursivierung ignorieren) vom übrigen Text ab, ohne die Lesbarkeit stark zu beeinträchtigen. Außerdem kann sie von User-Agents und anderer Software als eindeutiger Hinweis auf eine Betonung und nicht nur auf einen typografischen Fettdruckeffekt um des Aussehens willen interpretiert werden. Es sollte daher in Artikeln nur sparsam verwendet werden, um etwas zu betonen (z. B. um eine starke stimmliche Betonung darzustellen). Beispiel:

  • „Entgegen den Berichten war sie {{em|nicht}} tot.“
  • „Entgegen den Berichten war sie nicht tot.“

Keine Anwendungsfälle

[Bearbeiten]

Da {{em}} ausschließlich zur semantischen (sinnvollen) Hervorhebung dient, sollte es nicht für Layout, typografische Konventionen (Titel, Fremdwörter usw.) und andere Fälle verwendet werden, die keine echte Hervorhebung sind. In diesen verschiedenen Fällen sollte stattdessen das Wiki-Markup für kursiv ''...'' (das im Browser oder einem anderen Benutzer-Agenten zu <i>...</i> aufgelöst wird) verwendet werden (oder spezielle Markierungen für einen bestimmten Fall, wie {{tlx|var|...}} oder <var>...</var> für Variablen in der Vorlagendokumentation). Es sollte auch nicht verwendet werden, wenn der Text, auf den es angewendet wird, bereits aus einem anderen Grund kursiv ist (z. B. als Teil eines Buchtitels); in solchen Fällen verwende lieber {{strong}}. Vermeide in der Regel die Verwendung von {{em}} in nicht zitierten Sätzen, die mit einem Ausrufezeichen enden. Und es ist in der Regel übertrieben, es bei Begriffen zu verwenden, die bereits mit einem Wikilink versehen sind, da die Linkauszeichnung selbst als eine Form der Hervorhebung fungiert.

Siehe auch

[Bearbeiten]
Projektseiten
[Bearbeiten]
Hilfeseiten
[Bearbeiten]
  • Textgestaltung – Eine Anleitung, wie man Teile von Artikeln mit Mitteln der Wikisoftware und ihres Markups formatiert.
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>