Template:Documentation/doc

From OpenStreetMap Wiki
Jump to: navigation, search

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

In-line content without [view][edit] links
  • <noinclude>{{Documentation| content = This is documentation. }}</noinclude>; Normal /doc with [view][edit] links * <code style="font-size:87%;line-height:normal"><nowiki><noinclude>{{Documentation}}</noinclude>
Any /doc page
Any /doc page with optional parameters
  • <noinclude>{{Documentation|Template:any page/doc|parameter1|parameter2|parameter3}}</noinclude>
  • <noinclude>{{Documentation|Template:any page/doc
    | p1 = paramname1 | v1 = paramvalue1
    | p2 = paramname2 | v2 = paramvalue2
    | p3 = paramname3 | v3 = paramvalue3
    }}</noinclude>
  • <noinclude>{{Documentation|Template:any page/doc| content = {{Template:any page/doc|optional parameters...}} }}</noinclude>

Best practice

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.

Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <includeonly> </includeonly> tags. For more complex cases, see w:Wikipedia:Template documentation#Categories and interwiki links.

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:

  • {{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

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.