Modification de Aide:Documenter un modèle
La modification peut être annulée. Veuillez vérifier les différences ci-dessous pour voir si c’est bien ce que vous voulez faire, puis publier ces changements pour finaliser l’annulation de cette modification.
Version actuelle | Votre texte | ||
Ligne 65 : | Ligne 65 : | ||
D'autres détails peuvent être mentionnées, comme l'importance des majuscules du nom du modèle ou de certains paramètres. | D'autres détails peuvent être mentionnées, comme l'importance des majuscules du nom du modèle ou de certains paramètres. | ||
Une deuxième et dernière sous-section nommée '''Paramètres''' contient, comme son nom l'indique, la liste des paramètres, tous définis précisément. Elle commence par l'insertion du [[Modèle:Légende paramètres|modèle Légende paramètres]]. Si le modèle est divisé en sections (cas des infoboxes, mais aussi des modèles imbriqués où toutes les parties du | Une deuxième et dernière sous-section nommée '''Paramètres''' contient, comme son nom l'indique, la liste des paramètres, tous définis précisément. Elle commence par l'insertion du [[Modèle:Légende paramètres|modèle Légende paramètres]]. Si le modèle est divisé en sections (cas des infoboxes, mais aussi des modèles imbriqués où toutes les parties du modèles incluent la même et unique documentation), alors la liste des paramètres est composée d'autant de parties. Chacune contient un tableau où chaque ligne correspond à un paramètre, avec une description, les valeurs attendues (et s'ils nécessitent une valeur particulière d'un autre paramètre pour apparaître, comme dans le cas des concours/super concours pour les attaques) ainsi que la forme attendue si elle est particulière (lien wiki, présence ou non de l'extension pour un fichier, etc). Une [[:Catégorie:Icône de documentation de modèle|série d'icônes]] est utilisée afin d'indiquer s'ils sont facultatifs, s'ils classent l'article dans certaines catégories ou s'ils définissent des [[Aide:Données sémantiques|données sémantiques]]. Le [[Modèle:Paramètre|modèle Paramètre]] doit être mis en œuvre pour cela. Un exemple de paramètres documentés pourrait être : | ||
{{{!}} class="tableaustandard" | {{{!}} class="tableaustandard" | ||
Ligne 87 : | Ligne 87 : | ||
Une dernière partie est optionnelle : '''Voir aussi''' listant les modèles utilisés ensemble dans le cas des [[Aide:Modèle#Modèles imbriqués|modèles imbriqués]], ou d'autres types de pages en relation avec le modèle (projets, <tt>Poképédia:</tt>). | Une dernière partie est optionnelle : '''Voir aussi''' listant les modèles utilisés ensemble dans le cas des [[Aide:Modèle#Modèles imbriqués|modèles imbriqués]], ou d'autres types de pages en relation avec le modèle (projets, <tt>Poképédia:</tt>). | ||
===Catégories et liens | ===Catégories et liens interwiki=== | ||
Après les différentes sections, les '''catégories''' et les '''liens | Après les différentes sections, les '''catégories''' et les '''liens interwiki''' sont ajoutés. Tout d'abord, les catégories concernant le modèle lui-même sont insérées dans une balise <code><nowiki><includeonly></nowiki></code>. Dans cette même balise doivent être placés les liens interwiki, si des équivalents sur les [[Encyclopaediae Pokémonis|wikis d'Encyclopaediae Pokémonis]] existent. Pour finir, la documentation du modèle a droit à sa propre catégorie, [[:Catégorie:Aide de modèle|Aide des modèles]], placée dans une balise <code><nowiki><noinclude></nowiki></code> afin de ne pas catégoriser le modèle lui-même. | ||
Pour plus d'informations sur les liens interwikis, voir [[Aide:Liens interwikis]]. | Pour plus d'informations sur les liens interwikis, voir [[Aide:Liens interwikis]]. | ||
Ligne 98 : | Ligne 98 : | ||
Le bandeau est inséré à l'aide du [[Modèle:Documentation|modèle Documentation]]. Il est absent si la documentation est — théoriquement — aux normes et à jour. Dans le cas contraire, il est inclus avec les autres bandeaux sur la sous-page de documentation du modèle concerné, et indique que [[:Catégorie:Documentation à revoir|la documentation est absente ou à revoir]]. Par défaut, le bandeau liste tous les problèmes que peut rencontrer une documentation : | Le bandeau est inséré à l'aide du [[Modèle:Documentation|modèle Documentation]]. Il est absent si la documentation est — théoriquement — aux normes et à jour. Dans le cas contraire, il est inclus avec les autres bandeaux sur la sous-page de documentation du modèle concerné, et indique que [[:Catégorie:Documentation à revoir|la documentation est absente ou à revoir]]. Par défaut, le bandeau liste tous les problèmes que peut rencontrer une documentation : | ||
*La sous-page de documentation n'existe pas (paramètre <code>sous-page</code>), | *La sous-page de documentation n'existe pas (paramètre <code>sous-page</code>), | ||
*La documentation, les bandeaux, les catégories et/ou les liens | *La documentation, les bandeaux, les catégories et/ou les liens interwiki ne se trouvent pas sur la sous-page de documentation (paramètre <code>délocalisation</code>), | ||
*Le code du modèle n'est pas entouré par une balise <code><nowiki><includeonly></nowiki></code> (paramètre <code>includeonly</code>), | *Le code du modèle n'est pas entouré par une balise <code><nowiki><includeonly></nowiki></code> (paramètre <code>includeonly</code>), | ||
*La documentation ne suit pas la structure standard (définie plus haut) ou est inexistante/incomplète (paramètre <code>structure</code>), | *La documentation ne suit pas la structure standard (définie plus haut) ou est inexistante/incomplète (paramètre <code>structure</code>), |