Modèle:Documentation

Documentation

Cette documentation est incluse dans la sous-page de documentation (voir | modifier | historique). Si vous voulez améliorer ce modèle et si celui-ci est protégé, demandez à un administrateur de vous aider.

Description

Ce modèle permet l’affichage de la documentation d’un modèle par transclusion depuis la sous-page standardisée "Modèle:***/documentation" ou depuis une autre page (page d’aide par exemple).

Ceci a les avantages suivants :

1. d’alléger le serveur (en terme de mémoire et pour résoudre les problèmes de limitation en preinclude) ;
2. de ne pas lier directement les autres modèles et références employés par la documentation au modèle lui-même (allègement des listes de suivi pour la documentation elle-même) ;
3. de pouvoir protéger un modèle très utilisé, tout en autorisant les modifications de la page de documentation par tout le monde (sans conséquence pour toutes les autres pages qui utilisent le modèle, qui ne seront pas invalidées massivement non plus dans le cache du serveur pour les pages déjà calculées) ;
4. de fournir plus d’exemples d’utilisation du modèle, la page de documentation pouvant aussi servir à montrer leur fonctionnement correct.
5. de pouvoir encore modifier les catégorisations du modèle lui-même, et d’ajouter des liens interwikis (dans une section <includeonly> en fin de page de documentation).

Syntaxe

<noinclude>{{documentation}}</noinclude>

à placer en fin de modèle pour une utilisation normale de la sous-page "Modèle:***/documentation", ou

<noinclude>{{documentation|nom de la page}}</noinclude>

à placer en fin de modèle pour utiliser n’importe quelle autre page de documentation (qui peut documenter ensembles plusieurs modèles liés).