Template:Documentation: Difference between revisions
mediawiki>Shirayuki m make Wikipedia links translatable! |
m 1 revision imported |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| ⚫ | |||
| ⚫ | |||
<!-- Add categories to the /doc subpage --> |
|||
<languages/> |
|||
| ⚫ | |||
| ⚫ | |||
{{documentation|content= |
|||
{{Lua|Module:Documentation}} |
|||
<translate><!--T:12--> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate> |
|||
<translate><!--T:13--> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate> |
|||
<translate> |
|||
== Usage == <!--T:2--> |
|||
=== Customising display === <!--T:3--> |
|||
<!--T:4--> |
|||
Overrides exist to customise the output in special cases: |
|||
</translate> |
|||
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate><!--T:5--> change the text of the "documentation" heading.</translate> <translate><!--T:10--> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate> |
|||
<translate> |
|||
== Rationale == <!--T:6--> |
|||
</translate> |
|||
<translate><!--T:7--> This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation and categories.</translate> |
|||
<translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate> |
|||
<translate> |
|||
== See also == <!--T:9--> |
|||
</translate> |
|||
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate> |
|||
* {{tim|Documentation}} |
|||
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate> |
|||
}} |
|||
[[Category:Formatting templates{{#translation:}}|Template documentation]] |
|||
[[Category:Template documentation{{#translation:}}| ]] |
|||
</noinclude><includeonly>{{#if:{{{content|}}}| |
|||
[[Category:Template documentation pages{{#translation:}}]] |
|||
}}</includeonly> |
|||
Latest revision as of 12:08, 20 December 2025
| Uses Lua: |
This is the {{Documentation}} template, used on almost every template page to contain that template's documented instructions and information.
For detailed instructions on how and when to use this template, see w:Wikipedia:Template documentation.
This template displays a green documentation box like you are seeing now and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to.
This template is intended for documenting templates and other pages that are transcluded onto other pages. It can be used in the template namespace and most other namespaces.
Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation and categories.