Docparam/doc

	Cette page contient les informations d'utilisation pour Modèle:Docparam.

Modèle de mise en forme normalisée des paramètres des modèles de la catégorie Documentation des modèles.

Utilisation

{{Docparam|name=parameter|req=yes|desc=description}}

Paramètres

<unnamed 1> ou name

Nom du (des) paramètre(s). Certaines chaînes de caractères sont automatiquement traduites pour permettre la spécification de choix alternatifs ou de plages de paramètres.

Les chaînes de caractères traduites (toutes doivent être entourées d'espaces) :

>> est converti en un tiret entouré d'espaces (" - ") ; il est utilisé pour indiquer des plages de paramètres (par exemple "jeu1 - jeu5").
// est converti en " ou " ; utilisé pour les choix alternatifs (par exemple "<unnamed 1> ou titre").
++ est converti en une virgule avec un espace (", ") ; utilisé pour énumérer des paramètres qui sont séparés mais fonctionnent ensemble (par exemple "contentA1, contentB1").

default, default2

La (les) valeur(s) par défaut du paramètre.

desc

Description du paramètre.

(default: "yes")

req

Précise si ce paramètre est nécessaire pour que le modèle fonctionne.

Options disponibles :

no: Entièrement facultatif.
semi: Ce paramètre est obligatoire dans certaines circonstances, mais facultatif dans d'autres. Pour une série de paramètres (définis via up to, cela signifie qu'au moins un d'entre eux est requis.
yes: Toujours requis.

Copier/coller

{{Docparam|name=|req=|default=|desc=

}}

Exemples

Simple

{{Docparam|name=parameter|req=yes|default=|desc=
Description
}}

Donne :

parameter

Description

Avancé

{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
Description
}}

Donne :

(default: "default setting")

parameter ou alternative, similar1 à similar3

Description