Module:Documentation/Documentation

Ce module implémente le modèle {{Documentation}}. Voir la page du modèle pour les instructions d'utilisation.

Utilisation

Fonctions exportables :

• corps(frame) – Fonction principal du module renvoyant le code HTML de la documentation.

Autres fonctions :

• entete(page) – Fonction retournant la concaténation du tableau entete. Le tableau entete contient l'entête de la documentation (image de documentation, titre, bouton de création, de modification ou d'historique.
• contenu(frame, page) – Fonction retournant la concaténation du tableau contenu. Le tableau contenu contient la documentation en dure, sans cadre vert. C'est cette méthode contenu qui génère la sous-page /Documentation rédigée par l'utilisateur.
• notice(page) – Fonction retournant la concaténation du tableau notice. Le tableau notice contient la notice de la documentation. Elle peut être modifiée par l'utilisateur grâce au paramètre « |notice= » dans un modèle seulement si le paramètre « |contenu= » est renseigné.
• docname(page) – Fonction renvoyant le nom de la documentation si on n'est pas dans une sous-page ou encore si les sous-pages sont de la forme /Documentation, /Bac à sable, /Test.
• ifexist(page) – Fonction boolean testant si une page existe.

Exemples et tests

• Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.
• Module:Documentation/Bac à sable, {{Documentation/Bac à sable}} et {{Documentation/Test}} permettent de tester diverses modifications apportées dans une version bac à sable.