Modèle:Documentation/documentation

La bibliothèque libre.
Sauter à la navigation Sauter à la recherche
Documentation
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).
Cela a également pour effet de lister la page qui utilise ces syntaxes dans la Catégorie:Modèles documentés.
Important
Merci ensuite de mettre dans leur sous-page de documentation les catégories et les liens interwikis associés aux modèles de base :
  • les placer de préférence à la fin de cette sous-page entre les balises <includeonly> et </includeonly>;
  • indiquer également en tête de cette sous-page {{Documentation modèle}}.
  • Si la documentation d'un modèle n'est pas dans sa sous-page normale mais dans celle d'un autre modèle ou est une page d'aide, attention à la façon dont la page indiquée (par le paramètre nom de la page dans la seconde syntaxe) indique (hors de ses propres sections noinclude) dans ses catégories ; il peut être nécessaire de modifier cette autre page pour masquer (dans une section noinclude) ses propres catégories lors de la transclusion et en revanche mettre (dans une section includeonly) les catégories applicables aux modèles que documente cette autre page. Mais il peut être plus simple de créer une sous-page de documentation autonome qui va transclure la page commune.
Voir aussi
  • Module:Documentation module (utilisé implicitement pour documenter les pages de l'espace "Module:" et contenant du code Lua pour Scribunto)