Wikimedia Commons

Template:Tltts

{{subst:[[Template:{{{1}}}|{{{1}}}]]}}

Template documentation[ view · edit · history · purge ]
This documentation is transcluded from Template:Tltts/doc.

Usage

edit

This template is exactly like {{Tltt}}, except that it includes a "subst:" before it.

The template is meant to be used in pages such as Template:Tltt, where it is desirable to provide a description of the template's usage with all parameters detailed.

Example

edit

{{tltts3|sdd2|Article not speedied - invalid reason and why it doesn't apply|par=Article|par2=CSD tag used|par3=reason it isn't a valid speedy}}

Results in:

{{subst:sdd2|Article|CSD tag used|reason it isn't a valid speedy}}

Known problems

edit
  • On some systems, the text only displays when user hovers over the curly braces, not over the link itself.
  • It is not possible to include double quotes in the text. Use single quotes instead.

TemplateData

edit
 Parameter text is empty
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

Wikipedia's help about TemplateData • Commons-specific information

Template link with tooltip and subst

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Template1

Linked template name

Templaterequired
Tooltip2

The tooltip

Linerequired
Parameter 1par

First parameter value

Stringoptional
Parameter 2par2

Second parameter value

Stringoptional
Parameter 3par3

Third parameter value

Stringoptional

See also

edit

[edit subpage]

edit
List of templates using {{T/main}}
Code Result Notes lock

{{T|example}}

{{Example}} makes brackets part of the link

{{T0|example}}

Example just link, without the brackets

{{T1|example}}

{{Example}} inner brackets are part of the link

{{T2|example}}

{{Example}} brackets are not a part of the link

{{Tl|example}}

{{Example}} makes brackets around the link

{{Tlr|User:Example}}

{{User:Example}} like {{tl}} but for any namespace

{{Tls|example}}

{{subst:example}} no parameters, adds "subst:"
Templates showing parameters 0 Meta template {{Tle}} is easiest to parametrize.

{{Tle|T=F|p1=1|v1|p2=2|v2|p3=3|v3}}

{{ F | 1 = v1 | 2 = v2 | 3 = v3 }} describes template parameters by names and values

{{Tlx|example|1|2|3|4|5||7|8|9}}

{{example|1|2|3|4|5|7|8|...}} up to 8 parameters

{{Tlf|example|1|2|3|...up to 8}}

{{example|1|2|3|...up to 8}} up to 8 parameters, no link

{{Tlc|example|1|2|3|4|||7|up to 8|9 is ignored.}}

{{example|1|2|3|4|||7|up to 8}} up to 8 parameters, no link, <code> style

{{Tld|example|1|2||3||}}

{{example|1||2|3||}} up to 8 parameters, <code> style[clarification needed]

{{Tlsu|User:Example}}

{{subst:User:Example}} like {{Tls}}, but supporting parameters
Alternative forms 0 These ignore empty parameters.

{{Tlp|example|1|2|3|4|5||7|8|9 is ignored.}}

{{example|1|2|3|4|5|7|8}} up to 8 parameters; ignores empty parms

{{Tl2|example|p1|p2}}

{{example|p1|p2}} up to 2 parameters, <code> style

{{Tlsp|example|1|2|3|4|5|6|7|8|9}}

{{subst:example|1|2|3|4|5|6|7|8|...}} up to 8 parameters, adds linked "subst:"

{{Tlsx|example|1|2|3|4|5|6 and above are ignored.|7}}

{{subst:example|1|2|3|4|5|...}} up to 5 parameters, adds linked "subst:", <code> style

General-purpose formatting

edit
Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options[note 1]
to achieve text style 		Link style
Linked Unlinked Linked with subst Unlinked with subst Linked including braces
{{tlg}} options[note 1]
to achieve link style 		N/A DEFAULT nolink=yes subst=yes nolink=yes|subst=yes braceinside=yes
normal DEFAULT
N/A
code code=yes
N/A
monospace plaincode=yes[note 4]
N/A
N/A
kbd[clarification needed] kbd=yes[note 5]
  1. ↑ a b c {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. ↑ a b c d e Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. ↑ a b c Allows links to templates in any namespace.
  4. ↑ {{tlg|plaincode=yes}} uses <code style="border: none; background-color: transparent;">...</code>.
  5. ↑ a b c d Displays monospaced font using <span style="font-family: monospace;">...</span>.
Retrieved from "https://commons.wikimedia.org/w/index.php?title=Template:Tltts&oldid=847684752"