Template:TemplateBox/doc

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:TemplateBox.

---

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

Español: Esta plantilla es utilizada para describir la información sobre la que se esta utilizando.

Français : Ce modèle permet d’avoir une présentation uniforme des informations de base sur l’utilisation d’un modèle.

Italiano: Il modello fornisce un modo uniforme per fornire informazioni di base circa l'uso di un modello.

Nederlands: Dit sjabloon dient om op een uniforme wijze basisinformatie over het gebruik van een sjabloon te verschaffen.

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

Template parameters

Parameter	Description		Default	Status
1	English: parameter name (up to 20, 1, 2, ...) Français : Nom du paramètre (jusqu’à 20 : 1, 2, ..., 20).		empty	optional
1d	English: description of the parameter (up to 20, 1d, 2d, ...) Français : Description du paramètre (jusqu’à 20 : 1d, 2d, ..., 20d).		empty	optional
1def	English: default value for the first specified parameter (1def, 2def, ..., 20def) Français : Valeur par défaut du paramètre (jusqu’à 20 : 1def, 2def, ..., 20def)		empty	optional
1stat	English: Status of the parameter. Possible values: Français : Statut du paramètre. Valeurs possibles : required, optional, optional- [optional and not present in the standard form], deprecated)		optional	optional
name	English: name of the template Français : Nom du modèle		{{PAGENAME}}	required
desc	English: description of what the template does Français : Description de ce que fait le modèle		empty	required
namespace	English: namespaces, the template is intended to use in Français : Espaces de noms pour lesquels le modèle est prévu		empty	required
usergroup	English: usergroup that is meant to use the template Français : Groupes d'utilisateurs pour lesquels le modèle est prévu		empty	required
placement	English: placement on the page. Possible values: Français : Emplacement sur la page. Valeurs possibles : top, bottom, licence		empty	optional
usage-notes	English: notes about the correct usage of the template Français : Remarques sur l’utilisation du modèle		empty	optional
type	English: what type is the template (infobox, formatting, licence tag, ...) Français : Le type du modèle		empty	optional
example	English: example use (just write down the parameters, separated by {{!}}) Français : Exemple d’utilisation du modèle (écrire les paramètres à la suite, séparés par {{!}})		empty	optional
i18n-method	English: method the localization is achieved by. Known values: Français : Méthode utilisée pour l’internationalisation. Valeurs possible : autotranslate using {{Autotranslate}} 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	English: additional info about the localization Français : Informations complémentaires sur l’internationalisation		empty	optional
i18n-mediawiki-msg	English: When using "mediawiki-msg" as method, optionally put the name of the message here. Falls back to: Nederlands: Als "mediawiki-msg" de gekozen methode is, kan in deze parameter de naamcode van het bericht ingesteld worden. Standaard is dit: Wm-license-{{lc:{{BASEPAGENAME}}}}-text		empty	optional
seealso	English: relevant links (put in a list of them) Français : Une liste de liens pertinents		empty	optional
setscats	English: what categories are automatically set by the template (put in a linked list of them) Français : Liste des catégories placées par le modèle		one	optional
lines	English: are the parameters typically put into new lines or all on one line ("multi": multiple lines, "one": one line). Français : Les paramètres sont-ils généralement mis en une ligne ou en plusieurs (multi ou one).		empty	optional
shorthand	English: shorthand for easy use (redirects to main template) Français : Raccourci pour une utilisation simplifiée (redirections vers le modèle)		empty	optional
relieson	English: list of templates on which the template's basic functionality relies Français : List de modèles sur lesquels le modèle repose.		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:

English: in the '/doc' subpage of a template

Français : dans la sous-page « /doc » d’un modèle

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.