Template:Tlg/doc
From HandWiki
< Template:Tlg
Revision as of 16:47, 9 July 2021 by imported>Jworkorg (Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> {{#ifeq:{{FULLPAGENAME}}|Template:Template link expanded|{{used in system}}...")
This is a documentation subpage for Template:Tlg It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 125,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
Error: no shortcuts were specified and the |msg= parameter was not set.
This template uses Lua: |
This template, often abbreviated as {{tlg}}, is used to provide stylized formatting to template displays without actually using the template itself.
Parameters
With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options.
Parameter | Action | Use with {{example}} |
Default active |
---|---|---|---|
brace | Include braces as part of the template link | {{example}} | {{tlw}}/{{tn}} |
braceinside | Include innermost braces as part of the template link | {{example}} | |
bold | Renders the template link/name in bold | {{example}} | {{tlb}}, {{tlxb}} |
code | Display output using HTML <code>...</code> tags (monospaced font) |
{{example}} |
{{tlc}}, {{Template link expanded}}, etc. |
italic | Display any parameters accompanying the template link/name in italics | {{example|param}} | {{tlxi}} |
kbd | Display output using HTML <kbd>...</kbd> tags (monospaced font) |
{{example}} | |
nolink | Don't render the template name as a link | {{example}} | {{tlf}}, {{tlc}}, {{tnull}} |
nowrap | Prevent the insertion of line breaks (word wrap) in the output | {{example}} | |
nowrapname | Prevent word wrapping in the output of template name/link (parameters will wrap if needed) | {{example}} | |
plaincode | Uses <code style="border:none; background:transparent;">...</code> |
{{example}} |
{{tltss}} |
subst | Include a subst: prefix before the template link/name | {{subst:example}} | {{tls}}, {{tlxs}}, etc |
|alttext=[text] |
Use [text] as the label for the template link | {{Other}} | {{tla}} |
Unnamed (Positional)
This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.
Examples
- Note
- On the source sister projects, en.wikipedia and Meta, X0, X1, X2, …, X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects.
Code | Output | Remarks |
{{tlg|Banner}} | {{Banner}} | Banner template does not exist. Be aware with linking to non-existing templates, although desired. |
{{tlg|ok}} | {{ok}} | ok template does exist |
{{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} | {{convert|14|m|ftin|abbr=out|sp=us}} | Unlimited parameters as one <nowiki>...</nowiki> string |
{{tlg|Abc}} | {{Abc}} | |
{{tlg|abC}} | {{abC}} | template names are case-sensitive |
{{tlg|abc}} | {{abc}} | first letter is case-insensitive though |
{{tlg|abc|{{spaces}}{{{1}}}{{spaces}}}} | {{abc| {{{1}}} }} | Using {{spaces}} before and after {{{1}}} parameter. |
{{tlg|x0}} | {{x0}} | |
{{tlg|x0|code=on}} | {{x0}} | <code> style |
{{tlg|x0|plaincode=on}} | {{x0}} | plaincode style |
{{tlg|x0|kbd=on}} | {{x0}} | <kbd> style |
{{tlg|x0|bold=on}} | {{x0}} | bold link/name |
{{tlg|x1|one|italic=on}} | {{x1|one}} | parameter/s in italics |
{{tlg|x0|nolink=on}} | {{x0}} | |
{{tlg|x0|subst=on}} | {{subst:x0}} | |
{{tlg|x0|brace=on}} | {{x0}} | all braces in link |
{{tlg|x0|braceinside=on}} | {{x0}} | inside braces in link |
{{tlg|x0|alttext=x0 link}} | {{x0 link}} | |
{{tlg|x0|bold=on|code=on|brace=on}} | {{x0}} | No reason you can't combine multiple parameter settings |
{{tlg|x1|one}} | {{x1|one}} | |
{{tlg|x2|one|two}} | {{x2|one|two}} | |
{{tlg|x2|bold=on|code=on|one|two}} | {{x2|one|two}} | Can combine named and anonymous parameters … |
{{tlg|x2|one|two|bold=on|code=on}} | {{x2|one|two}} | … in any order … |
{{tlg|x2|one|code=on|two|bold=on|three}} | {{x2|one|two|three}} | … even intermixed … |
{{tlg|x2|one|code=on|two|bold=on|three|italic=on}} | {{x2|one|two|three}} | … with many different configurations. |
{{tlg|x3|1|2|3|4|5|6|7|8|9|…}} | {{x3|1|2|3|4|5|6|7|8|9|10}} | |
{{tlg}} | tlg | with no arguments, the current page name is substituted |
{{tlg|x1|x=u}} | {{x1}} | = won't work |
{{tlg|x1|x=u}} | {{x1|x=u}} | = is okay |
{{tlg|x1|x{{=}}u}} | {{x1|x=u}} | {{=}} is okay (see template equal sign) |
{{tlg|x1|x<nowiki>=</nowiki>u}} | {{x1|x=u}} | sticky nowiki is okay |
{{tlg|x2||two||}} | {{x2||two||}} | empty parameters work too, even at the end |
{{tlg|x2|3=two|2=one}} | {{x2|one|two}} | right to left okay |
Code | Output |
---|---|
{{tlg|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}}
|
{{long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} |
Code | Output |
---|---|
{{tlg|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|
{{long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
Code | Output |
---|---|
{{tlg|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}
|
{{long template name that would wrap to new line|long value for the 1st parameter that would wrap}} |
See also
{{[[Template:|]]}}