Template:Documentation/doc: Difference between revisions
m (1 revision imported) |
No edit summary |
||
Line 23: | Line 23: | ||
==Rationale== | ==Rationale== | ||
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, categories, and interwiki links. It also reduces server resources by circumventing a [[ | 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, categories, and interwiki links. It also reduces server resources by circumventing a [[Wikipedia:Template limits|technical limitation of templates]] (see a [{{fullurl:en:Project:Village pump (technical)|diff=prev&oldid=69888944}} developer's explanation]). | ||
==See also== | ==See also== | ||
Line 29: | Line 29: | ||
*{{tim|Documentation}} | *{{tim|Documentation}} | ||
* [[w:Wikipedia:Template documentation]] | * [[w:Wikipedia:Template documentation]] | ||
<!-- for the template --> | <!-- for the template --> | ||
Line 36: | Line 34: | ||
[[Category:Template documentation| ]] | [[Category:Template documentation| ]] | ||
[[Category:Formatting templates|Template documentation]] | [[Category:Formatting templates|Template documentation]] | ||
</includeonly> | </includeonly> |
Latest revision as of 08:28, 11 July 2016
This is a documentation subpage for Template:Documentation. It contains usage information, categories and other content that is not part of the original template page. |
This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.
Usage[edit]
Normal[edit]
<noinclude>{{TNT|Documentation}}<noinclude>
or
<noinclude>{{TNT|Documentation|Template:any page/doc}}<noinclude>
This code should be added at the bottom of the template code, with no extra space before "<noinclude>
" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.
Add categories and interwiki links to the documentation page inside includeonly
tags.
If the documentation page contains includeonly
or noinclude
tags as part of the documentation, replace the "<
" with "<
".
Customizing display[edit]
Overrides exist to customize the output in special cases:
- {{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.
Functions[edit]
If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
Rationale[edit]
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, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).
See also[edit]