|
|
| (153 intermediate revisions by 96 users not shown) |
| Line 1: |
Line 1: |
| {{documentation subpage}}
| |
|
| |
|
| 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==
| |
| ===Normal===
| |
| <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==
| |
| *It allows templates to be [[Wikipedia:Protection policy|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 {{peisl}}. Placing the documentation in a subpage avoids this (MediaWiki developers have <span class="plainlinks">[http://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&diff=prev&oldid=69888944 recommended]</span> it for this reason).
| |
|
| |
| ==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>
| |
