Template:Samp/doc

This is a documentation subpage for Template:Samp.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  

Purge base's cache

This template was ported from a template from Wikipedia, then modified. It was originally at Template:Samp/doc. The original authors of this template are shown on the template's edit history page.
This template's documentation was also ported from Wikipedia, originally from Template:Samp/doc/doc. The original authors of the documentation are shown on the documentation's edit history page.
Wikipedia's text is available under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

Purpose

This template is for explicitly indicating that the content inside it represents example output from a computer program or other machine source (automated attendant/interactive voice response call system, exit code of an application, standard output, LCD display, etc.) It uses the [X]HTML element <samp>...</samp> (sample output) which exists for this purpose, and applies some styling to it, namely a faint greying out of the text color to visually difference it from source code and input. It retains the default monospaced (non-proportional) font style of the <samp> element. Because it uses <samp>...</samp> 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 {{Kbd}}, which is for example input.

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 output 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 output is not a part of source code, but something that results from it; however, this style can be used to illustrate computer display of mixed type, as illustrated below).

For cases where it is useful to display the color of the output, there is an optional parameter |color= that takes an HTML color name or #nnnnnn color code (in which case the # is mandatory). For accessibility reasons, color should never be the only distinguishing factor, as foo and foo may be indistinguisahble to color-blind readers.

There may also be cases where some other aspect of the output may need to be reproduced; the |style= parameter accepts any complete CSS statement(s), terminating with a semicolon, e.g. |style=font-variant:small-caps; font-style:italic;.

Examples:

• {{Samp|1=[A]bort, [R]etry, [F]ail?}}: "The error message [A]bort, [R]etry, [F]ail? has been cited as notoriously user-unfriendly."
• {{Samp|%}} with {{kbd|1=ssh {{var|hostname}}}}: "At the % prompt, the user must enter ssh hostname."
• {{Samp|Error|color=red}}, to indicate output color: On failure, the Error light activates.
• {{Samp|Error|color=red|style=font-variant:small-caps;}}, for more customization: On failure, the Error light activates.