Community Central
Advertisement
This is a template documentation subpage for Template:Documentation. It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

Description[]

This is the {{documentation}} template, used on many templates for displaying instructions, information, mw:Help:TemplateData, and such. See Help:Template documentation for additional information.

This template displays two headers like you see now, with the documentation tools at the top, and a link box at the bottom. It automatically loads content from the /doc subpage.

General usage[]

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>

Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).

The line break is also useful as it helps prevent the documentation template "running into" previous code.

TemplateData[]

This template is used to insert descriptions on template pages.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Custom Documentation Page1

Page containing the documentation

Default
{{FULLPAGENAME}}/doc
Page nameoptional
Headingheading

Custom heading

Default
[[File:Template-icon.svg|50px|link=|alt=Documentation icon]] Documentation
Auto value
Lineoptional
Preload Pagepreload

The page to preload if the `/doc` subpage doesn't exist.

Default
Template:Documentation/preload
Page nameoptional
Contentcontent

Custom documentation content, prevents transclusion of `/doc` subpage.

Contentoptional
Advertisement