Modèle:Doc

De Eco - Wiki Français
Aller à :navigation, rechercher

Pour utiliser, créez une sous-page depuis le modèle appelée doc, placez Modèle:Tl au début de votre documentation et Modèle:Tl à la fin.

Retournez sur la page principale de votre modèle et ajoutez <noinclude>Modèle:Tl</noinclude> sur une nouvelle ligne après la fin du modèle. Les pages /doc seront automatiquement ajoutées à Category:Template documentation.

Paramètres optionnels[modifier le wikicode]

clear[modifier le wikicode]

Si la page principale de votre modèle comporte un contenu flottant et que vous souhaitez éviter qu'il ne dépasse la documentation, placez Modèle:Tlx au lieu de Modèle:Tl sur votre page de documentation.
Ceci est également utile pour les modèles n'utilisant pas <includeonly>, car cela ajoutera de l'espace entre le modèle et la boîte de documentation.

nodoc=1[modifier le wikicode]

Si un modèle n'a pas de documentation et que vous ne savez pas comment l'utiliser, placez Modèle:Tlx (ou si le modèle nécessite également clear, Modèle:Tlx) au lieu de Modèle:Tl sur votre page de documentation.
L'arrière-plan de la documentation deviendra rouge pour la rendre plus visible, et la page sera ajoutée à Category:Templates with no documentation.

baddoc=1[modifier le wikicode]

Similaire à nodoc, cela sert à marquer les modèles qui ont une documentation, mais qui n'est pas très bonne. Cela peut signifier qu'elle n'a pas assez d'exemples, n'explique pas correctement toutes les fonctions ou ne présente pas correctement le but du modèle.
L'arrière-plan de la documentation deviendra jaune pour la rendre plus visible, et la page sera ajoutée à Category:Templates with bad documentation.

Si nodoc et baddoc sont spécifiés ensemble, baddoc sera ignoré.