Difference between revisions of "Template:Auto short description/doc"

From blackwiki
Jump to navigation Jump to search
imported>Jonesey95
(add doc for conditions)
imported>Gonnym
({{para}} not {{code}})
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
 
'''Template:Auto short description''' should be placed on doc pages of templates which automatically generate short description for pages transcluding them.
 
'''Template:Auto short description''' should be placed on doc pages of templates which automatically generate short description for pages transcluding them.
  
Pages tagged with this template are categorized in [[:Category:Templates that generate short descriptions]].
+
Pages tagged with this template are categorized in {{cl|Templates that generate short descriptions}}.
 +
 
 +
For meta-templates that are used to create a family of templates, add a {{para|category}} value to define an alternative category.
 +
 
 +
For example: {{tlx|{{BASEPAGENAME}}|category{{=}}chemical elements}} will categorize the templates in {{cl|Templates that generate short descriptions for chemical elements}}.
  
 
== Examples ==
 
== Examples ==
Line 11: Line 15:
  
 
{{Tlx|{{BASEPAGENAME}}|conditions{{=}}when it is used in Wikipedia space}} – when an explanation is desired for the conditions under which a short description is generated, e.g. when the short description template is wrapped with {{tl|Namespace detect}}
 
{{Tlx|{{BASEPAGENAME}}|conditions{{=}}when it is used in Wikipedia space}} – when an explanation is desired for the conditions under which a short description is generated, e.g. when the short description template is wrapped with {{tl|Namespace detect}}
 +
 +
{{Tlx|{{BASEPAGENAME}}|category{{=}}specific type}} – for meta-templates that generate short descriptions for a family of templates
  
 
<includeonly>{{Sandbox other||
 
<includeonly>{{Sandbox other||

Latest revision as of 17:49, 7 September 2020

Template:Auto short description should be placed on doc pages of templates which automatically generate short description for pages transcluding them.

Pages tagged with this template are categorized in Category:Templates that generate short descriptions.

For meta-templates that are used to create a family of templates, add a |category= value to define an alternative category.

For example: {{Auto short description|category=chemical elements}} will categorize the templates in Category:Templates that generate short descriptions for chemical elements.

Examples

{{Auto short description}}

{{Auto short description|sometimes=yes}} – for templates that only generate short descriptions under particular conditions

{{Auto short description|conditions=when it is used in Wikipedia space}} – when an explanation is desired for the conditions under which a short description is generated, e.g. when the short description template is wrapped with {{Namespace detect}}

{{Auto short description|category=specific type}} – for meta-templates that generate short descriptions for a family of templates