Teamplaid:kbdnowiki/documentation

This is a documentation subpage for Teamplaid:kbdnowiki.
It contains usage information, categories and other content that is not part of the original teamplaid page.

This template should always be substituted (i.e., use {{subst:kbdnowiki/documentation}}).

Shortcut {{kbno}}

Ùsaid - Usage

[deasaich]

This template wraps text in <kbd><nowiki>...</nowiki></kbd> markup. To work correctly, it must be substituted.

Eisimpleir - Example

[deasaich]

Markup:

{{subst:kbdnowiki|Some text and a {{convert|179+1/2|ft|1|adj=on|sp=us}} template.}}

Renders as:

Some text and a {{convert|179+1/2|ft|1|adj=on|sp=us}} template.

Faic cuideachd - Also see

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, {{Varserif}} should be used to ensure a noticeable distinction
`{{Varserif}}`	`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
`{{Tlx}}` etc.	{{Template\|`1`\|`2`\|...\|`10`}}	To display a template call (with or without parameters and values) as code
`{{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 `someMethod`
`{{subst:codenowiki}}`	`{{Small\|small text}}`	To wrap example code in `<code><nowiki>...</nowiki></code>`
`{{subst:kbdnowiki}}`	`{{big\|big 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 {{Deprecated code}} ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{Dc2}} variant uses strike-through (`<blink>`) while {{Dcr}} uses red (`<blink>`).
`{{Pre}}`	_{[this is a block template]}	For larger blocks of source code and other Pre-formatted text
`{{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
`{{PlayStation key press}}`	`□`	To indicate PlayStation-style gamepad key presses
`{{Button}}`	`Don't save`	To indicate a button in a user interface
`{{Samp}}`	`example output`	To indicate sample or example output