PlaneSpottingWorld welcomes all new members! Please gives your ideas at the Terminal.
Template:Documentation
From PlaneSpottingWorld, for aviation fans everywhere
| This template employs intricate features of template syntax. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.
|
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 /doc
<noinclude>{{Documentation}}</noinclude>
Any /doc page
<noinclude>{{Documentation|Template:any page/doc}}</noinclude>
In-line content
<noinclude>{{Documentation|content=This is documentation.}}</noinclude>
In-line content with [view][edit] links
<noinclude>{{Documentation
|1=Template:any page/doc
|content={{Template:any page/doc|parameters}}
}}</noinclude>
Best practice
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> </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 pre-expand include size maximum of 2,048,000 bytes. 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
{{ Documentation }} family
- Template:Documentation/doc (talk, backlinks, edit)
- Template:Documentation/doc/see also (talk, backlinks, edit)
- Template:Documentation/docname (talk, backlinks, edit)
- Template:Documentation/preload (talk, backlinks, edit)
- Template:Documentation/preload/testcases (talk, backlinks, edit)
- Template:Documentation/sandbox (talk, backlinks, edit)
- Template:Documentation/testcases (talk, backlinks, edit)
- Template:Documentation/testcases/test1 (talk, backlinks, edit)
- Template:Documentation/testcases/test2 (talk, backlinks, edit)
- Template:Documentation, template (talk, backlinks, edit)
- Template:Documentation subpage (talk, backlinks, edit)
Meta Wiki {{ Documentation }} ancestor
Other similar templates
- {{Usage of template}} for a similar documentation template, but redesigned and appears yellow instead of blue.
