Template:Tpn/doc

From Iron Chariots Wiki
Revision as of 17:04, 3 August 2008 by Dcljr (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Template:Tpn
Purpose
Formats text in monospace type (equivalent to the wiki syntax <tt>...</tt>). This template is intended only to be used in template documentation to format "named" parameters in explanatory text just as they appear in usage examples formatted using Template:T and Template:Tl.
Mnemonic
The template name Tpn stands for "Template parameter (named)".
Usage
{{tpn|parameter name}}
{{tpn|parameter name{{equals}}value}}
Note
In the second usage form above, the {{equals}} template must be used instead of a raw equals symbol (=), so the expression won't be interpreted as assigning the value value to the parameter parameter name. An equals symbol will appear in the output, as seen in the examples below.
Examples
  • Use the named parameter {{tpn|suggest}} to...
    → Use the named parameter suggest to...
  • Use "{{tpn|suggest{{equals}}''changes''}}" to...
    → Use "suggest=changes" to...
  • Use "{{tpn|suggest{{equals}}add links}}" to...
    → Use "suggest=add links" to...
See also
Personal tools
Namespaces
Variants
Actions
wiki navigation
IronChariots.Org
Toolbox