Modèle:Doc

De ARK Wiki
Aller à la navigation Aller à la recherche
Template-info.png Documentation

Crée une documentation pour les modèles sur un fichier séparé, pour laisser le modèle centré sur sa fonction, éviter les interférences avec les fonctionnalités, ou permettre la modification de la documentation sur un modèle protégé.

Nommez un fichier en sous-page du modèle, avec "/doc" en suffixe.

Commencez le document par {{Doc/start}} et terminez-le par {{Doc/end}}. Ces sous-modèles ont été redirigés en anglais {{Doc/start}} et {{Doc/end}} qui sont également utilisables.

À la fin du modèle à documenter, ajoutez <noinclude>{{Doc}}</noinclude> dans une nouvelle ligne.

Les pages /doc sont automatiquement ajoutées à la Catégorie:Documentation de modèles.

Paramètres optionnels

clear

Si votre modèle principal a un contenu flottant, vous pouvez l'empêcher de déborder sur le document en insérant {{Doc/start|clear}} au lieu de {{Doc/start}}.
C'est utile pour les modèles utilisant <includeonly>, car cela ajoutera un espace entre l'affichage du modèle et la documentation.

nodoc=1

Si votre modèle n'a pas de documentation et que vous ne savez pas comment l'utiliser, précisez {{Doc/start|nodoc=1}} (ou si le modèle doit rester vierge, {{Doc/start|clear|nodoc=1}}) au lieu de {{Doc/start}}.
Le fond de ce document sera mis en rouge pour qu'il soit mieux remarqué et la page sera ajoutée à la Catégorie:Modèles sans documentation.

baddoc=1

Semblable à l'option précédente, marque un modèle qui n'a pas de documentation, mais qui gagnerait à en avoir. Il souligne les documents inexistants, incomplets ou imprécis.
Le fond de ce document sera mis en rouge pour qu'il soit mieux remarqué et la page sera ajoutée à la Catégorie:Modèles avec mauvaise documentation.

Si à la fois nodoc et baddoc sont précisés, baddoc sera ignoré.