Template:Documentation/doc

Description

This template is used to insert descriptions on template pages.

Syntax

Type <noinclude>{{documentation}}</noinclude> at the end of the template page.

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.

Dependencies

• Module:Documentation

TemplateData

This template is used to insert descriptions on template pages.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Custom Documentation Page	1	Page containing the documentation Default {{FULLPAGENAME}}/doc	Page name	optional
Force localised subpage	i18n	Forces the use of `/doc/<lang>` pages even for English documentation (unless `/doc` exists and `/doc/en` does not) Default 0 Auto value 1	Boolean	optional
Ignore the current language	ignoreCurrentLang	Ignores the current language, so that wikis in a single language use `/doc` pages only Default 0	Boolean	optional
Heading	heading	Custom heading Default [[File:Template-info.svg|50px|link=|alt=Documentation icon]] Documentation Auto value	Line	optional
Preload Page	preload	The page to preload if the `/doc` subpage doesn't exist. Default Template:Documentation/preload	Page name	optional
Content	content	Custom documentation content, prevents transclusion of `/doc` subpage.	Content	optional