Template:Braces/doc

From Safer nicotine wiki
Jump to navigation Jump to search
  • 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.
  • 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).

Function

  • This template wraps the HTML entities &#123;&#123; and &#125;&#125;.

Limitations

  • The template cannot output just the starting double braces or just the ending double braces. You will have to write &#123;&#123; or &#125;&#125;. Or you could use Template:( and Template:).

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