Template:Documentation/doc: Difference between revisions
New page: {{documentation subpage}} {{mergefrom|Template doc|date=October 2007}} This template automatically displays a documentation box like you are seeing now, of which the content is transclude... |
m Cleanup documentation |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{documentation subpage}} | <noinclude>{{documentation subpage}}</noinclude> | ||
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 [[wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not. | |||
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 [[ | |||
==Usage== | ==Usage== | ||
| Line 17: | Line 15: | ||
==Functions== | ==Functions== | ||
If the documentation page doesn't exist, the "edit" link includes a | 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. The header depends on the namespace; for example, it will display "Template documentation" in the template namespace. | ||
==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 [[Wikipedia:Template limits|technical limitation of templates]] | 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]]. | ||
<!-- for the template --> | <!-- for the template --> | ||
<includeonly> | <includeonly> | ||
[[Category:Template | [[Category:Template namespace templates]] | ||
</includeonly> | </includeonly> | ||
Latest revision as of 16:42, 2 August 2024
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
<noinclude>{{documentation}}<noinclude>
or <noinclude>{{documentation|template:any page}}<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 "<".
Functions
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. The header depends on the namespace; for example, it will display "Template documentation" in the template namespace.
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 technical limitation of templates.