This page will only parse completely when it is included in another page.
[template]documentation subpage[/template]

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 [brwiki="Transclusion"]transcluded[/brwiki] in other pages, i.e. templates, whether in the template namespace or not.
[h="2"] Usage [/h]
[h="3"] Normal /doc [/h]
[h="3"] Any /doc page [/h]
{{{{{template-name|Documentation}}}|Template:any page/doc}}
[h="3"] In-line content [/h]
{{{{{template-name|Documentation}}}|content=This is documentation.}}
[h="3"] In-line content with [view][edit] links [/h]
|1 = Template:any page/doc
|content =Template:template:any page doc
[h="3"] Best practice [/h]
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.
Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <code></code> tags. For more complex cases, see [brwiki]Template documentation?#Categories and interwiki links[/brwiki].
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "<".
[h="3"] Customizing display [/h]
Overrides exist to customize the output in special cases:
[list][*] <code>{{documentation| [b]heading[/b] = ...}}</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.
[h="2"] Functions [/h]
If the documentation page doesn't exist, the "edit" link includes a [wiki="mw:Manual:Creating pages with preloaded text"]preload[/wiki] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
[h="2"] Rationale [/h]
Use of this template allows templates to be [brwiki="Protection policy"]protected[/brwiki] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
[h="2"] See also [/h]
[template] Documentation/doc/see also [/template]

Tags for this Page

Similar Pages

  1. Documentation
    By Arjan in forum Template
    Comments: 0
    Last Post: 11-23-2008, 08:30 PM
  2. Documentation/docname
    By Arjan in forum Template
    Comments: 0
    Last Post: 11-23-2008, 08:30 PM
  3. Documentation subpage
    By Arjan in forum Template
    Comments: 0
    Last Post: 11-23-2008, 08:30 PM
  4. Template documentation
    By Arjan in forum Main
    Comments: 0
    Last Post: 11-23-2008, 07:23 PM


Posting Permissions

Posting Permissions
  • You may not create new articles
  • You may not edit articles
  • You may not protect articles
  • You may not post comments
  • You may not post attachments
  • You may not edit your comments
BIRTHRIGHT, DUNGEONS & DRAGONS, D&D, the BIRTHRIGHT logo, and the D&D logo are trademarks owned by Wizards of the Coast, Inc., a subsidiary of Hasbro, Inc., and are used by permission. ©2002-2010 Wizards of the Coast, Inc.