Modèle:Documentation module

Cette page est protégée.
Une page de Wikipédia, l'encyclopédie libre.

 Documentation[voir] [modifier] [historique] [purger]

Utilisation et paramètres

Ce modèle génère l'affichage de la documentation des modules. Il est apposé automatiquement par le logiciel MediaWiki sur l'ensemble des modules.

Le seul paramètre disponible est le paramètre 1, qui permet d'indiquer la page sur laquelle se trouve la documentation à afficher.

Cas d’utilisation

Si un module dispose d'une sous-page /Documentation, celle-ci est affichée par ce modèle, automatiquement appelé via le message système MediaWiki:Scribunto-doc-page-show. La sous-page de documentation doit alors contenir les catégories dans lesquelles classer le module, entre balises <noinclude>.

Pour les modules ne disposant pas de sous-page de documentation, le message système MediaWiki:Scribunto-doc-page-does-not-exist gère un certain nombre de cas automatiquement en affichant un modèle de documentation spécifique.

Pour les autres modules, un bandeau indiquant l'absence de documentation est affiché, et ceux-ci sont catégorisés par défaut dans la catégorie « Module en langage Lua ».

La documentation de ce modèle est générée par le modèle {{Documentation}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (créer) et la page de test (créer).
Voir les statistiques d'utilisation du modèle sur l'outil wstat.