SFTG Recherche, soutient un projet d'analyse de l'usage, de l'intérêt et de la contribution à ce site. Merci d'avoir répondu à l'enquête.
Modifications
Sauter à la navigation
Sauter à la recherche
Module:Documentation/Documentation (voir la source)
Version du 11 novembre 2016 à 18:22
, 11 novembre 2016 à 18:22Retrait de {{Semi-protection longue}} car géré automatiquement par {{Documentation}}
Ce module implémente le modèle {{m|Documentation}}. 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>nomDocumentation(page)</code> – 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.
* <code>existePage(page)</code> – Teste si une page existe.
* <code>lienUrl(nomPage, titrePage, action, pagePreload)</code> – Retourne le lien URL wikifié de la forme [nomPage titrePage] voulu.
* <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>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>notice(args, page, doc, existeDoc)</code> – Retourne la notice de la documentation situé en bas de page. Elle peut-être modifiée par l'utilisateur grâce au paramètre « <code>|notice=</code> » dans un modèle seulement si le paramètre « <code>|contenu=</code> » est renseigné.
== 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.
<includeonly>{{Projet Scribunto}}</includeonly><noinclude>
[[Catégorie:Documentation de module]]
</noinclude>
== 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>nomDocumentation(page)</code> – 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.
* <code>existePage(page)</code> – Teste si une page existe.
* <code>lienUrl(nomPage, titrePage, action, pagePreload)</code> – Retourne le lien URL wikifié de la forme [nomPage titrePage] voulu.
* <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>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>notice(args, page, doc, existeDoc)</code> – Retourne la notice de la documentation situé en bas de page. Elle peut-être modifiée par l'utilisateur grâce au paramètre « <code>|notice=</code> » dans un modèle seulement si le paramètre « <code>|contenu=</code> » est renseigné.
== 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.
<includeonly>{{Projet Scribunto}}</includeonly><noinclude>
[[Catégorie:Documentation de module]]
</noinclude>
