Module:Documentation/Documentation

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

Fonctions exportables

• documentation(frame) – Fonction principale du module – à appeler avec #invoke dans un modèle – renvoyant le code HTML de la documentation.
• _documentation(args) – Fonction subsidiaire du module – à appeler avec require() dans un autre module – et renvoyant le code HTML de la documentation.

Autres fonctions

• nomDocumentation(page) – Renvoie 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.
• existePage(page) – Teste si une page existe.
• lienUrl(nomPage, titrePage, action, pagePreload) – Retourne le lien URL wikifié de la forme [nomPage titrePage] voulu.
• entete(args, page, doc, existeDoc) – Construit l'entête de la documentation contenant l'image de documentation, le titre, et les liens de création/modification/purge.
• contenu(args, titreDoc, existeDoc) – Retourne la concaténation de la documentation en dur, sans cadre vert. C'est cette méthode qui génère la sous-page /Documentation rédigée par l'utilisateur.
• notice(args, page, doc, existeDoc) – Retourne la notice de la documentation situé en bas de page. 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é.

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.