Difference between revisions of "Template:Braces/doc"

From blackwiki
Jump to navigation Jump to search
imported>Dcljr
(→‎Examples: confusing to include cross icon in output column, since it's not actually part of the template output; segregate wrong example(s) into second table)
imported>Dcljr
("foo" is potentially confusing)
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|thinsp}}aces are inserted either side of any [[Vertical bar|pipe character]]s ("{{thinsp|{{!}}}}") displayed by the template.

Revision as of 04:38, 18 March 2019

  • 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, {{thinsp}}aces are inserted either side of any pipe characters ("Template:Thinsp") 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