This template doc page is closely interconnected with other templates or pages.
This template may:
Be closely connected to other templates, subtemplates, or modules
Have dependencies on config files or data files
Have dynamic documentation
Or otherwise be closely interconnected with other pages
You are encouraged to familiarize yourself with its setup, and with related files. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
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 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:
<code><nowiki>Here be code</nowiki></code>
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.
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
To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
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.
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
To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: someMethod becomes someMethod
( 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>).
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
