Difference between revisions of "Template:!/doc"

From Recidemia
Jump to: navigation, search
m (high risk)
 
m (1 revision)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+
<!-- 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 template inclusion limits). -->
{{high-risk|9,000+}}
+
{{high-risk|5,000,000+}}
 +
__NOTOC__
  
===Usage===
+
== Usage ==
This is an auxiliary template allowing to encode "<code>|</code>"
+
 
within template parameters. It is necessary if the character is used in wiki table syntax. In other cases it is better to use "<code>&amp;#124;</code>".  
+
This is the {{t<noinclude>n</noinclude><includeonly>l</includeonly>|!}} meta-template. Its use is analogous to an [[escape character]].
 +
 
 +
This is an auxiliary template allowing the encoding of "<code>|</code>" 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 "<code>&amp;#124;</code>".  
  
 
This template cannot be used for putting the character as text in a wiki table; in that case, again,  "<code>&amp;#124;</code>" can be used.
 
This template cannot be used for putting the character as text in a wiki table; in that case, again,  "<code>&amp;#124;</code>" can be used.
Line 11: Line 14:
 
Note that no special template is needed for "<code>!</code>" (exclamation mark).
 
Note that no special template is needed for "<code>!</code>" (exclamation mark).
  
This is a '''high risk template''', and it cannot be substituted.
+
This is a [[WP:high-risk template|high-risk template]], and it usually cannot be [[Wikipedia:Substitution|substituted]] (see conditions for substing on [[#Substitution|the section below]]).
 +
 
 +
=== Substitution ===
 +
It is possible to [[Wikipedia:Substitution|substitute]] <nowiki>{{!}}</nowiki> only if an unescaped "'''<code>|</code>'''" works as expected, i.e. after substituting the template containing <nowiki>{{!}}</nowiki>, or after eliminating an
 +
[[mw:Help:Extension:ParserFunctions#.23if|#if]] containing <nowiki>{{!}}</nowiki>.
 +
 
 +
=== A simple example ===
 +
 
 +
The following template code for {{tl|Quotation}} using an ordinary pipe character,
 +
* <code><nowiki>{{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]]}}</nowiki></code>
 +
 
 +
produces:
 +
{{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]]}}
 +
 
 +
whereas this code using the <nowiki>{{!}}</nowiki> meta-template,
 +
* <code><nowiki>{{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]]}}</nowiki></code>
 +
 
 +
produces:
 +
{{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]]}}
 +
 
 +
== See also ==
 +
* {{tl|!!}}
 +
* {{tl|!-}} creates |-
 +
* {{tl|-!}}
 +
* {{tl|broken bar}}
 +
* {{tn|'}} and related
 +
* [[Wikipedia:Conditional tables]]
 +
* {{tl|pipe}} - Note that this one looks like {{tlf|!}} but has a very different meaning for the MediaWiki parser and thus has different functionality.
 +
* {{tn|(}} creates {
 +
* {{tn|((}} creates {{
 +
* {{tl|!(}}
 +
* {{[[template:=|=]]}}
  
===See also===
 
*[[Template:!!]]
 
*[[Template:!-]]
 
*[[Template:-!]]
 
 
<includeonly>
 
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
 
[[Category:Template namespace templates|{{PAGENAME}}]]
 
[[Category:Template namespace templates|{{PAGENAME}}]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
 +
 
 +
<!-- These are the inter-language links for templates in other languages corresponding to [[Template:!]] -->
 +
[[ar:قالب:!]]
 +
[[as:Template:!]]
 +
[[be-x-old:Шаблён:!]]
 +
[[bg:Шаблон:!]]
 +
[[bn:Template:!]]
 +
[[cs:Šablona:!]]
 +
[[da:Skabelon:!]]
 +
[[de:Vorlage:!]]
 +
[[dsb:Pśedłoga:!]]
 +
[[et:Mall:!]]
 +
[[es:Plantilla:!]]
 +
[[fa:الگو:!]]
 +
[[fr:Modèle:!]]
 +
[[hsb:Předłoha:!]]
 +
[[it:Template:!]]
 +
[[ja:Template:!]]
 +
[[ka:თარგი:!]]
 +
[[ko:틀:!]]
 +
[[ku:Şablon:!]]
 +
[[la:Formula:!]]
 +
[[myv:ЛопаПарцун:!]]
 +
[[nl:Sjabloon:!]]
 +
[[no:Mal:!]]
 +
[[pap:Template:!]]
 +
[[pl:Szablon:!]]
 +
[[pt:Template:!]]
 +
[[ru:Шаблон:!]]
 +
[[sk:Šablóna:!]]
 +
[[sl:Template:!]]
 +
[[sr:Шаблон:!]]
 +
[[vi:Tiêu bản:!]]
 +
[[zh:Template:!]]
 +
[[zh-yue:Template:!]]
 +
[[he:תבנית:!]]
 +
[[uk:Шаблон:!]]
 +
[[fi:Malline:!]]
 +
[[sv:Mall:!]]
 +
[[simple:Template:!]]
 +
[[ur:سانچہ:!]]
 +
</includeonly><noinclude>
  
</includeonly>
+
<!-- These are the inter-language links for the documentation subpage [[Template:!/doc]], not for the template itself. -->
 +
[[ar:قالب:!/شرح]]
 +
[[as:সাঁচ:!/doc]]
 +
[[cs:Šablona:!/doc]]
 +
[[de:Vorlage:!/Doku]]
 +
[[es:Plantilla:!/doc]]
 +
[[fr:Modèle:!/Documentation]]
 +
[[or:ଟେମ୍ପଲେଟ:!/doc]]
 +
[[ro:Format:!/doc]]
 +
[[ru:Шаблон:!/doc]]
 +
</noinclude>

Latest revision as of 08:13, 22 May 2012


Usage

This is the {{!}} 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 {{Quotation}} 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:

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

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:

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

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