m (changing preload link from internal to external (mediawiki)) |
(removing call to a missing template (no impact as we are in a /doc page)) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude>{{Documentation subpage}}</noinclude> | <noinclude>{{Documentation subpage}}</noinclude><!-- | ||
This Doc subpage format with noinclude tags is unique to this page | |||
--> | |||
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 [[Wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not. | ||
| Line 6: | Line 7: | ||
===Normal=== | ===Normal=== | ||
<pre> | <pre> | ||
<noinclude>{{documentation}}<noinclude> | <noinclude>{{documentation}}</noinclude> | ||
or <noinclude>{{documentation|template:any page/doc}}<noinclude> | - or - | ||
<noinclude>{{doc}}</noinclude> | |||
- or - | |||
<noinclude>{{documentation|template:any page/doc}}</noinclude> | |||
</pre> | </pre> | ||
This code should be added at the bottom of the template code, with no extra space before "<code><noinclude></code>" (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. | This code should be added at the bottom of the template code, with no extra space before "<code><noinclude></code>" (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. | Add categories and interwiki links to the documentation page inside <code><includeonly></code> tags. | ||
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;". | If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;", and the ">" with "&gt;. | ||
===Customizing display=== | ===Customizing display=== | ||
Overrides exist to customize the output in special cases: | Overrides exist to customize the output in special cases: | ||
* <nowiki>{{</nowiki>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. | * <code><nowiki>{{</nowiki>documentation|'''heading'''=}}</code>: 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. | ||
* <code><nowiki>{{</nowiki>documentation|'''content'''=}}</code>: for extremely simple documentation notes, enter the message desired with the {{para|content}} parameter. The text provided with this parameter appears in a box similar to the doc subpage, without any other notations in the boxes. For more complex documentation descriptions, use a full doc subpage. | |||
==Functions== | ==Functions== | ||
| Line 24: | Line 29: | ||
==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 [ | 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 [http://en.wikipedia.org/wiki/Wikipedia:Template_limits technical limitation of templates] (see a [{{fullurl:en:Project:Village pump (technical)|diff=prev&oldid=69888944}} developer's explanation]). | ||
<includeonly> | |||
<!-- ADD CATEGORIES BELOW THIS LINE --> | |||
[[Category:Template:Documentation]] | |||
<!-- ADD INTERWIKIS BELOW THIS LINE --> | |||
</includeonly> | |||
Latest revision as of 10:48, 26 March 2015
 |
This is a documentation subpage for . It contains usage information, categories and other content that is not part of the original template page. |
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>{{doc}}</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 "<", and 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.{{documentation|content=}}: for extremely simple documentation notes, enter the message desired with the|content=parameter. The text provided with this parameter appears in a box similar to the doc subpage, without any other notations in the boxes. For more complex documentation descriptions, use a full doc subpage.
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
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).