Yiɣi chaŋ yɛligu maŋamaŋa puuni

Tɛmplet:Kbd/doc

Pahimi soya
Diyila Dagbani Wikipedia
Shortcuts

Purpose

[mali mi di yibu sheena n-niŋ]
See also: Template:Key press

This template is for explicitly indicating that the content inside it represents input from a keyboard or other source (speech recognition software, standard input, etc.) It uses the [X]HTML element <kbd>...</kbd> (keyboard input) which exists for this purpose, and applies some styling to it, namely a faint grey background (borrowed from the related template {{key press}}) and slight CSS letter-spacing to suggest individually entered characters. It retains the default monospaced (non-proportional) font style of the <kbd> element. Because it uses <kbd>...</kbd> instead of simply applying visual style effects, it is semantic markup that conveys meaning, and it can be further acted upon by the user agent (e.g. with custom local style sheets). This tag is the exact opposite of {{samp}}, which is for example output.

Usage

[mali mi di yibu sheena n-niŋ]

The template takes one mandatory parameter, the content to be marked up. If this content contains "=" (an equals sign), the parameter must be explicitly named |1=, or the template will fail. (This is a limitation of the MediaWiki software, not the template.) It is always safer to use |1= syntax. It may be used as a container for {{var}}, {{varserif}} or <var>...</var> when the example keyboard input contains or consists entirely of a variable. It may also be used with (but not inside) {{code}}, or with <code>...</code> (it generally should not be used inside the latter, as input is not a part of source code, but something that interacts with it; however, this style can be used to illustrate computer display of mixed type, as illustrated below).

There is an optional parameter | (or | or any other value), to get rid of the slight letter spacing, which can look awkward on long passages of input.

Examples:

  • {{kbd|71077345}}: "Entering 71077345 on a calculator and turning it upside down appears to spell ShellOil."
  • {{kbd|1=ssh {{var|hostname}}}} with {{samp|%}}: "At the % prompt, the user must enter ssh hostname."
  • {{kbd|1=ssh {{var|hostname}}}} with {{samp|%}} and {{key press|Enter}}: "At the % prompt, the user must input ssh hostname↵ Enter."
  • Inside <code>...</code>: "The commandline should read: % ssh hostname (where hostname is the IP address or domain name of the system to connect to); if this is correct, press ↵ Enter."
  • {{kbd|1={{lorem ipsum span}}|spacing=0}} to get rid of the spacing: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Some of these examples may look slightly different outside this documentation, because the default background color varies by page type (articles are stark white, template documentation pale green, most other pages very pale grey). In-article example:

  • {{kbd|71077345}}: "Entering 71077345 on a calculator and turning it upside down appears to spell ShellOil."
  • {{kbd|1=ssh {{var|hostname}}}} with {{samp|%}}: "At the % prompt, the user must enter ssh hostname."
  • {{kbd|1=ssh {{var|hostname}}}} with {{samp|%}} and {{key press|Enter}}: "At the % prompt, the user must input ssh hostname↵ Enter."
  • Inside <code>...</code>: "The commandline should read: % ssh hostname (where hostname is the IP address or domain name of the system to connect to); if this is correct, press ↵ Enter."
  • {{kbd|1={{lorem ipsum span}}|spacing=0}} to get rid of the spacing: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
v · d · m
Semantic markup templates
Template  Example output  Use 
{{strong}} Important! To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad}} "Tɛmplet:Strongbad use ..." Same as {{strong}} but in red
{{stronggood}} "Tɛmplet:Stronggood use ..." Same as {{strong}} but in green
{{em}} "An emphatic phrase" To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var}} strPrefix To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif}} Tɛmplet:Var serif (see {{var}} above)
{{tld}} {{DEFAULTSORT:Y, X}} To display wikicode variables and magic words as they would appear in code
{{para}} |year=2008 To display template parameters with or without values
{{param}} {{{title|alt}}} To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{tjp}} Tɛmplet:Tjp To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)
{{param value}} Tɛmplet:Pvalue To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx}} etc. {{Template|1|2|...|10}} To display a template call (with or without parameters and values) as code
{{tji}} {{hatnote|Hello|selfref=yes|category=no}} To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}} "The <img>...</img> tags ..." To render HTML elements ("tags") in prose
{{code}}/{{codett}} "Ensure the alt= parameter ..." To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: someMethod becomes Tɛmplet:Codett
{{subst:codenowiki}} {{small|small text}} To wrap example code in <code><nowiki>...</nowiki></code>
{{subst:kbdnowiki}} {{large|large text}} To wrap example code in <kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight}}     [this is a block template] ( or {{sxhl}} )  Wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text
{{deprecated code}} "Do not use <blink>." ( or {{dc}} )  To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (<Tɛmplet:Dc2>) while {{dcr}} uses red (<Tɛmplet:Dcr>).
{{pre}}     [this is a block template] For larger blocks of source code and other pre-formatted text
{{tj}}
{{hatnote
| Hello
| selfref = yes
| category = no
}}
 To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{quote}}     [this is a block template] For block quotations (only – never for non-quotations)
{{block indent}}     [this is a block template] For indented blocks of material; visually identical to {{quote}} but without quote markup
{{kbd}} user input To indicate user input
{{key press}} Ctrl+x To indicate specific-keystroke input, including combinations
{{key top}} Left shift Similar; includes more symbols, but does not directly support combinations
{{button}} Don't save To indicate a button in a user interface
{{samp}} example output To indicate sample or example output


Di yila "https://dag.wikipedia.org/w/index.php?title=Tɛmplet:Kbd/doc&oldid=71360"