Template:TemplateBox/doc

This is a documentation subpage for (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

The template provides a uniform way to provide basic information about the use of a template.

Usage

{{TemplateBox |1= |1d= |1def= |1stat= |name= |desc= |namespace= |usergroup= |placement= |usage-notes= |type= |example= |i18n-method= |i18n-desc= |i18n-mediawiki-msg= |seealso= |setscats= |lines= |shorthand= |relieson= }}

Parameters

Parameter name	Description	Default value	required or optional?
parameter #1 (1)	parameter name (similarly 2, 3, .., up to 24)	empty	optional
1d	description of the parameter (similarly 2d, 3d, .., up to 24d)	empty	optional
1def	default value for the parameter (similarly 2def, 3def, .., up to 24def)	empty	optional
1stat	status of the parameter (similarly 2stat, 3stat, .., up to 24stat); possible values: required optional optional- optional and not present in the standard form deprecated	optional	optional
name	name of the template (needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately)	{{PAGENAME}}	required
desc	description of what the template does	empty	required
namespace	namespaces, the template is intended to be used in; possible values: all talks contents Main Talk User User talk FamilySearch Wiki FamilySearch Wiki talk File File talk MediaWiki MediaWiki talk Template Template talk Help Help talk Category Category talk Special	no namespace specified	required
usergroup	usergroup that is meant to use the template; possible values: all bot administrator admin sysop bureaucrat crat checkuser	no user group specified	required
placement	placement on the page. Possible values: top bottom licence	empty	optional
usage-notes	notes about the correct usage of the template	empty	optional
type	what type is the template (infobox, formatting, licence tag, ...)	empty	optional
example	example use (works with a single unnamed parameter only)	empty	optional
i18n-method	method the localization is achieved by. Known values: autotranslate using {{autotranslate}} or applying a similar method switch using {{LangSwitch}} in the template itself - no localization needed custommediawiki-msg using MediaWiki namespace messages mediawiki-msg using MediaWiki namespace messages, translated on TranslateWiki	empty	optional
i18n-desc	additional info about the localization	empty	optional
i18n-mediawiki-msg	When using “mediawiki-msg” as method, optionally put the name of the message here. Falls back to: `Wm-license-{{lc:{{BASEPAGENAME}}}}-text`	empty	optional
seealso	relevant links (put in a list of them)	empty	optional
setscats	what categories are automatically set by the template (put in a linked list of them)	one	optional
lines	are the parameters typically put into new lines or all on one line. Possible values: multi multiple lines one one line	empty	optional
shorthand	shorthand for easy use (redirects to main template)	empty	optional
relieson	list of templates on which the template's basic functionality relies	empty	optional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Placement:

in the '/doc' subpage of a template

Complications

A complication is that the template suppresses section editing links on the whole page of the documented template, and also on its documentation page, even for paragraphs outside the part produced by this template TemplateBox. Template:Sed can be used (as is done here) to create an edit link anyway.