Template:Documentation/doc: Difference between revisions
(→Rationale: Placing the documentation in a subpage reduces the wikitext for documentation on the template page itself to a template call and noinclude tags.) |
(→See also: more related templates) |
||
| Line 28: | Line 28: | ||
==See also== | ==See also== | ||
* {{tiw| | * {{tiw|Template doc}} | ||
* {{tiw| | :Similar template with more documentation; see [[User:Pathoschild/Sandbox|template comparison]] | ||
* {{tiw|Documentation subpage}} | |||
:Replaces older: {{tiw|Template doc page}} | |||
::{{tiw|Template doc page transcluded}} | |||
::{{tiw|Template doc page viewed directly}} | |||
*{{tim|Documentation}} | *{{tim|Documentation}} | ||
Revision as of 07:49, 8 November 2007
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
Normal
<noinclude>{{documentation}}</noinclude>
or <noinclude>{{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
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
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
- Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
- Text on the template page itself adds to the amount of text which must be processed when displaying the template, which is limited for performance reasons: there is a Template:Peisl. Placing the documentation in a subpage reduces the wikitext for documentation on the template page itself to a template call and noinclude tags. MediaWiki developers have recommended this system for this reason.
See also
- Similar template with more documentation; see template comparison
- Replaces older: Template:Tiw