Template:No documentation

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

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
{{NODOC|… parameters as described …}}

Template parameters

ParameterDescriptionDefaultStatus
1DetailsAdditional details to be appended to the end of the notice as a separate paragraphemptyoptional
<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.


Wikipedia's help about TemplateDataCommons-specific information

Category:Templates using TemplateData

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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Details1

Additional details to be appended to the end of the notice as a separate paragraph

Stringoptional

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:

See also

Category:Templates using an unknown approach for internationalisationCategory:Documentation templatesCategory:Template maintenance templatesCategory:Template header templatesCategory:Commons missing information#τ
Category:Commons missing information Category:Documentation templates Category:Template header templates Category:Template maintenance templates Category:Templates using TemplateData Category:Templates using an unknown approach for internationalisation