Modèle:Docparam/doc

Documentation

[purge]

Modèle pour standardiser les paramètres dans les modèles de mise en forme.

Utilisation

{{Docparam|name=paramètre|req=yes|desc=description}}

Paramètres

Fichier:Icon required.png

<sans nom 1> ou nom

Nom des paramètres(s). Certaines données sont automatiquement traduites pour réduire le nombre d'arguments ou utiliser des termes pertinents.

Paramètres traduits (ils doivent être séparés par des espaces):

• >> est remplacé par un tiret séparé par des espaces (" - "); utilisé pour préciser la variété des paramètres (par ex. "game1 - game5").
• // est converti en " ou "; utilisé pour formuler une alternative (par ex. "<sans nom 1> ou le titre").
• ++ est converti en virgule suivie d'un espace (", "); utilisé pour séparer des paramètres qui ont la même valeur (par ex. "contentA1, contentB1").

Fichier:Icon optional.png

défaut, défaut2

La ou les valeurs par défaut de ces paramètres.

Fichier:Icon required.png

desc

Description du paramètre.

Fichier:Icon semi-required.png

(default: "oui")

req

Précise si le paramètre est nécessaire au bon fonctionnement du modèle.

Options:

• no: complètement optionnel.
• semi: Parfois nécessaire, parfois non. Selon la variété des paramètres (choisi avec up to, veut dire qu'au moins un des paramètres est nécessaire.
• yes: toujours requis.

Copier-coller

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

}}

Exemples

Simple

{{Docparam|name=paramètre|req=oui|default=|desc=
Description
}}

donne:

Fichier:Icon required.png

paramètre

Description

Avancé

{{Docparam|name=paramètre // alternatif ++ similaire1 >> similar3|req=no|default=choix par défaut|desc=
Description
}}

donne:

Fichier:Icon optional.png

(default: "choix par défaut")

paramètre ou alternatif, similaire1 voire similaire3

Description

Ceci est une page documentaire, elle devrait être transcluse dans le modèle principal. Voir Modèle:Doc pour de plus amples renseignements.