Module:Documentation/Documentation

La documentation pour ce module peut être créée à Module:Documentation/Documentation/doc

Erreur de script : Erreur Lua à la ligne 1 : '=' expected near 'module'.

Ce module implémente le modèle {{m|Méta documentation de modèle}}. Voir la page du modèle pour les instructions d'utilisation.

== Fonctions exportables ==
* <code>documentation(frame)</code> – Fonction principale du module – à appeler avec <code>#invoke</code> dans un modèle – renvoyant le code HTML de la documentation.
* <code>_documentation(args)</code> – Fonction subsidiaire du module – à appeler avec <code>require()</code> dans un autre module – et renvoyant le code HTML de la documentation.

== Autres fonctions ==
* <code>existePage(page)</code> – Teste si une page existe.
* <code>textPagebase(page)</code> – Renvoie le nom d'une page sans son espace de noms, et sans le suffixe "/Documentation", "/Bac à sable" ou "/Test".
* <code>nomSouspage(page, souspage)</code> – Renvoie le nom d'une sous-page, en tenant compte des cas où l'on se trouverait déjà dans une sous-page "/Documentation", "/Bac à sable" ou "/Test".
* <code>lienUrl(nomPage, texteLien, action, pagePreload)</code> – Retourne un lien wikifié vers la page ''nomPage'', affichant le texte ''texteLien'', avec possibilité d'ajouter des query string (paramètre ''action'') et un preload (paramètre ''pagePreload'').
* <code>entete(args, page, doc, existeDoc)</code> – Construit l'entête de la documentation contenant l'image de documentation, le titre, et les liens de création/modification/purge.
* <code>protection(page, doc, existeDoc, message)</code> – Construit le bandeau indiquant la protection de la page le cas échéant.
* <code>retireBalisesCategories(contenuDoc)</code> - Permet d'ignorer les balises de catégories lors de l'inclusion d'une page de doc pour les bacs à sables.
* <code>contenu(args, titreDoc, existeDoc)</code> – 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.
* <code>lienWstat(nomPage, texteLien)</code> - Retourne un lien externe vers la page wstat de statistiques sur un modèle ou module au nom ''nomPage'', affichant le texte ''texteLien''.
* <code>notice(args, page, doc, existeDoc)</code> – Retourne la notice de la documentation situé en bas de page.

== Exemples et tests ==
* Pour des exemples, voir la [[Modèle:Documentation/Test|page de test]] permettant de tester diverses modifications apportées.
* [[Module:Documentation/Bac à sable]], {{m|Documentation/Bac à sable}} et {{m|Documentation/Test}} permettent de tester diverses modifications apportées dans une version bac à sable.

{{Projet Scribunto}}

<includeonly>
[[Catégorie:Module en langage Lua]]
</includeonly>