Modèle:Documentation

C'est quoi, un modèle ?  • Accéder à la page de documentation de ce modèle

Informations importantes concernant ce modèle

Ce modèle est inclus dans un très grand nombre de pages. Il doit être modifié avec précaution ! Ce modèle utilise les ParserFunctions.

But et contexte

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

Syntaxe

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

Légende des icônes

Certains paramètres sont accompagnés d'une ou plusieurs icône indiquant leur(s) caractéristique(s) :  : Ce paramètre est facultatif, et n'a donc pas besoin d'être systématiquement défini.  : Ce paramètre classe automatiquement l'article dans une catégorie.  : Ce paramètre influe sur les données sémantiques présentes en pied de page.

Paramètre	Description
sous-page	La documentation est dans une sous-page dédiée. Indiquer oui si c'est le cas.
délocalisation	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	Le code du modèle est entouré d'une balise <includeonly>. Indiquer oui si c'est le cas.
structure	La documentation suit la structure standard et est complète. Indiquer oui si c'est le cas.
commentaire	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

{{Documentation}} donne :

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 ! Ce modèle devrait avoir une sous-page de documentation. La documentation, les bandeaux, les catégories et les liens interwiki devraient se trouver sur la sous-page de documentation. Le code du modèle devrait être entouré d'une balise <includeonly>. La documentation ne suit pas la structure standard ou est inexistante/incomplète. Le modèle est complexe et il n'y a aucun commentaire.

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

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 ! La documentation ne suit pas la structure standard ou est inexistante/incomplète.

• Utilisation en situation réelle pour le modèle Nobr.

Modifier ce modèle

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

• Le bandeau Documentation est utilisé sur plus de 200 pages.
• Plusieurs ParserFunctions sont mises à profit.

Voir aussi

• 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.
• {{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.
• {{Paramètre}}, pour déclarer un paramètre et les icônes associées dans la documentation d'un modèle.
• {{Avertissement Modèle}}, pour afficher des avertissements (très utilisé, protégé, etc.) concernant les modèles.
• Projet Fondations : Documentation des modèles, le projet à l'origine du modèle, inclus dans le projet Fondations.