 |
Cette page contient des usage Modèle:Docparam. |
|---|
Modèle de mise en forme normalisée de paramètres de modèle dans template documentation.
Son utilisation[]
{{Docparam|name = parameter|req = yes|desc = description}}
Paramètres[]
< 1 sans nom > / / name
Nom des ou les paramètres. Certaines chaînes sont automatiquement traduites pour permettre une spécification des choix alternatifs ou des plages de paramètre.
Traduit des chaînes (tous celles-ci doivent être entourées d’espaces) :
>est converti en un tableau de bord avec espaces autour d’elle ("-") ; utilisé pour indiquer des plages de paramètre (en p. ex. « Jeu1 - game5")./ /est converti en « ou » ; utilisé pour les solutions de remplacement (par exemple "< sans nom 1 > ou titre »).++est converti en une virgule avec un espace de fin (",") ; utilisé pour la liste des paramètres qui sont séparés mais fonctionnent de la même (par exemple "contentA1, contentB1").
par défaut, default2
Les valeurs par défaut du paramètre.
desc
Description du paramètre.
(default: "yes")
reqIndique si ce paramètre est nécessaire pour le modèle de la fonction.
Options disponibles :
- « non »: entièrement facultative.
- semi: paramètre est requis dans certaines circonstances, mais facultative dans d’autres. Pour une série de paramètres (réglée via
jusqu'à, cela signifie qu’au moins un d'entre eux est nécessaire. - Oui : toujours requis.
De copier/coller[]
{{Docparam|name = |req = |défaut = |desc =
}}
Exemples[]
Simple[]
{{Docparam|name = parameter|req = yes|default = |desc =
Description
}}
résultats dans :
parameter
Description
Advanced[]
{{Docparam|name = paramètre / / alternative ++ similar1 >> similar3|req = no|default = par défaut setting|desc =
Description
}}
résultats dans :
(default: "par défaut setting")
paramètre / / alternative, similar1 up to similar3Description
Crédit et propriétaire[]
Ce modèle et tous les modèles associés à celle-ci a été initialement faite par utilisateur: Porter21 ([[1]]), sur le Wiki de Fallout.