Cette page contient des informations pour l'utilisation de Modèle:Docparam. |
![]() |
Ce modèle est basé sur du CSS
|
---|
Modèle pour les formatages standardisés des paramètres de modèles dans la documentation de modèle.
Utilisation
{{Docparam|nom=paramètre|req=oui|desc=description}}
Paramètres
<sans nom 1> ou nom
Le nom des paramètre(s). Certaines lignes sont automatiquement traduites pour permettre une spécification d'un choix alternatif ou de de distance de paramètres.
Les phrases traduites (celles-ci on besoin d'être clôturées par des espaces):
>>
est converti en "jusqu'à"; utilisée pour indiquer les extrémités du paramètre (par exemple : "Jeu 1 jusqu'à Jeu 5").//
est converti en "ou"; utilisée pour des choix alternatifs (par exemple "<Sans nom 1> or titre").++
est converti en une virgule avec un espace de fuite (", "); utilisé pour lister les paramètres séparés mais fonctionne de la même manière (par exemple "ContenuA1, ContenuB1").
default, default2
La/les valeur(s) par défaut du paramètre.
desc
Description du paramètre.
(défaut: "oui")
reqSpécifie si le paramètre est requis par le modèle pour fonctionner.
Options disponibles:
- non: Complètement optionnel.
- semi: Le paramètre est requis dans certains circonstances mais optionnel dans d'autres. Pour un intervalle de paramètres (fixés via la ligne
up to
), ceci signifie qu'au moins l'un d'entre eux est requis). - oui: Toujours requis.
Copier / coller
{{Docparam|nom=|req=|défaut=|desc= }}
Exemples
Simple
{{Docparam|nom=paramètre|req=oui|défaut=|desc= Description }}
Résulte en :
Paramètre
Description
Avancé
{{Docparam|nom=paramètre // alternative ++ similar1 >> similar3|req=non|défaut=paramètre par défaut|desc= Description }}
Résulte en :
(défaut: "paramètre par défaut")
Paramètre ou Alternatif, Similaire 1 jusqu'à Similaire 3Description
Sauf mention contraire, le contenu de la communauté est disponible sous licence CC-BY-SA.