Modèle:Documentation

De Minecraft Wiki
Aller à : navigation, rechercher
[voir | modifier | historique | purger]Documentation
Lua logo.svg
Ce modèle utilise Module:Documentation, un programme écrit en Lua.
Voir wp:Lua et mw:Extension:Scribunto pour plus d'informations.

Pour les modèles, insérez <noinclude>{{subst:doc}}</noinclude> à la fin du modèle, puis enregistrez la page, cela va placer {{documentation}} et un commentaire conseillant aux éditeurs de placer des catégories et des liens interwiki. Pour les autres types de pages, le modèle de documentation devrait déjà être présent.

Cliquez sur "créer" en haut de la page et la page de documentation s'ouvrira avec un peu de pré-formatage. Ce formatage peut également être créé en utilisant {{subst:doc}} sur la page de documentation.

Les pages de documentation seront automatiquement ajoutées à la Catégorie:Pages de documentation. Utiliser {{doc}} sans subst: ajoutera la page à la catégorie des pages avec des modèles nécessitant une substitution.

Paramètres optionnels[modifier le wikicode]

Ces paramètres peuvent être ajoutés au modèle {{subst:doc}} lors de la création de la page, ou ajoutés au modèle {{documentation}} par la suite.

type[modifier le wikicode]

Définit le "type" de la documentation, par exemple modèle, module, message, etc. Cela sera utilisé dans le cadre de certains messages que le modèle pourrait afficher, ainsi que dans la catégorisation.

Le type est automatique en fonction de l'espace de noms, donc il ne devrait généralement pas être défini.

page[modifier le wikicode]

La page où la documentation devrait être. C'est par défaut une sous-page de la page en cours appelée "doc".

content[modifier le wikicode]

Permet de spécifier le contenu de la documentation directement, plutôt que sur une sous-page distincte. Utile pour les petits modèles de sous-pages spécifiques à une page.

nodoc[modifier le wikicode]

Si un modèle ne contient aucune documentation et que vous ne savez pas comment l'utiliser, ajoutez "nodoc=1" au modèle de documentation sur la page de documentation. Le fond de la documentation deviendra rouge pour le rendre plus visible, et la page sera ajoutée à la Catégorie:Modèle sans documentation, si c'est un modèle.

C'est automatiquement défini si la page de documentation n'existe pas ou est vide, donc ce n'est généralement pas nécessaire de le définir.

baddoc[modifier le wikicode]

Similaire à nodoc, ceci est utilisé pour marquer les modèles qui ont une documentation, mais ce n'est pas très bien. Cela peut signifier qu'il n'a pas assez d'exemples, n'explique pas toutes les fonctions correctement, ou n'explique pas correctement le but du modèle. Le fond de la documentation deviendra jaune pour le rendre plus visible, et la page sera ajoutée à la Catégorie:Modèle avec une mauvaise documentation, si c'est un modèle.

[voir | modifier | historique | purger]La documentation ci-dessus est insérée depuis Modèle:Documentation/doc.