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

Contenu supprimé Contenu ajouté
Hlm Z. (discussion | contributions)
MàJ
Nnemo (discussion | contributions)
Notamm. détails, air, accessibilité, corr., liens
Ligne 1 :
[[Fichier:Template-info.png|droite|150px|alt=Documentation du modèle|link=]]
 
Les [[Aide:Modèle|modèles]] sont accessibles en édition par tous les contributeurs. Les nouveaux utilisateurs et même les utilisateurs expérimentés peuvent avoir des difficultés à comprendre certains modèles. C'est pourquoi il est nécessaire de les documenter pour améliorer l'utilisabilité. La [[Documentation logicielle|documentation]] doit expliquer clairement ce que fait le modèle et comment l'utiliser. Un utilisateur sans connaissance particulière avec la [[Aide:Syntaxe|syntaxe]] des modèles de [[Aide:MediaWiki|MediaWiki]] doit pouvoir utiliser ce modèle correctement.
 
Ligne 6 ⟶ 7 :
 
== Utilisation ==
 
La documentation d'un modèle peut être faite :
* Soit [[#Dans la page du modèle|directement dans la page du modèle]],
* Soit [[#En sous-page dédiée|dans la sous-page du modèle]] /Documentation.
 
=== Dans la page du modèle ===
 
Il est possible d'inclure le contenu de la documentation directement dans le corps du modèle. Pour ce faire, il faut placer en basfin de page du modèle :
<pre><noinclude>{{Documentation|contenu=
 
Ligne 20 ⟶ 23 :
 
<!-- Catégories pour le modèle -->
 
</noinclude></pre>
 
Note :
Notes :
* L'inclusion de la documentation dans la page du modèle est utile lorsque le modèle est simple.
* Si le modèle est protégé, le contenu de la documentation doit obligatoirement être déplacée en sous-page /Documentation.
* Le modèle {{m|Documentation}} doit obligatoirement être borné avec les balises <nowiki><noinclude>...</noinclude></nowiki> pour éviter l'inclusion de celui-ci lors de l'appel du modèle.
* Le paramètre <code><nowiki>|contenu=</nowiki></code> ne prend pas en charge la syntaxe MediaWiki des tableaux. Pour résoudre ce problème, il est nécessaire de transformer la syntaxe MediaWiki en code [[HTML]] ou alors de transférer le contenu de la documentation en sous-page /Documentation.
 
=== En sous-page dédiée ===
 
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 <nowiki><noinclude>...</noinclude></nowiki> et surtout ne pas inclure la documentation directement dans le modèle).
Ligne 34 ⟶ 40 :
* Avant de protéger un modèle, il faut déplacer sa documentation en sous-page.
 
Pour documenter convenablement un modèle, il faut placer en basfin de page du modèle :
<pre><noinclude>{{Documentation}}</noinclude></pre>
Puis cliquez sur le lien [créer] pour précharger le format de base d'une page de documentation.
 
NoteNotes :
* L'appel de <code><nowiki>{{Documentation}}</nowiki></code> permet de charger automatiquement le contenu de la sous-page /Documentation.
* Le modèle {{m|Documentation}} doit obligatoirement être bornée avec les balises <nowiki><noinclude>...</noinclude></nowiki> pour éviter l'inclusion de celui-ci lors de l'appel du modèle.
 
== Exemples ==
 
=== Modèles bien documentés ===
* [[Modèle:Coloré]]
Ligne 61 ⟶ 68 :
== Voir aussi ==
* {{m|Documentation attendue}}
 
<noinclude>
 
[[Catégorie:Aide:Modèle|Documentation]]
 
</noinclude>