Difference between revisions of "Template:Braces/doc"
Jump to navigation
Jump to search
(←Replaced content with 'lies') |
imported>Andrybak |
||
(10 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{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. | ||
+ | * An alternative is to use <code>&#123;{some text}&#125;</code>. | ||
+ | * 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 – e.g. <code><nowiki>{{braces|Templatename|p1{{=}}v1|p2{{=}}v2|...}}</nowiki></code> (and see examples below). | ||
+ | |||
+ | ===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|nowiki}} | ||
+ | * {{tl|mono}} | ||
+ | * {{tl|mset}} | ||
+ | <!--[Now deprecated?:] * {{tl|Ttt}} {{tag|tt}} tags.--> | ||
+ | |||
+ | <includeonly>{{Sandbox other|| | ||
+ | [[Category:Character-substitution templates]] | ||
+ | [[Category:Wikitext typing-aid templates]] | ||
+ | }}</includeonly> |
Latest revision as of 05:10, 3 October 2020
![]() | 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
{{some text}}
. - 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}} |
|
{{braces |Templatename|item1{{=}}XYZ|item2{{=}}PQR}} |
{{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 | Output |
---|---|
{{braces |Templatename|item1=XYZ|item2=PQR}} |
{{Templatename}} |
{{braces|code=on |Templatename|item1{{=}}XYZ|item2{{=}}PQR}} |
|
See also