Modèle:Documentation

 Documentation[modifier] [purger]


{{Documentation}} est un modèle de mise en forme de documentation affichant une boîte verte (comme celle contenant le texte que vous lisez 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 notamment à tout le monde d'éditer la documentation et les catégories d'un modèle protégé.

Si la page de documentation n'existe pas, un lien [créer] est affiché, qui permet de débuter la création de la page en préchargeant le format de page de documentation de base. Des liens disponibles au bas de la notice permettent de la même manière de créer les sous-pages /Bac à sable et /Test.

Lorsque le modèle est un bac à sable, il ajoute automatiquement le modèle {{Sous-page de bac à sable}} en haut de page. 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.

Syntaxe

Syntaxe simple

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, dans des balises « <noinclude> » :

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

De cette façon, le contenu de la sous-page /Documentation du modèle se chargera automatiquement.

Utilisation d'une page de documentation différente

{{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é. Cette syntaxe permet d'utiliser une documentation partagée par plusieurs modèles.

Utilisation sans page de documentation

Le contenu peut également être rédigé dans le corps du modèle :

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

Cependant, cette méthode comporte des limitations. Par exemple, la syntaxe MediaWiki des tableaux ne peut être utilisée avec le paramètre contenu. Dans le cas général, on évitera d’utiliser le paramètre contenu dès que la documentation dépasse quelques lignes, pour lui préférer l’utilisation d'une sous-page de documentation.

Dans tous les cas, lorsque le modèle est protégé, le contenu doit être transféré en sous-page, afin de permettre son édition par tout le monde. Il suffit de suivre les instructions de la notice, disponible en bas de page de chaque documentation.

Paramètres

Ce modèle affiche la documentation d'un modèle.

Paramètres du modèle

La mise en forme sur une seule ligne est préférée pour ce modèle.

ParamètreDescriptionTypeStatut
11

Spécifie le nom d'une page de documentation à utiliser différente, qui peut être partagée par plusieurs modèles

Chaînefacultatif
Contenucontenu

Spécifie le contenu de la documentation, pour qu'il soit directement inclus dans le corps du modèle. Ne pas utiliser si vous voulez créer une sous page.

Chaînefacultatif
Message protectionmessage protection

Modifie le titre du bandeau ajouté lorsque la page est en protection complète.

Chaînefacultatif
Complémentcomplément

Dans le cas où le paramètre "1" est renseigné (documentation chargée depuis une autre page de documentation), ce paramètre permet d'ajouter un contenu supplémentaire.

Chaînefacultatif

Exemples

Voir la sous-page de test.

Voir aussi