Modèle:Doc

De Banner Saga 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 placez <noinclude>{{doc}}</noinclude> sur une nouvelle ligne à la fin du modèle. Les pages /doc seront ajoutées automatiquement à la Catégorie:Documentation de modèles.

Paramètres[modifier le wikicode]

clear[modifier le wikicode]

Si le modèle contient du texte et que 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 un espace entre le modèle et la boîte documentaire.

nodoc=1[modifier le wikicode]

Si le modèle n'a pas de documentation et que vous n'êtes pas certain de la façon dont 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]

Ce paramètre est utilisé sur des modèles qui ont de la documentation mais qui n'est pas complète ou pas très bien réussie. Peut-être y a-t-il un manque d'exemples, ou les fonctions ne sont pas bien expliquées, ou l'utilité n'est pas bien expliquée.
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.