View source for Template:Braces/doc

{{Documentation subpage}}

* 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 {{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|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).

== Function ==
* This template wraps the [[HTML entities]] <code>&amp;#123;&amp;#123;</code> and <code>&amp;#125;&amp;#125;</code>.

=== Limitations ===
* The template cannot output just the starting double braces or just the ending double braces. You will have to write <code>&amp;#123;&amp;#123;</code> or <code>&amp;#125;&amp;#125;</code>. Or you could use [[Template:(]] and [[Template:)]].

===Examples===
{{Markup
| col2 = Output

| <nowiki>{{braces|Templatename|item1|item2}}</nowiki>
| {{braces|Templatename|item1|item2}}

| <nowiki>{{braces|code=on |Templatename|item1|item2}}</nowiki>
| {{braces|code=on |Templatename|item1|item2}}

| <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}}

}}

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}}

}}

== See also ==
* {{tl|brackets}}
* {{tl|bracket}}
* {{tl|nowiki}}
* {{tl|mono}}
* {{tl|mset}}
* {{tl|(())}}
<!--[Now deprecated?:] * {{tl|Ttt}} {{tag|tt}} tags.-->

<includeonly>{{Sandbox other||
[[Category:Character-substitution templates]]
[[Category:Wikitext typing-aid templates]]
}}</includeonly>