Aide:Modèle/Comment documenter un modèle ?

Une page de Wikiversité.
Sauter à la navigation Sauter à la recherche

Où documenter un modèle ?[modifier | modifier le wikicode]

La documentation d’un modèle de fait dans sa sous-page /Documentation.

Documenter un modèle dans la sous-page /Documentation[modifier | modifier le wikicode]

Cette procédure devra aussi être suivie par les administrateurs avant de bloquer un modèle très utilisé contre les modifications. Cela permet de pouvoir encore changer les catégories, ou d'améliorer sa documentation, et d'insérer les interwikis dans la sous-page.
Comment documenter dans la sous-page du modèle ?
Copiez, collez et adaptez le code ci-dessous, directement sous la source du modèle
<noinclude>{{Documentation}}</noinclude>
Puis cliquez sur « Créer » pour éditer la page. La documentation demeure globalement semblable (mais attention à l'usage différent des balises « noinclude » et il faut reporter le nom du modèle). Pour un modèle simple :
== Utilisation  ==
Indiquez quand utiliser ce modèle.

== Syntaxe  ==
<code><nowiki>{{<!-- nom du modèle -->|1|2|etc.}}</nowiki></code>
* <code>'''1'''=''valeur1''</code> ''(obligatoire)'' : description1.
* <code>'''2'''=''valeur2''</code> ''(facultatif)'' : description2 (''défaut2'' par défaut).
* etc.

== Exemple  ==
« <code><nowiki><{{<!-- nom du modèle -->|<!-- à compléter -->}}</nowiki></code> » donne
« {{<!-- nom du modèle -->|<!-- à compléter à l'identique -->}} »<!--pour un modèle simple (sur un ligne) -->

== Variantes  ==
* <nowiki>{{M|<!--nom de modèle connexe-->}}</nowiki>

== Voir aussi  ==
* [[Pages à voir]]

<includeonly>
[[Catégorie:Nom de la catégorie du modèle|]]

[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone équivalent]]
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
</includeonly>