Template:Documentation/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
← Older edit
>The Obento [email protected]
Ned Scott (talk | contribs)
15,105 edits
Blanked the page
 
(137 intermediate revisions by 91 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>&lt;noinclude&gt;</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 <tt>&lt;includeonly&gt; &lt;/includeonly&gt;</tt> tags.
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;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==
*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.
*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 reduces the wikitext for documentation on the template page itself to a template call and noinclude tags. MediaWiki developers have <span class="plainlinks">[http://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&diff=prev&oldid=69888944 recommended]</span> this system for this reason.
==See also==
{{ Documentation/doc/see also }}
{{tl|Usage of template}} for a similar documentation, 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>

Latest revision as of 05:25, 14 November 2011

Retrieved from "https://kodi.wiki/index.php?title=Template:Documentation/doc&oldid=40153"