Template:Documentation/doc

From TrainzOnline
< Template:Documentation(Difference between revisions)
Jump to: navigation, search
m (fmt TOC)
(fix cats)
 
Line 2: Line 2:
 
{{TOCright}}
 
{{TOCright}}
 
{{timw|Documentation}}
 
{{timw|Documentation}}
 +
[[Category:Template documentation pages|*{{PAGENAME}}]]
 
</noinclude>
 
</noinclude>
  
Line 38: Line 39:
 
<!-- for the template  -->
 
<!-- for the template  -->
 
<includeonly>
 
<includeonly>
[[Category:Template documentation| ]]
+
[[Category:Template documentation pages|{{PAGENAME}}]]
 
[[Category:Formatting templates|Template documentation]]<!--XXX kill interwiki's
 
[[Category:Formatting templates|Template documentation]]<!--XXX kill interwiki's
  

Latest revision as of 01:49, 6 July 2013



 
It contains usage information, categories and other informational content that is best arranged so that it is not part of the original template page, such as in many cases, examples of how to use the template in question.
  • Documentation subpages were developed to reduce server demands, or to protect the code version of widely used templates.
     

Contents

Template:Documentation


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.

[edit] Usage

[edit] 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 "&lt;".

[edit] 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.

[edit] 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.

[edit] 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).

[edit] See also

Personal tools