« Aide:Documentation de modèle » : différence entre les versions

Contenu supprimé Contenu ajouté
Nnemo (discussion | contributions)
Notamment — Accessibilité. Soyons clairs et exacts. Ce n'est pas documenter sous le modèle, ni même après le modèle. C'est documenter directement dans le modèle.
Nnemo (discussion | contributions)
Aucun résumé des modifications
Ligne 2 :
 
La documentation d’un modèle peut être faite :
* Soit dans la page du modèle, '''directement dans ce modèle''' : il faut placer {{m|Documentation modèle}} ou {{m|Documentation modèle compliqué}} dans la page du modèle et entre les bornes {{nobr|<code>{{Balise|noinclude}}…{{Balise|/noinclude}}</code>}}. Se reporter au [[#Comment documenter directement dans le modèle &nbsp;?|chapitre ''Comment documenter directement dans le modèle &nbsp;?'']]
* Soit '''dans la sous-page <code>/Documentation</code>''' : il faut alors placer {{m|Documentation modèle vue directement}}, ou un autre {{quoi}}, dans la sous-page, entre les bornes {{nobr|<code>{{Balise|noinclude}}…{{Balise|/noinclude}}</code>}}. Se reporter au [[#Comment documenter dans la sous-page du modèle &nbsp;?|chapitre ''Comment documenter dans la sous-page du modèle &nbsp;?'']]
 
En apposant {{m|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 &nbsp;? ====
 
Il faut documenter en sous-page dans les cas suivants :
Ligne 15 :
* '''Avant de protéger un modèle''', il faut déplacer sa documentation en sous-page.
 
=== Comment documenter directement dans le modèle &nbsp;? ===
 
Pour documenter un modèle déjà existant, [[copier-coller|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).
Ligne 119 :
* [[Modèle:Voir l'aide]] (variante)
 
=== Comment documenter dans la sous-page du modèle &nbsp;? ===
 
[[Copier-coller|Copiez-collez]] et '''adaptez''' le code ci-après '''directement''' à la fin de la source du modèle :