Difference between revisions of "Template:Doc"

From Frontiers of the Void
Jump to: navigation, search
(Created page with "{{Documentation subpage}} <!-- DO NOT move the "pp-template" to the template page since the ! template should be as short as possible to save server load (to not break templat...")
 
(No difference)

Latest revision as of 19:22, 30 July 2014

Template:Documentation subpage Template:High-risk


Usage

This is the Template:Tn meta-template. Its use is analogous to an escape character.

This is an auxiliary template allowing the encoding of "|" within template parameters, because the pipe character is normally interpreted as a separator. This template is necessary if the character is used in wiki table syntax, or if the parameter is automatically wikilinked and you wish to use a pipe to specify different link text from the target page name. In other cases it is better to use "&#124;".

This template cannot be used for putting the character as text in a wiki table; in that case, again, "&#124;" can be used.

Note that no special template is needed for "!" (exclamation mark).

This is a high-risk template, and it usually cannot be substituted (see conditions for substing on the section below).

Substitution

It is possible to substitute {{!}} only if an unescaped "|" works as expected, i.e. after substituting the template containing {{!}}, or after eliminating an #if containing {{!}}.

A simple example

The following template code for Template:Tl using an ordinary pipe character,

  • {{Quotation|It is not possible to use an ordinary pipe character | in template parameters, as it will be interpreted as a separator.|[[Help:Template#Usage hints and workarounds]]}}

produces: Template:Quotation

whereas this code using the {{!}} meta-template,

  • {{Quotation|It is not possible to use an ordinary pipe character {{!}} in template parameters, as it will be interpreted as a separator.|[[Help:Template#Usage hints and workarounds]]}}

produces: Template:Quotation

See also


ar:قالب:!/شرح as:সাঁচ:!/doc cs:Šablona:!/doc de:Vorlage:!/Doku es:Plantilla:!/doc fr:Modèle:!/Documentation or:ଟେମ୍ପଲେଟ:!/doc ro:Format:!/doc ru:Шаблон:!/doc