|
|
| (134 intermediate revisions by 88 users not shown) |
| Line 1: |
Line 1: |
| {{documentation subpage}}__NOTOC__
| |
| 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 /doc===
| |
|
| |
| <noinclude>{{{{{template-name|Documentation}}}}}</noinclude>
| |
|
| |
| ===Any /doc page===
| |
|
| |
| <noinclude>{{{{{template-name|Documentation}}}|Template:any page/doc}}</noinclude>
| |
|
| |
| ===In-line content===
| |
|
| |
| <noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude>
| |
|
| |
| ===In-line content with [view][edit] links===
| |
|
| |
| <noinclude>{{{{{template-name|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 "<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 <code><includeonly> </includeonly></code> 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:
| |
| * <code>{{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.
| |
|
| |
| ==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==
| |
| Use of this template allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
| |
|
| |
| ==See also==
| |
| {{ Documentation/doc/see also }}
| |
|
| |
| === Other similar templates ===
| |
| * {{tl|Usage of template}} for a similar documentation template, but redesigned and appears yellow instead of blue.
| |
| <!-- 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ó]]
| |
| [[ja:Template:Documentation]]
| |
| [[ko:틀:틀 설명문서]]
| |
| [[nl:Sjabloon:Sjabdoc]]
| |
| [[pt:Predefinição:Instruções da predefinição]]
| |
| [[ru:Шаблон:Doc]]
| |
| [[sl:Predloga:Dokumentacija]]
| |
| [[uk:Шаблон:Doc]]
| |
| [[zh:Template:Template doc]]
| |
| </includeonly>
| |
