« Aide:Documentation de modèle » : différence entre les versions
m Hlm Z. a déplacé la page Aide:Comment documenter un modèle ? vers Aide:Documentation de modèle |
en attente de suppression des modèles obsolètes |
||
Ligne 224 : | Ligne 224 : | ||
=== Voir aussi === |
=== Voir aussi === |
||
* {{m|Documentation attendue}} |
* {{m|Documentation attendue}} |
||
<noinclude> |
<noinclude> |
||
[[Catégorie:Aide:Modèle|Documentation |
[[Catégorie:Aide:Modèle|Documentation]] |
||
</noinclude> |
</noinclude> |
Version du 7 septembre 2013 à 12:57
Où documenter ?
La documentation d’un modèle peut être faite :
- Soit dans la page du modèle, directement dans ce modèle : il faut placer {{Documentation modèle}} ou {{Documentation modèle compliqué}} dans la page du modèle et entre les bornes
Modèle:Balise…Modèle:Balise
. Se reporter au chapitre Comment documenter directement dans le modèle ? - Soit dans la sous-page
/Documentation
: il faut alors placer {{Documentation modèle vue directement}}, ou un autre [Quoi ?], dans la sous-page, entre les bornesModèle:Balise…Modèle:Balise
. Se reporter au chapitre Comment documenter dans la sous-page du modèle ?
En apposant {{Documentation}} dans un modèle à documenter, vous serez assisté(e) dans la création de sa sous-page de documentation.
Quand doit-on placer la documentation en sous-page ?
Il faut documenter en sous-page dans les cas suivants :
- Le modèle est très employé et utilise des paramètres qui prennent de multiples valeurs (il faut alors réduire au minimum le contenu des balises
Modèle:Balise
…Modèle:Balise
et surtout ne pas inclure la documentation directement dans le modèle). - Le modèle et/ou sa documentation sont particulièrement longs.
- On souhaite reprendre (c'est-à-dire inclure) la documentation dans une page d’aide.
- Avant de protéger un modèle, il faut déplacer sa documentation en sous-page.
Comment documenter directement dans le modèle ?
Pour documenter un modèle déjà existant, copiez-collez et adaptez l’un des codes ci-après à la fin de la source d’un modèle (c’est-à-dire juste avant son dernier saut de ligne existant, et sans aucun autre saut de ligne inutile ajouté après).
Documenter un modèle simple
Pour un « petit » modèle, sans paramètres nommés, « sur une ligne » :
<noinclude> {{Documentation modèle}} == Utilisation == <!-- Indiquez quand utiliser ce modèle. --> == Syntaxe == <code><nowiki>{{</nowiki>{{PAGENAME}}|1|2|etc.}}</code> * <code>1</code> : description1 (obligatoire). * <code>2</code> : description2 (facultatif, ''défaut2'' par défaut). * etc. == Exemple == « <code><nowiki>{{</nowiki>{{PAGENAME}}|<!-- à compléter -->}}</code> » donne « {{{{PAGENAME}}|<!-- à compléter à l’identique -->}} »<!-- pour un modèle simple (sur une ligne) --> == Variante == * {{M|<!-- nom de modèle connexe -->}} == Voir aussi == * [[<!-- Nom de page à voir -->]] [[Catégorie:Nom de la catégorie du modèle]] [[en:Template:Nom du modèle anglophone équivalent]] </noinclude>
Documenter un modèle plus complexe
Pour un modèle plus complexe, avec paramètres nommés :
<noinclude> {{Documentation modèle}} == Utilisation == <!-- Indiquez quand utiliser ce modèle. --> == Syntaxe == <nowiki>{{</nowiki>{{PAGENAME}} |paramètre1=valeur1 |paramètre2=valeur2 |paramètre3=valeur3 |etc. }} == Paramètres == * <code>paramètre1</code> : description1 (obligatoire). * <code>paramètre2</code> : description2 (facultatif, ''défaut2'' par défaut). * <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut). * etc. == Exemple == {{En-tête tableau "Code Rendu"}} |- |<pre><!-- Le même code --></pre> |<!-- Le même code --> |} == Variante == * {{M|<!-- nom de modèle connexe -->}} == Voir aussi == * [[<!-- Nom de page à voir -->]] [[Catégorie:Nom de la catégorie du modèle]] [[de:Vorlage:Nom du modèle germanophone équivalent]] </noinclude>
Formulaire de documentation préchargé
Pour disposer d’un formulaire de documentation préchargé lors de la création d’un nouveau modèle, mettez le nom de modèle de votre choix dans la boîte suivante et cliquez sur le bouton « Créer le modèle » :
Exemples de modèles bien documentés
Comment documenter dans la sous-page du modèle ?
Copiez-collez et adaptez le code ci-après directement à la fin de la source du modèle :
<noinclude> {{Documentation}}<!-- Catégories et liens interwikis en sous-page de documentation --> </noinclude>
Puis cliquez sur le lien rouge pour éditer la page. La documentation demeure globalement semblable.
Documenter un modèle simple
{{Documentation modèle en sous-page}} == Utilisation == <!-- Indiquez quand utiliser ce modèle. --> == Syntaxe == <code><nowiki>{{</nowiki>{{PAGENAME}}|1|2|etc.}}</code> * <code>1</code> : description1 (obligatoire). * <code>2</code> : description2 (facultatif, ''défaut2'' par défaut). * etc. == Exemple == « <code><nowiki>{{</nowiki>{{PAGENAME}}|<!-- à compléter -->}}</code> » donne « {{{{PAGENAME}}|<!-- à compléter à l’identique -->}} »<!-- pour un modèle simple (sur une ligne) --> == Variante == * {{M|<!-- nom de modèle connexe -->}} == Voir aussi == * [[<!-- Nom de page à voir -->]] <includeonly> <!-- Catégories et liens interwikis du modèle --> [[Catégorie:Nom de la catégorie du modèle]] [[it:Template:Nom du modèle italophone équivalent]] </includeonly>
Documenter un modèle plus complexe
{{Documentation modèle compliqué en sous-page}} == Utilisation == <!-- Indiquez quand utiliser ce modèle. --> == Syntaxe == <nowiki>{{</nowiki><!-- nom du modèle --> |paramètre1={{Param|valeur1}} |paramètre2={{Param|valeur2}} |paramètre3={{Param|valeur3}} |etc. }} == Paramètres == * <code>paramètre1</code> : description1 (obligatoire). * <code>paramètre2</code> : description2 (facultatif, ''défaut2'' par défaut). * <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut). * etc. == Exemple == {{En-tête tableau "Code Rendu"}} |- |<pre><!-- Le même code --></pre> |<!-- Le même code --> |} == Variante == * {{M|<!-- nom de modèle connexe -->}} == Voir aussi == * [[<!-- Nom de page à voir -->]] <includeonly> <!-- Catégories et liens interwikis du modèle --> [[Catégorie:Nom de la catégorie du modèle]] [[es:Plantilla:Nom du modèle hispanophone équivalent]] </includeonly>
Exemples de modèles bien documentés
Autres modèles spécifiques de documentation
- {{Documentation de carte complétée}}
- {{Documentation de modèle de point}}
- {{Documentation d'image complétée}}
- {{Documentation lien vers portail}}
- {{Documentation lien vers projet}}
- {{Documentation palette}}
- {{Documentation paramétrage de carte}}
- {{Documentation paramétrage de carte en sous-page}}