Difference between revisions of "Template:Braces/doc"
Jump to navigation
Jump to search
imported>Frietjes |
imported>Sardanaphalus (formatting updates, template names, {{Markup}}) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{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. | * 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>&#123;{foo}&#125;</code>. | * An alternative is to use <code>&#123;{foo}&#125;</code>. | ||
| − | * Set {{ | + | * 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 | + | * To improve legibility, {{tl|thinsp}}aces are inserted either side of any [[Vertical bar|pipe character]]s ("{{thinsp|{{!}}}}") displayed by the template. |
| − | * To ensure equals-signs are handled as text by the template, use {{ | + | * To ensure equals-signs are handled as text by the template, use {{tlpad|{{=}}}} to produce them – e.g. {{plaincode|<nowiki>{{braces|Templatename|p1{{=}}v1|p2{{=}}v2|...}}</nowiki>}} (and see examples below). |
===Examples=== | ===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> | ||
| + | | {{cross|15}} {{braces|code=on |Templatename|item1=XYZ|item2=PQR}} | ||
| + | }} | ||
== See also == | == See also == | ||
| Line 19: | Line 29: | ||
* {{tl|mono}} | * {{tl|mono}} | ||
* {{tl|mset}} | * {{tl|mset}} | ||
| − | <!--Now deprecated?: * {{tl|Ttt}} {{tag|tt}} tags--> | + | <!--[Now deprecated?:] * {{tl|Ttt}} {{tag|tt}} tags.--> |
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | ||
Revision as of 21:23, 29 December 2014
| This is a documentation subpage for Template:Braces. It contains usage information, categories and other content that is not part of the original template page. |
- 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
{{foo}}. - 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 Template:Tlpad to produce them – e.g. Template:Plaincode (and see examples below).
Examples
| Markup | Output | ||
|---|---|---|---|
{{braces|Templatename|item1|item2}}
|
{{Templatename | item1 | item2}} | ||
{{braces|code=on |Templatename|item1|item2}}
|
| ||
{{braces |Templatename|item1{{=}}XYZ|item2{{=}}PQR}}
|
{{Templatename | item1=XYZ | item2=PQR}} | ||
{{braces|code=on |Templatename|item1=XYZ|item2=PQR}}
|
{{Templatename}}
| ||
See also