Template:Documentation/doc: Difference between revisions
({{documentation subpage}}, rm note about {{template doc inline}}'s preload feature (ported to {{documentation}} with full credit)) |
(expanded documentation, removed unneeded subpage category) |
||
| Line 2: | Line 2: | ||
{{mergefrom|Template doc|date=October 2007}} | {{mergefrom|Template doc|date=October 2007}} | ||
<pre>{{template | ==Usage== | ||
This template automatically displays a | <pre> | ||
{{documentation}} | |||
or {{documentation|template:any page}} | |||
</pre> | |||
This template automatically displays a documentation box like you are seeing now. The first parameter can be used as shown above to [[Wikipedia:Transclusion|transclude]] an arbitrary documentation page. | |||
==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 [[Wikipedia:Transclusion costs and benefits|technical limitation of templates]] (see a [{{fullurl:Project:Village pump (technical)&diff=prev&oldid=69888944}} developer's explanation]). | |||
==See also== | ==See also== | ||
* {{tiw|template doc}} (similar template, but with more documentation) | * {{tiw|template doc}} (similar template, but with more documentation) | ||
* {{tiw|documentation subpage}} (replaces older {{[[template:Template doc page viewed directly|Template doc page viewed directly]]}} and {{[[template:Template doc page transcluded|Template doc page transcluded]]}}) | * {{tiw|documentation subpage}} (replaces older {{[[template:Template doc page viewed directly|Template doc page viewed directly]]}} and {{[[template:Template doc page transcluded|Template doc page transcluded]]}}) | ||
<!-- for the template --> | <!-- for the template --> | ||
<includeonly> | <includeonly> | ||
[[Category:Template documentation| ]] | [[Category:Template documentation| ]] | ||
Revision as of 14:45, 3 October 2007
Usage
{{documentation}}
or {{documentation|template:any page}}
This template automatically displays a documentation box like you are seeing now. The first parameter can be used as shown above to transclude an arbitrary documentation page.
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 (see a developer's explanation).
See also
- Template:Tiw (similar template, but with more documentation)
- Template:Tiw (replaces older {{Template doc page viewed directly}} and {{Template doc page transcluded}})