Template:Auto short description/doc
 | This is a documentation subpage for Template:Auto short description. It may contain usage information, categories and other content that is not part of the original template page. |
Template:Auto short description should be placed on documentation 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.
Usage
[edit]Examples
[edit]{{Auto short description}}→
This template adds an automatically generated short description. If the automatic short description is not optimal, override it by adding {{Short description}} at the top of the article. {{Auto short description|sometimes=yes}}→This template sometimes adds an automatically generated short description. If the automatic short description is not optimal, override it by adding {{Short description}} at the top of the article. {{Auto short description|indirect=yes}}→This template adds an automatically generated short description via an embedded template. If the automatic short description is not optimal, override it by adding {{Short description}} at the top of the article. {{Auto short description|conditions=when it is used in Wikipedia space}}→This template adds an automatically generated short description when it is used in Wikipedia space. If the automatic short description is not optimal, override it by adding {{Short description}} at the top of the article. {{Auto short description|category=chemical elements}}→This template adds an automatically generated short description (chemical elements). If the automatic short description is not optimal, override it by adding {{Short description}} at the top of the article.
TemplateData
[edit]TemplateData for Auto short description
Indicate that a template will set a Short description
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Sometimes | sometimes | Any value will change "adds an automatically generated short description" to "sometimes adds an automatically generated short description" . Use for templates that only generate short descriptions under particular conditions. | Boolean | optional |
| Indirect | indirect | For templates that generate short descriptions via another template that is always embedded. | Boolean | optional |
| Conditions | conditions | 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}}.
| Content | optional |
| Category | category | For meta-templates that generate short descriptions for a family of templates. For example, specifying "chemical elements" will categorize the templates in Category:Templates that generate short descriptions for chemical elements.
| String | optional |
| No override | nooverride | Remove advice to override the text generated by the template
| Boolean | optional |
| No category | nocat | Do not add the template to a category
| Boolean | optional |