Modèle:Documentation/doc

Description

Ce modèle est utilisé pour insérer la description des modèles sur leur page.

Syntaxe

<noinclude>{{documentation}}</noinclude> à la fin de la page du modèle à documenter.

Utilisation

Sur la page du modèle

Ceci est le formalisme usuel :

CODE DU MODÈLE<includeonly>Toute catégorie à insérer dans les articles utilisant le modèle</includeonly><noinclude>
{{documentation}}
Toute catégorie pour le modèle en lui-même</noinclude>

Si votre modèle n'est pas un div ou un tableau complet, vous pourriez fermer les balises avant d'insérer {{documentation}} (dans les balises noinclude).

Un saut de ligne juste avant {{documentation}} peut être aussi utile comme cela aide à éviter que le modèle de documentation se superpose au code qui précède.

Sur la page modèle/doc

En temps normal, vous voudriez écrire quelque chose comme suit sur la page de documentation :

==Description==
Ce modèle est utilisé pour quelque chose.

==Syntaxe==
Saisissez <code>{{m|nommodèle}}</code> quelque part.

==Exemple==
<code><nowiki>{{nommodèle|paramètres}}</nowiki></code> 

donne...

{{nommodèle|paramètres}}

<noinclude>[[Catégorie:Documentation de modèle|{{PAGENAME}}]]</noinclude>

Utilisez une ou toutes les sections description/syntaxe/exemple ci-dessus. Vous pouvez aussi ajouter une section « voir aussi » ou autre.

Veuillez noter que l'exemple ci-dessus utilise les modèles Modèle:M et Modèle:M/piece.