Modèle:Documentation

De Poképédia
Sauter à la navigation Sauter à la recherche
Miniature 201 ? RS.gifC'est quoi, un modèle ?
Informations importantes concernant ce modèle
Panneau Attention.png Ce modèle est inclus dans un très grand nombre de pages.
Il doit être modifié avec précaution !
ParserFunctions.png Ce modèle utilise les ParserFunctions.

But et contexte[modifier]

Une documentation absente, incomplète ou non à jour pose plusieurs problèmes évidents : l'utilisation du modèle est rendue plus complexe, surtout pour les nouveaux contributeurs ou lorsque le modèle est récent, et pour des raisons difficiles à défendre (fondamentalement, la flemme) on fait potentiellement perdre du temps à tout le monde. Si des modifications sont à apporter au modèle, il est beaucoup moins pratique de le faire en devant jongler avec une liste des paramètres dont certains n'existent plus ou d'autres ne sont pas mentionnés.

Ce modèle sert à taper sur les doigts des modèles dont la documentation est à revoir, et s'insère sur les sous-pages de documentation des modèles fautifs (ou les pages des modèles, si la sous-page n'existe pas). Il permet d'indiquer les défauts observés (documentation absente, incomplète, structure non-respectée, etc.) et d'encourager leur correction.

Utilisation[modifier]

Syntaxe[modifier]

Pour utiliser ce modèle, le code à utiliser suit la forme suivante : {{Documentation|sous-page=|délocalisation==|includeonly=|structure=|commentaire=}}. Une forme plus aérée peut être utilisée :

{{Documentation
| sous-page      =
| délocalisation =
| includeonly    =
| structure      =
| commentaire    =
}}

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]

Légende des icônes
Certains paramètres sont accompagnés d'une ou plusieurs icône indiquant leur(s) caractéristique(s) :
Facultatif.png : Ce paramètre est facultatif, et n'a donc pas besoin d'être systématiquement défini.
Icône catégorie.png : Ce paramètre classe automatiquement l'article dans une catégorie.
Données sémantiques.png : Ce paramètre influe sur les données sémantiques présentes en pied de page.
Paramètre Description
sous-page par défaut, sous-page de documentation absente La documentation est dans une sous-page dédiée. Indiquer oui si c'est le cas.
délocalisation par défaut, documentation, bandeaux, catégories ou liens interwiki sur la mauvaise page La documentation, les bandeaux et les catégories se trouvent tous et uniquement sur la sous-page de documentation. Indiquer oui si c'est le cas.
includeonly par défaut, code du modèle non-entouré d'une balise <includeonly> Le code du modèle est entouré d'une balise <includeonly>. Indiquer oui si c'est le cas.
structure par défaut, documentation ne suivant pas la structure standard La documentation suit la structure standard et est complète. Indiquer oui si c'est le cas.
commentaire par défaut, code du modèle non commenté Le modèle est commenté (seulement s'il est complexe). Indiquer oui si c'est le cas.

L'article est classé dans la catégorie Documentation à revoir peu importe les paramètres définis.

Exemples[modifier]

{{Documentation}} donne :

Sprite 054 RV.png Ce modèle n'est pas ou mal documenté et par conséquent, il est moins facile de le comprendre et de l'utiliser.
Pour le documenter, référez-vous à la page d'explications concernant la documentation des modèles. Merci !

{{Documentation|includeonly=oui|sous-page=oui|commentaire=oui|délocalisation=oui}} donne :

Sprite 054 RV.png Ce modèle n'est pas ou mal documenté et par conséquent, il est moins facile de le comprendre et de l'utiliser.
Pour le documenter, référez-vous à la page d'explications concernant la documentation des modèles. Merci !

Modifier ce modèle[modifier]

Miniature 201 ! RS.gifN'oubliez pas de vous référer à l'aide concernant la création et la modification des modèles ainsi qu'aux conventions !

Voir aussi[modifier]