Modèle:Documentation modèle en sous-page/Documentation

Ceci est la page de documentation du modèle {{Documentation modèle en sous-page}}. Cette sous-page contient les instructions, les catégories et les liens interlangues de son modèle d’origine et elle n’est pas destinée à être visualisée directement.

Utilisation :

Affiche un bandeau similaire à celui affiché ci-dessus, qui permet d’accéder à la documentation pour la modifier. La documentation doit alors être incluse dans le modèle à l’aide de {{/Documentation}} ; il est alors préférable de placer le bandeau dans la page de documentation.

À n‘utiliser que dans un modèle simple, et lorsque lorsque (la source de) la documentation d’un modèle se trouve dans sa sous-page <nom du modèle>/Documentation.

Syntaxe (dans le modèle principal) :

Code du modèle principal...<noinclude>{{Documentation modèle en sous-page}}

{{/Documentation}}<!-- transclusion de la sous-page de documentation -->

...autres métadonnées (non recommandé)

</noinclude>

Syntaxe (dans la sous-page « /Documentation ») :

La page de documentation doit afficher {{documentation modèle vue directement}} lorsqu’elle est vue directement.

Note :

Dans les modèles très utilisés, il n’est pas recommandé de placer la documentation (ainsi que les autres métadonnées) directement dans le modèle, d'autant plus que ce modèle peut être l'objet de bloquage.

Parmi les autres métadonnées qu'on place dans la sous-page de documentation (et à placer dans la section ‹‹ includeonly » de la sous-page), figureront toutes les catégories applicable au modèle principal, ainsi que la clé de tri par défaut pour ces catégories, et les liens interwikis vers des modèles similaires (plus ou moins compatibles) d’autres éditions de Wikivoyage.

Variantes :

• {{Documentation modèle compliqué en sous-page}}

  utilisation similaire, mais pour des modèles compliqués utilisant les ParserFunctions et dont la documentation a été placée en sous-page.

• {{Documentation modèle utilisant les ParserFunctions en sous-page}}

  assez semblable au modèle précédent, et ajoute le modèle dans Catégorie:Modèle utilisant les ParserFunctions

• {{Documentation modèle}}

  utilisation similaire, mais pour des modèles simples, et dont la documentation n'est pas encore en sous-page. Utilisation non recommandée pour les modèles très utilisés (et devant être bloqués).

• {{Documentation modèle compliqué}}

  utilisation similaire, mais pour des modèles compliqués utilisant les ParserFunctions, et dont la documentation n'est pas encore en sous-page. Utilisation non recommandée, car pour des modèles compliqués il vaut mieux séparer la documentation.

Voir aussi :

• Comment documenter un modèle ? pour plus de précisions.