Template:Documentation/sandbox
 | This is the template sandbox page for Template:Documentation (diff). |
 | This template is used on approximately 8,400 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | Uses Lua: |
This template automatically displays a documentation box, 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><noinclude>{{documentation|else:where}}</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 "<".
An optional second parameter or named parameter heading=… allows to 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.
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.
Purpose
Transclusion of a documentation page makes it possible to protect the page of the template itself while allowing anyone to edit the template's documentation and categories. Sometimes this also allows the use of msgnw to show the raw content of a template.
See also
- {{docsubst}} to substitute (instead of transclude) a /doc subpage
- Subpages, not all languages on commons are already copied.
Transclude documentation from a /doc subpage of the subject page or another page
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | Page with /doc subpage.
| Page name | optional |
| content | content | no description | Unknown | optional |
| heading | heading | no description | Unknown | optional |
| link box | link box | no description | Unknown | optional |
| page | page | no description | Unknown | optional |
| preload | preload | no description | Unknown | optional |