Template:No documentation/doc: Difference between revisions
More actions
No edit summary |
adding description for template data |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{TemplateBox | ||
|1= | |||
|1label-en=Details | |||
|1d-en=Additional details to be appended to the end of the notice as a separate paragraph | |||
== | |1type=string | ||
This template can be used on templates or template documentation pages to show that a template is lacking documentation. An empty documentation box can confuse editors because it purports to show something which it does not. Another common situation is when documentation common to a group of templates is transcluded on a template, but none of the instructions relate directly to that template. In cases like this, {{ | |useTemplateData=yes | ||
|name=No documentation | |||
|desc-en=This template can be used on templates or template documentation pages to show that a template is lacking documentation. An empty documentation box can confuse editors because it purports to show something which it does not. Another common situation is when documentation common to a group of templates is transcluded on a template, but none of the instructions relate directly to that template. In cases like this, {{T|No documentation|+|incl=8}} can be used to draw attention to the fact that the template does not have any directly relevant documentation yet. | |||
|desc-td-en=This template can be used on templates or template documentation pages to show that a template is lacking documentation. An empty documentation box can confuse editors because it purports to show something which it does not. Another common situation is when documentation common to a group of templates is transcluded on a template, but none of the instructions relate directly to that template. In cases like this, Template:No documentation can be used to draw attention to the fact that the template does not have any directly relevant documentation yet. | |||
== | |shorthand=NODOC | ||
|namespace=Template | |||
|usergroup=all | |||
|setscats={{C|Templates without documentation}} | |||
|seealso={{Bulleted list|{{W|Template documentation||commons}}|{{T|TemplateBox|+|incl=8}}|{{T|Documentation|+|incl=8}}|{{T|Doc-inline|+|incl=8}}|{{T|Doc-end|+|incl=8}}|{{T|Description missing|+|incl=8}}|{{T|CatDescription missing|+|incl=8}}|{{T|Description insufficient|+|incl=8}}|{{T|Clarify|+|incl=8}}}} | |||
|example=There needs to be more information added. | |||
}} | |||
<includeonly> | |||
[[Category:Documentation templates]] | [[Category:Documentation templates]] | ||
[[Category:Template maintenance templates]] | [[Category:Template maintenance templates]] | ||
[[Category:Template header templates]] | [[Category:Template header templates]] | ||
[[Category:Commons missing information|τ]] | [[Category:Commons missing information|τ]] | ||
</includeonly | </includeonly> | ||
Latest revision as of 00:20, 31 July 2026
This template can be used on templates or template documentation pages to show that a template is lacking documentation. An empty documentation box can confuse editors because it purports to show something which it does not. Another common situation is when documentation common to a group of templates is transcluded on a template, but none of the instructions relate directly to that template. In cases like this, Template:No documentation can be used to draw attention to the fact that the template does not have any directly relevant documentation yet.
The template automatically sets the following categories: Templates without documentation
Usage
{{No documentation |1= }}
Or use the shorthand
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
1 | Details | Additional details to be appended to the end of the notice as a separate paragraph | empty | optional |
|
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
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 Newly created template documentation and imports Wikipedia's help about TemplateData • Commons-specific information This template can be used on templates or template documentation pages to show that a template is lacking documentation. An empty documentation box can confuse editors because it purports to show something which it does not. Another common situation is when documentation common to a group of templates is transcluded on a template, but none of the instructions relate directly to that template. In cases like this, Template:No documentation can be used to draw attention to the fact that the template does not have any directly relevant documentation yet.
| ||||||||||
Additional information
The template is intended to be used in the following namespaces: the Template namespace
The template is intended to be used by the following user groups: all users
Example
{{No documentation|There needs to be more information added.}}
renders as:
 | This template currently has no relevant documentation. Any editor familiar with the purpose and usage of this template is requested to write some documentation. There needs to be more information added. |
See also