Aide:Documentation de modèle

Une nouvelle de Wikinews, la source d'informations que vous pouvez écrire.
Aller à : navigation, rechercher

La documentation doit expliquer clairement ce que fait le modèle et comment l'utiliser. Un utilisateur sans connaissance particulière avec la syntaxe des modèles de MediaWiki doit pouvoir utiliser ce modèle correctement.

La documentation d'un modèle peut être faite :

Dans la page du modèle[modifier | modifier le wikicode]

Il est possible d'inclure le contenu de la documentation directement dans le corps du modèle. Pour ce faire, il faut placer en bas de page du modèle. :

<noinclude>{{Documentation modèle}}

== Utilisation ==
...


<!-- Catégories pour le modèle -->
</noinclude>

Note :

  • L'inclusion de la documentation dans la page du modèle est utile lorsque le modèle est simple.
  • Le modèle {{Documentation}} doit obligatoirement être borné avec les balises <noinclude>...</noinclude> pour éviter l'inclusion de celui-ci lors de l'appel du modèle.


En sous-page dédiée[modifier | modifier le wikicode]

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 <noinclude>...</noinclude> 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.

Pour documenter convenablement un modèle, il faut placer en bas de page du modèle :

<noinclude>{{Documentation}}</noinclude>

Puis cliquez sur le lien [créer] pour précharger le format de base d'une page de documentation.

Note :

  • L'appel de {{Documentation}} permet de charger automatiquement le contenu de la sous-page /Documentation.
  • Le modèle {{Documentation}} doit obligatoirement être bornée avec les balises <noinclude>...</noinclude> pour éviter l'inclusion de celui-ci lors de l'appel du modèle.

Exemples[modifier | modifier le wikicode]

Modèle bien documentés utilisant la sous-page

Modèle:Publication

Modèle documenté directement dans le corps du modèle

Modèle:Suppression rapide