Difference between revisions of "Template:Documentation/doc"
(→Explanation: not really "hidden" but discarded) |
(from w:) |
||
| Line 1: | Line 1: | ||
| − | + | {{documentation subpage}}<includeonly>{{intricate}}</includeonly> | |
| − | {{ | + | {{merge|Template doc|date=October 2007|Template talk:Template doc}} |
| + | |||
| + | 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. | ||
==Usage== | ==Usage== | ||
| − | === | + | ===Normal=== |
| − | + | <pre> | |
| − | <pre><noinclude>{{documentation}}</noinclude></pre> | + | <noinclude>{{documentation}}<noinclude> |
| + | or <noinclude>{{documentation|template:any page/doc}}<noinclude> | ||
| + | </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. | ||
| + | |||
| + | 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 "&lt;". | ||
| + | |||
| + | ===Customizing display=== | ||
| + | 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. | ||
| + | |||
| + | ==Functions== | ||
| + | If the documentation page doesn't exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|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 [[Wikipedia:Template limits|technical limitation of templates]] (see a [{{fullurl:Project:Village pump (technical)|diff=prev&oldid=69888944}} developer's explanation]). | |
| − | + | ||
| − | + | ==See also== | |
| + | * {{tiw|template doc}} (similar template with more documentation; see [[User:Pathoschild/Sandbox|template comparison]]) | ||
| + | * {{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]]}}) | ||
| + | *{{tim|Documentation}} | ||
| − | + | <!-- for the template --> | |
| − | + | <includeonly> | |
| + | [[Category:Template documentation| ]] | ||
| + | [[Category:Formatting templates|Template documentation]] | ||
| − | + | [[eo:Ŝablono:Dok]] | |
| + | [[es:Plantilla:Uso de plantilla]] | ||
| + | [[fr:Modèle:Documentation modèle]] | ||
| + | [[hsb:Předłoha:Doc]] | ||
| + | [[hu:Sablon:Sablondokumentáció]] | ||
| + | [[ko:틀:틀 설명문서]] | ||
| + | [[nl:Sjabloon:Sjabdoc]] | ||
| + | [[ru:Шаблон:Doc]] | ||
| + | [[sl:Predloga:Dokumentacija]] | ||
| + | [[uk:Шаблон:Doc]] | ||
| + | [[zh:Template:Template doc]] | ||
| + | </includeonly> | ||
<!-- for the template --> | <!-- for the template --> | ||
Revision as of 06:23, 20 October 2007
Template:Documentation subpage Template:Merge
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
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
- w:Template:template doc (similar template with more documentation; see template comparison)
- w:Template:documentation subpage (replaces older {{Template doc page viewed directly}} and {{Template doc page transcluded}})
- m:Template:Documentation
