Modèle:Doc

De Sorceleur Wiki
Aller à : navigation, rechercher
Template-info.png Documentation

Ce modèle charge automatiquement le contenu d'une sous-page /doc. Il est à placer à la fin du modèle et doit être inséré dans une section noinclude. L'utilisation de ce modèle permet à quiconque d'éditer la documentation et les catégories d'un modèle protégé.

Pour utiliser ce modèle, créez une sous-page pour le modèle avec le titre doc, ajoutez {{doc/début}} au début du texte documentaire, et {{doc/fin}} à la fin.

Revenez au modèle principal et placer <noinclude>{{doc}}</noinclude> sur une nouvelle ligne à la fin du modèle. Les pages /doc seront ajouté automatiquement à la Catégorie:Documentation de modèle.

Paramètres[modifier le wikicode]

clear[modifier le wikicode]

Si le modéle contient du texte et vous ne voulez pas que la documentation s'affiche par dessus, utilisez {{doc/début|clear}} au lieu de {{doc/début}} au début de la page de documentation.
Ce paramètre est également utile pour des modèles qui n'utilisent pas <includeonly>, parce qu'il ajoute une espace entre me modèle et la boîte documentaire.

nodoc=1[modifier le wikicode]

Si le modéle n'a pas de documentation et vous n'êtes pas certain comment il fonctionne, utilisez {{doc/début|nodoc=1}} (ou si le modèle a aussi besoin d'un espace, {{doc/début|clear|nodoc=1}}) au lieu de {{doc/début}} au début de la page de documentation.
La couleur du fond de la boîte deviendra rouge afin de la rendre plus visible, et la page sera ajoutée à la Catégorie:Modèles sans documentation.

baddoc=1[modifier le wikicode]

Comme nodoc, ce paramètre est utilisé sur de modèles qui ont de la documentation, mais que celle-ci n'est pas très bien réussi. Peut-être il y a un manque d'exemples, ou les fontions ne sont pas bien expliquées, ou l'utilité n'est pas bien expliqué.
La couleur du fond de la boîte deviendra jaune afin de la rendre plus visible, et la page sera ajoutée à la Catégorie:Modèles avec mauvaise documentation.

Si vous ajoutez et nodoc et baddoc, la couleur de fond baddoc sera ignorée.