Modèle:Paramètre/Documentation
|
But et contexte[modifier]
Ce modèle sert à définir précisément chaque paramètre d'un modèle dans sa documentation. Il permet d'indiquer qu'un paramètre est facultatif (et si oui, ce qui se passe s'il n'est pas précisé), s'il classe l'article où est inclus le modèle dans une catégorie (et laquelle), ou encore si le paramètre qualifie l'information (les données qualifiées sont visibles en pied de page de l'article). Il doit être utilisé sur toutes les pages de documentation des modèles dès qu'ils possèdent un paramètre, dans la section « Utilisation ».
De plus, il met automatiquement en place une ancre avec le nom du paramètre. Ainsi, il est possible de donner un lien vers la page de documentation d'un modèle, qui mènera directement au niveau du paramètre : [[Modèle:Nom du modèle#Nom du paramètre]].
Utilisation[modifier]
Syntaxe[modifier]
Pour utiliser ce modèle, le code à utiliser suit la forme suivante : {{Paramètre|nom|facultatif=|catégorie=|donnée=}}. Une forme plus aérée peut être utilisée :
{{Paramètre
| nom
| facultatif =
| catégorie =
| donnée =
}}
L'ordre des paramètres n'a pas d'importance. Pour renseigner un paramètre, sa valeur doit être inscrite après le symbole =.
Paramètres[modifier]
Certains paramètres sont accompagnés d'une ou plusieurs icône indiquant leur(s) caractéristique(s) :
|
| Paramètre | Description |
|---|---|
| 1 | Le nom du paramètre. S'il s'agit d'un paramètre sans nom ({{{1}}} par exemple), mettre le numéro.
|
facultatif 
|
Le paramètre est facultatif, et n'a donc pas besoin d'être systématiquement défini. Indiquer le comportement par défaut (c'est-à-dire si le paramètre n'est pas précisé). |
| catégorie
|
Le paramètre classe automatiquement l'article dans une catégorie. Indiquer le nom de la catégorie en question. |
| donnée
|
Le paramètre influe sur les données sémantiques présentes en pied de page. Indiquer le nom de la donnée définie. |
Exemples[modifier]
{{Paramètre|nom}} donne : nom
{{Paramètre|miniature|facultatif=par défaut, pas de miniature}} donne : miniature
{{Paramètre|gén-1|catégorie=Objet de la première génération|donnée=Génération de l'objet}} donne : gén-1 
{{Paramètre|série|facultatif=par défaut, objet de la série principale|donnée=Objet de la série}} donne : série
- Utilisation en situation réelle pour la documentation de l'infobox objet.
Modifier ce modèle[modifier]
N'oubliez pas de vous référer à l'aide concernant la création et la modification des modèles ainsi qu'aux conventions !- Plusieurs ParserFunctions sont mises à profit.
Voir aussi[modifier]
- {{Légende paramètres}}, pour insérer une légende concernant les icônes utilisées autour des paramètres dans la documentation des modèles.
- {{Avertissement Modèle}}, pour afficher des avertissements (très utilisé, protégé, etc.) concernant les modèles.
- {{Renvoi Aide modèle}}, pour insérer le bandeau de renvoi vers l'aide concernant les modèles.
- {{Renvoi Modification modèle}}, pour insérer le bandeau de renvoi vers l'aide concernant la création ou la modification des modèles et les conventions des modèles.
- Aide et consignes pour la documentation des modèles.
- Aide et consignes pour la création/modification de modèles.
- Aide générale concernant les modèles.
- Projet Fondations : Documentation des modèles, le projet à l'origine du modèle, inclus dans le projet Fondations.