Difference between revisions of "Template:Braces/doc"

From blackwiki
Jump to navigation Jump to search
imported>Greyjoy
(Undid revision 732644281 by 66.87.134.148 (talk))
imported>Andrybak
 
(7 intermediate revisions by 6 users not shown)
Line 2: Line 2:
  
 
* This template returns the first unnamed parameter in double braces. To be used to demonstrate template code without the need for clunky nowiki'ing. Further unnamed parameters (up to 8 more) can be used without worrying for pipes.
 
* This template returns the first unnamed parameter in double braces. To be used to demonstrate template code without the need for clunky nowiki'ing. Further unnamed parameters (up to 8 more) can be used without worrying for pipes.
* An alternative is to use <code>&amp;#123;{foo}&amp;#125;</code>.
+
* An alternative is to use <code>&amp;#123;{some text}&amp;#125;</code>.
 
* Set {{mono|code{{=}}on}}{{\}}{{mono|code{{=}}true}}{{\}}etc. to switch the font used to the HTML <nowiki><code></nowiki>-style monospaced font.
 
* Set {{mono|code{{=}}on}}{{\}}{{mono|code{{=}}true}}{{\}}etc. to switch the font used to the HTML <nowiki><code></nowiki>-style monospaced font.
* To improve legibility, {{tl|thinsp}}aces are inserted either side of any [[Vertical bar|pipe character]]s ("{{thinsp|{{!}}}}") displayed by the template.
+
* To improve legibility, {{tl|thin space}}s are inserted either side of any [[Vertical bar|pipe character]]s ("{{thin space|{{!}}}}") displayed by the template.
 
* To ensure equals-signs are handled as text by the template, use {{tl|{{=}}}} to produce them&nbsp;– e.g. <code><nowiki>{{braces|Templatename|p1{{=}}v1|p2{{=}}v2|...}}</nowiki></code> (and see examples below).
 
* To ensure equals-signs are handled as text by the template, use {{tl|{{=}}}} to produce them&nbsp;– e.g. <code><nowiki>{{braces|Templatename|p1{{=}}v1|p2{{=}}v2|...}}</nowiki></code> (and see examples below).
  
Line 20: Line 20:
 
| {{braces |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}
 
| {{braces |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}
  
| <nowiki>{{braces|code=on |Templatename|item1=XYZ|item2=PQR}}</nowiki>
+
| <nowiki>{{braces|code=on |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}</nowiki>
| {{cross|15}} {{braces|code=on |Templatename|item1=XYZ|item2=PQR}}
+
| {{braces |code=on |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}
 +
 
 +
}}
 +
 
 +
Note that omitting the double-braces around the equals signs in the last two examples does not work as intended:
 +
{{Markup
 +
| col2 = Output
 +
 
 +
| <nowiki>{{braces |Templatename|item1=XYZ|item2=PQR}}</nowiki>
 +
| {{braces |Templatename|item1=XYZ|item2=PQR}}
 +
 
 +
| <nowiki>{{braces|code=on |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}</nowiki>
 +
| {{braces |code=on |Templatename|item1=XYZ|item2=PQR}}
 +
 
 
}}
 
}}
  
Line 31: Line 44:
 
<!--[Now deprecated?:] * {{tl|Ttt}} {{tag|tt}} tags.-->
 
<!--[Now deprecated?:] * {{tl|Ttt}} {{tag|tt}} tags.-->
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
<includeonly>{{Sandbox other||
[[Category:Wikipedia character-substitution templates]]
+
[[Category:Character-substitution templates]]
[[Category:Typing-aid templates]]
+
[[Category:Wikitext typing-aid templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 05:10, 3 October 2020

  • This template returns the first unnamed parameter in double braces. To be used to demonstrate template code without the need for clunky nowiki'ing. Further unnamed parameters (up to 8 more) can be used without worrying for pipes.
  • An alternative is to use &#123;{some text}&#125;.
  • Set code=on / code=true / etc. to switch the font used to the HTML <code>-style monospaced font.
  • To improve legibility, {{thin space}}s are inserted either side of any pipe characters ("| ") displayed by the template.
  • To ensure equals-signs are handled as text by the template, use {{=}} to produce them – e.g. {{braces|Templatename|p1{{=}}v1|p2{{=}}v2|...}} (and see examples below).

Examples

Markup Output
{{braces|Templatename|item1|item2}}

{{Templatename|item1|item2}}

{{braces|code=on |Templatename|item1|item2}}

{{Templatename|item1|item2}}

{{braces |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}

{{Templatename|item1=XYZ|item2=PQR}}

{{braces|code=on |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}

{{Templatename|item1=XYZ|item2=PQR}}

Note that omitting the double-braces around the equals signs in the last two examples does not work as intended:

Markup Output
{{braces |Templatename|item1=XYZ|item2=PQR}}

{{Templatename}}

{{braces|code=on |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}

{{Templatename}}

See also