Modèle:Documentation/Documentation

Ceci est la page de documentation de Modèle:Documentation [modifier] [purger].
Cette sous-page contient les instructions, les catégories de son modèle d'origine et elle n'est pas destinée à être visualisée directement.

Ce modèle utilise le module Documentation, un script écrit dans le langage de programmation Lua. Toute expérimentation devrait être conduite d'abord via une sous-page bac à sable. Voir le Projet:Scribunto si vous voulez en savoir plus.

{{Documentation}} est un modèle de mise en forme de documentation affichant une boîte verte (comme vous pouvez le voir actuellement). Ce modèle charge automatiquement le contenu d'une sous-page /Documentation. Il est à placer à la fin du modèle et doit être inséré dans une section noinclude. L'utilisation de ce modèle permet à quiconque d'éditer la documentation et les catégories d'un modèle protégé.

Si la page de documentation n'existe pas, le lien [créer] comporte une page de préchargement avec le format de page de documentation de base.

Lorsque la page est semi-protégée ou protégée le modèle approprié est automatiquement inséré, sauf s'il est déjà présent dans la sous-page de documentation.

1 Syntaxe

En général, ce modèle est utilisé sans aucun paramètre, placé en bas du modèle ou de la page documentée, entre « <noinclude> » :

<noinclude>{{Documentation}}</noinclude>

De cette façon, le contenu de la sous-page /Documentation du modèle se chargera automatiquement. {{Documentation}} peut également charger le contenu à partir de n'importe quelle autre page :

<noinclude>{{Documentation|Modèle:Exemple/Documentation}}</noinclude>

De cette façon, le contenu de la sous-page /Documentation du modèle {{Exemple}} se chargera automatiquement. Notez bien que l'espace de nom (« Modèle: » ici) doit être indiqué. Le contenu peut également être rédigé dans le corps du modèle :

<noinclude>{{Documentation|contenu=
== Utilisation ==
Lorem ipsum...
}}</noinclude>

Cependant, cette méthode est restrictive. Lorsque le modèle est protégé, le contenu doit être transféré en sous-page. Il suffit de suivre les instructions de la notice, disponible en bas de page de chaque documentation. À noter que la syntaxe MediaWiki des tableaux ne peut être associée au paramètre contenu.

2 Paramètres

• <premier paramètre sans nom> ou 1 : Spécifie le nom d'une page de documentation à utiliser différente, qui peut être partagée par plusieurs modèles.
• contenu : Spécifie le contenu de la documentation, qui sera inclus directement dans le corps du modèle.
• notice : Personnalise la notice de la documentation. Ce paramètre est opérationnel seulement lorsque le paramètre contenu est renseigné.
• titre : Modifie le titre de la documentation.
• couleur : Modifie la couleur par défaut de la documentation.
• message protection : Modifie le titre du bandeau ajouté lorsque la page est en protection complète.

3 Voir aussi

• {{Sous-page de documentation}}