Zum Inhalt springen

Vorlage:Key press/Doku

Aus Wikivoyage

Funktion

[Bearbeiten]

Die Vorlage {{key press}} dient der Illustration von Tastendrücken in Hilfeartikeln. Sie kann auch die Tastenkombinationen darstellen.

Verwendung

[Bearbeiten]

Einfacher Tastendruck

[Bearbeiten]

{{key press|A}} ergibt: A

Tastenkombinationen

[Bearbeiten]

Bei Tastenkombinationen kann man einfachhe weitere Parameter ergänzen:

{{key press|Alt|P}} ergibt: Alt+P
{{key press|Ctrl|Alt|Del}} ergibt: Ctrl+ Alt+ Del

Es können bis zu 10 Tastenbezeichnungen übergeben werden. Das sollte mehr sein, als man mit zwei Händen gleichzeitig drücken kann. Wird ein elfter Parameter übergeben, landet die Seite in der Wartungskategorie Vorlage Key press mit zu vielen Parametern.

Wenn man mehrere Tastenbezeichnungen eingibt, wird ein „+“ (oder der Inhalt des optionalen Parameters chain) ohne Leerzeichen angehängt. Das bedeutet, dass es keinen Zeilenumbruch gibt. Wenn man aber Tastenkombinationen z.B. in einer Tabelle anzeigen möchte, kann das zu breiten Einträgen führen. Erstelle stattdessen die Tastenkombination manuell mit Leerzeichen um das „+“ herum, damit es einen Zeilenumbruch gibt:

{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}} ergibt Ctrl + Alt + Del
{{key press|Ctrl|Alt|Del|chain= + |}} ergibt Ctrl + Alt + Del

Zur Veranschaulichung der Windows-Alt-Codes sollteman hingegen separate Vorlagen ohne dazwischen liegende Satzzeichen oder Leerzeichen verwenden. Bei den meisten Windows-Systemen in Nordamerika und Westeuropa kann beispielsweise das Plus-Minus-Zeichen (±) eingegeben werden, indem man die Alt-Taste gedrückt hält, während man Folgendes auf dem numerischen Tastenfeld eingibt: 0177:

{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}} ergibt Alt+0177

Ein Beispiel für einen Anwendungsfall, in dem mehr als 5 Tasten verwendet werden könnten, ist die Erläuterung der Verwendung eines Makros (Tastaturkürzel), das von einer Drittanbieteranwendung erstellt wurde:

{{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}} produces Ctrl+ Alt+ Shift+ Win+ Menu+Fn+L
[Bearbeiten]

If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:

  • {{key press|[[Alt key|Alt]]}} produces Alt

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. [[Control key|Ctrl]] instead of [[Ctrl]], which leads to a disambiguation page).

Wiki markup characters

[Bearbeiten]

Some wiki markup character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}, {{;}} and {{=}} templates:

  • {{key press|{{!}}}} produces |
  • {{key press|{{;}}}} produces ;
  • {{key press|{{=}}}} produces =

However, if the characters are marked as wikilinks, they can be entered as such:

  • {{key press|[[|]]}} produces |
  • {{key press|[[;]]}} produces ;
  • {{key press|[[=]]}} produces =

Most markup characters also have aliases:

  • {{key press|pipe}} produces |
  • {{key press|semicolon}} produces ;
  • {{key press|equals}} produces =
  • {{key press|colon}} produces :
  • {{key press|asterisk}} produces *
  • {{key press|hash}} produces #

If you do not want to mark the characters as links, {{key press|<nowiki>|</nowiki>}} is also an option.

Key symbols

[Bearbeiten]

Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names:

  • {{key press|Shift}} produces Shift
  • {{key press|Caps Lock}} produces Caps Lock
  • {{key press|Enter}} produces Enter
  • {{key press|Tab}} produces Tab
  • {{key press|Backspace}} produces Backspace
  • {{key press|Cmd}} produces Cmd
  • {{key press|Opt}} produces Opt
  • {{key press|Up}} produces
  • {{key press|Down}} produces
  • {{key press|Left}} produces
  • {{key press|Right}} produces
Windows key and Menu key
Old-style Windows key

There are no characters for the Windows key and Menu key. Besides, the Windows logo is trademarked. So this template shows approximate characters for them in the following way:

  • {{key press|Win}} produces Win
  • {{key press|Menu}} produces Menu

Video games

[Bearbeiten]

Video game controllers often have specialized input labels that do not map easily. The following are mappings for various game consoles and input features.

Directional input
[Bearbeiten]

The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices.

  • {{key press|l-down}} produces L↓
  • {{key press|c-left}} produces C←
  • {{key press|r-up}} produces R↑

Stick specific diagonals are also supported:

  • {{key press|l-nw}} produces L↖
  • {{key press|c-se}} produces C↘
  • {{key press|r-ne}} produces R↗
PlayStation
[Bearbeiten]
  • {{key press|ex}} produces ×
  • {{key press|circle}} produces
  • {{key press|triangle}} produces
  • {{key press|square}} produces


Technical details

[Bearbeiten]

This template calls {{key press/core}}, which holds the code that otherwise would be repeated several times in {{key press}}, thus simplifying the code.

TemplateData

[Bearbeiten]

Illustrates keys and keystrokes on a computer keyboard. Keys can include: Ctrl, Alt, Del, Opt, Menu, Left etc. console keys: ex, circle, triangle, square, and left right and center analog sticks: l-down, c-left, r-ne. The names are case insensitive.

Vorlagenparameter[Vorlagendaten bearbeiten]

ParameterBeschreibungTypStatus
First key1

First key

Einzeiliger Texterforderlich
Second key2

Optional key press in combination as the first.

Einzeiliger Textoptional
Third key3

Optional key press in combination as the first.

Einzeiliger Textoptional
Forth key4

Optional key press in combination as the first.

Einzeiliger Textoptional
Fifth key5

Optional key press in combination as the first.

Einzeiliger Textoptional
Sixth key6

Optional key press in combination as the first.

Einzeiliger Textoptional
Seventh key7

Optional key press in combination as the first.

Einzeiliger Textoptional
Eighth key8

Optional key press in combination as the first.

Einzeiliger Textoptional
Ninth key9

Optional key press in combination as the first.

Einzeiliger Textoptional
Tenth key10

Optional key press in combination as the first.

Einzeiliger Textoptional
Chaining characterchain

Character between chained key presses

Standard
+
Einzeiliger Textoptional
Chaining characterchain first

Character between first and second key to press

Standard
+
Einzeiliger Textoptional
Chaining characterchain second

Character between second and third key to press

Standard
+
Einzeiliger Textoptional
Chaining characterchain third

Character between third and fourth key to press

Standard
+
Einzeiliger Textoptional
Chaining characterchain fourth

Character between fourth and fifth key to press

Standard
+
Einzeiliger Textoptional

See also

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

Not to be confused with

[Bearbeiten]
  • {{MediaWiki-Button}} – Produces a similar visual effect, but without the semantic markup, e.g. .