Template:Kbd: Difference between revisions

user input

Template documentation[view] [edit] [history] [purge]

{{type}}
{{input}}

Purpose

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

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 hostnameScript error: No such module "key".."
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 Script error: No such module "key".."
{{kbd|1={{lorem ipsum span}}|spacing=0}} to get rid of the spacing: Template:Lorem ipsum span

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 hostnameScript error: No such module "key".."
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 Script error: No such module "key".."
{{kbd|1={{lorem ipsum span}}|spacing=0}} to get rid of the spacing: Template:Lorem ipsum span

Page Template:Var serif/styles.css has no content.

Semantic markup templates

Template Example output Use

{{strong}} Important! To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing

{{strongbad}} "Never use ..." Same as {{strong}} but in red

{{stronggood}} "Only 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}} strIllustratePrefix (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}} |selfref=yes To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)

{{param value}} ··2·blanks·fore·and·aft·· 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

This template is used on 24,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Usage

Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.

The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:

Template loop detected: Template:Code

However, {{code|a {{template}} call}} will still invoke the template:

Template loop detected: Template:Code

Use <nowiki>...</nowiki> around the template name to avoid this problem:

Template loop detected: Template:Code

When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

Template loop detected: Template:Code

is well spaced:

foo Template loop detected: Template:Code quux.

versus:

Template loop detected: Template:Code

which is going to be visually confusing for many:

foo Template loop detected: Template:Code quux.

because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.

Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.

This template does not need to be substituted.

Examples

Markup	Renders asScript error: No such module "For loop".

Included templates

Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Markup	Renders asScript error: No such module "For loop".

The above example shows the HTML rendered by the citation template, including the hidden metadata.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Kbd

Script error: No such module "Format TemplateData".

Usage

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.

Template loop detected: Template:Code

However, {{code|a {{template}} call}} will still invoke the template:

Template loop detected: Template:Code

Use <nowiki>...</nowiki> around the template name to avoid this problem:

Template loop detected: Template:Code

When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

Template loop detected: Template:Code

is well spaced:

foo Template loop detected: Template:Code quux.

versus:

Template loop detected: Template:Code

which is going to be visually confusing for many:

foo Template loop detected: Template:Code quux.

This template does not need to be substituted.

Examples

Markup	Renders asScript error: No such module "For loop".

Included templates

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Markup	Renders asScript error: No such module "For loop".

The above example shows the HTML rendered by the citation template, including the hidden metadata.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Kbd

Script error: No such module "Format TemplateData".

Usage

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.

Template loop detected: Template:Code

However, {{code|a {{template}} call}} will still invoke the template:

Template loop detected: Template:Code

Use <nowiki>...</nowiki> around the template name to avoid this problem:

Template loop detected: Template:Code

When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

Template loop detected: Template:Code

is well spaced:

foo Template loop detected: Template:Code quux.

versus:

Template loop detected: Template:Code

which is going to be visually confusing for many:

foo Template loop detected: Template:Code quux.

This template does not need to be substituted.

Examples

Markup	Renders asScript error: No such module "For loop".

Included templates

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Markup	Renders asScript error: No such module "For loop".

The above example shows the HTML rendered by the citation template, including the hidden metadata.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Kbd

Script error: No such module "Format TemplateData".

Usage

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.

Template loop detected: Template:Code

However, {{code|a {{template}} call}} will still invoke the template:

Template loop detected: Template:Code

Use <nowiki>...</nowiki> around the template name to avoid this problem:

Template loop detected: Template:Code

When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

Template loop detected: Template:Code

is well spaced:

foo Template loop detected: Template:Code quux.

versus:

Template loop detected: Template:Code

which is going to be visually confusing for many:

foo Template loop detected: Template:Code quux.

This template does not need to be substituted.

Examples

Markup	Renders asScript error: No such module "For loop".

Included templates

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Markup	Renders asScript error: No such module "For loop".

The above example shows the HTML rendered by the citation template, including the hidden metadata.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Kbd

Script error: No such module "Format TemplateData".

Usage

If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.

Template loop detected: Template:Code

However, {{code|a {{template}} call}} will still invoke the template:

Template loop detected: Template:Code

Use <nowiki>...</nowiki> around the template name to avoid this problem:

Template loop detected: Template:Code

When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

Template loop detected: Template:Code

is well spaced:

foo Template loop detected: Template:Code quux.

versus:

Template loop detected: Template:Code

which is going to be visually confusing for many:

foo Template loop detected: Template:Code quux.

This template does not need to be substituted.

Examples

Markup	Renders asScript error: No such module "For loop".

Included templates

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Markup	Renders asScript error: No such module "For loop".

The above example shows the HTML rendered by the citation template, including the hidden metadata.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Kbd

Script error: No such module "Format TemplateData".

Template:Kbd: Difference between revisions

Revision as of 16:25, 19 June 2023

Contents

Purpose

Usage

Usage

Examples

Included templates

TemplateData

See also

Usage

Examples

Included templates

TemplateData

See also

Usage

Examples

Included templates

TemplateData

See also

Usage

Examples

Included templates

TemplateData

See also

Usage

Examples

Included templates

TemplateData

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools