Template:TemplateBox/doc

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=
|mustbesubst=
}}

Parameters

Parameter name	Description	Default value	required or optional?
parameter #1 (1)	parameter name (similarly 2, 3, …, up to 30)	empty	optional
1d	description of the parameter (similarly 2d, 3d, …, up to 30d)	empty	optional
1def	default value for the parameter (similarly 2def, 3def, …, up to 30def)	empty	optional
1stat	status of the parameter (similarly 2stat, 3stat, …, up to 30stat); 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 Commons Commons talk File File talk MediaWiki MediaWiki talk Template Template talk Help Help talk Category Category talk Creator Creator talk Special Any other values will show as “unknown”.	no namespace specified	required
usergroup	usergroup that is meant to use the template; possible values: all bot administrator admin sysop bureaucrat crat checkuser licensereviewer otrs autoconfirmed autopatrolled filemover oversight patroller rollbacker steward upwizcampeditors	no user group specified	required
placement	placement on the page. Possible values: top   bottom   licence   source	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
mustbesubst	Set to "yes" (or any value) if the template must be substituted. This puts "subst:" into the template example under "usage".	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

Localization

English |

This template is localized through {{Autotranslate}}. The layout of the template can be found under Template:TemplateBox/layout.

To add your language to the list of languages supported by this template, please copy the code of Template:TemplateBox/en (or any other language version you prefer to translate) and replace the text strings in there (the form below can be used to create a translation, the English version is preloaded in the edit box). Please change the parameter lang from en (or whatever language you are translating) to the language code of your language.

<inputbox> type=create preload=Template:TemplateBox/en default=Template:TemplateBox/⧼Lang⧽ </inputbox>

Complications

( NOTE : the {{sed|1}} template links appears HERE : >>> )

edit

English: 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.

---

Boarisch: A Problem is, dåss de Vurlog koa Bearbaitung in de Abschnitt mit de bekanntn Links zualässt. Des Problem ham ma sowoi in da Vurlognhauptseitn ois å auf da Dokumentationsseitn, de då dazuakeart. Dazua kinnt no, dåss'es å de heagnommane Vurlog „TemplateBox“ betrifft. Wenn ma de Vurlog Template:Sed heanimmt, is dazu a Lösung gfundn, wia ma an am Åbschnitt werkn ko.

---

Deutsch: Eine Schwierigkeit ist, dass die Vorlage eine Bearbeitung in den Abschnitten mittels des bekannten Links nicht zulässt. Dies betrifft sowohl die Vorlagenhauptseite als auch dessen Dokumentationsseite. Betroffen hiervon ist ebenso die dazu verwendete Vorlage „TemplateBox“. Mittels der Vorlage Template:Sed kann hier Abhilfe geschaffen werden, wie in diesem Abschnitt geschehen.

---

Français : Une autre complication est que le modèle de la section supprime l'édition de liens sur la page entière du modèle documenté, ainsi que sur sa page de documentation, même pour les paragraphes en dehors de la pièce produite par ce modèle TemplateBox. le modèle Template:Sed peut être utilisé (comme c'est le cas ici) pour créer quand même un lien modifier (edit).

---

Português: Uma dificuldade, é que a predefinição suprime os links para edição de secções em toda a página da predefinição documentada, e também na respectiva página de documentação, mesmo nos parágrafos que estão fora da área produzida por esta predefinição TemplateBox. Mesmo assim, a predefinição Template:Sed pode ser usada (como se faz aqui) para forçar a criação de um link de edição.