Modification de Projet:Fondations/Documentation des modèles
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 56 : | Ligne 56 : | ||
===Contenu de la sous-page de documentation=== | ===Contenu de la sous-page de documentation=== | ||
En premier lieu | En premier lieu, les bandeaux pertinents sont ajoutés (notamment les [[Modèle:Avertissement Modèle|avertissements spécifiques aux modèles]]). Ensuite, différentes sections doivent obligatoirement être présentes : | ||
*But et contexte | *But et contexte | ||
Ligne 112 : | Ligne 112 : | ||
La section '''Exemples''' enfin donne un code avec des valeurs réalistes pour les paramètres et le rendu de celui-ci. Plusieurs exemples peuvent être donnés, surtout en cas de différences significatives. Enfin une liste de liens vers des articles représentatifs de l'utilisation du modèle en situation réelle termine cette section. | La section '''Exemples''' enfin donne un code avec des valeurs réalistes pour les paramètres et le rendu de celui-ci. Plusieurs exemples peuvent être donnés, surtout en cas de différences significatives. Enfin une liste de liens vers des articles représentatifs de l'utilisation du modèle en situation réelle termine cette section. | ||
Enfin, la dernière partie obligatoire, '''Modifier ce modèle''' donne des indications à destination de ceux souhaitant modifier le modèle. Elle | Enfin, la dernière partie obligatoire, '''Modifier ce modèle''' donne des indications à destination de ceux souhaitant modifier le modèle. Elle permet notamment de préciser quels autres modèles sont utilisés dans le code du modèle courant et de préciser les avertissements déjà mis en bandeau concernant le modèle (comme les [[Aide:ParserFunctions|parsers functions utilisées]] ou le [[Spécial:Pages_liées|nombre approximatif de pages sur lesquelles le modèle est inclus]]) ou encore d'indiquer les [[MediaWiki:Common.css|classes CSS particulières]] mises à profit. | ||
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]], une courte série de [[Aide:Modèle#Modèles apparentés|modèles apparentés]] (<code>[[Modèle:!/Archive|<nowiki>{{!}}</nowiki>]]</code>, <code>[[Modèle:!!|<nowiki>{{!!}}</nowiki>]]</code> et <code>[[Modèle:!-|<nowiki>{{!}}-</nowiki>]]</code> par exemple) 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]], une courte série de [[Aide:Modèle#Modèles apparentés|modèles apparentés]] (<code>[[Modèle:!/Archive|<nowiki>{{!}}</nowiki>]]</code>, <code>[[Modèle:!!|<nowiki>{{!!}}</nowiki>]]</code> et <code>[[Modèle:!-|<nowiki>{{!}}-</nowiki>]]</code> par exemple) ou d'autres types de pages en relation avec le modèle (projets, <tt>Poképédia:</tt>). | ||
Ligne 161 : | Ligne 161 : | ||
<div style="margin: auto; width: 75%; text-align: left; font-weight: normal;"> | <div style="margin: auto; width: 75%; text-align: left; font-weight: normal;"> | ||
*<s>Définir une structure pour la documentation des modèles,</s> | *<s>Définir une structure pour la documentation des modèles,</s> | ||
*Rédiger les pages d'aide utiles : [[Aide:Modèle|C'est quoi un modèle]], [[Aide: | *Rédiger les pages d'aide utiles : [[Aide:Modèle|C'est quoi un modèle]], [[Aide:Création d'un modèle|Créer un modèle]], [[Aide:Documenter un modèle|Documenter un modèle]], | ||
*Documenter tous les modèles existants de cette façon : | *Documenter tous les modèles existants de cette façon : | ||
**Déplacer les catégories, les liens interwiki et les documentations existantes dans la sous-page /Documentation, | **Déplacer les catégories, les liens interwiki et les documentations existantes dans la sous-page /Documentation, |