- Utilisation :
- Affiche un bandeau qui permet d’accéder à la documentation pour la modifier. La documentation doit alors être transcluse dans le modèle principal.
- À utiliser lorsque (la source de) la documentation d’un modèle se trouve dans sa sous-page
<nom du modèle>/Documentation
. Ce bandeau permet d’accéder à la documentation pour la modifier.
- Syntaxe (dans le modèle principal) :
code du modèle principal...<noinclude>{{Documentation modèle compliqué en sous-page}}
{{/Documentation}}<!-- transclusion de la sous-page de documentation -->
... autres métadonnées (non recommandé)
</noinclude>
- Syntaxe (dans la sous-page « /Documentation ») :
- Voir la page de documentation de {{Doc modèle|<parser=1>}}.
- Rendu
- Note :
- Il est aussi possible de placer aussi le bandeau en tête de la page de documentation : il n’y sera pas affiché quand cette sous-page sera affichée, mais remplacé par le bandeau {{Documentation modèle vue directement}}. Ceci n’est pas recommandé : il vaut mieux inclure directement {{Documentation modèle vue directement}} dans une section « noinclude » en tête de la sous-page de documentation.
- La syntaxe d’utilisation dans le modèle principal peut être grandement allégée en utilisant plutôt {{Doc modèle|<parser=1>}} seul dans la section « noinclude » à la fin du modèle principal.
- Variantes :
-
- {{Doc modèle}} recommandé dans tous les modèles
- {{Documentation modèle}} pour documenter un modèle simple
- {{Documentation modèle compliqué}}
- {{Documentation modèle en sous-page}} pour documenter un modèle simple
- {{Documentation modèle utilisant les ParserFunctions en sous-page}}
- Voir aussi :
-
- Comment documenter un modèle ?