Template:Codenowiki

{{subst:dtag|nowiki|{{{1}}}}}

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

{{CoNo}}
{{Cnw}}

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here.

This template should always be substituted (i.e., use {{subst:Codenowiki}}). Any accidental transclusions will be automatically substituted by a bot.

Ignore the code appearing above; it is not how the final result will display

This template provides a speedy way to wrap template source code in <code><nowiki>...</nowiki></code> markup. To work correctly, it must be substituted.

Recommended use is:

{{subst:codenowiki |1=(code)}}

The 1= is often necessary so that that anything before an equals sign in the code isn't interpreted as a parameter name.

Example

{{subst:codenowiki |1=Here be code}} ... outputs: ... Here be code

The code produced by the template for this output is:

Embedded substitution

If the template is transcluded rather than substituted on a page, its output can be corrected by re-saving the page, triggering the substitution embedded within it:

{{subst:Nowiki|Here be code}}

Limitations

This template does not work with signatures. Typing {{subst:codenowiki|~~~~}} results in displaying your full signature's code.

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
{{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
{{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 `{{dc}}` ) 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

The above documentation is transcluded from Template:Codenowiki/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

Contents

Example

Embedded substitution

Limitations

See also

Navigation menu

Template:Codenowiki

Example

Embedded substitution

Limitations

See also

Navigation menu

Search