Modèle:Documentation modèle

Ci-dessous la documentation de ce modèle. Voir la liste des modèles.

Cliquez ici pour purger le cache si le modèle utilise noinclude et vos modifications n’apparaissent pas.

Utilisation: Pour documenter un modèle, copiez, collez et adaptez le code ci-dessous à la fin de la source d’un modèle (c’est-à-dire juste avant son dernier saut de ligne existant, et sans aucun autre saut de ligne inutile ajouté après) :

<noinclude><!--
  NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats !
-->
{{Documentation modèle}}

; Utilisation
: Indiquez quand utiliser ce modèle.

; Syntaxe
: <pre><nowiki>{{{{PAGENAME}}|
 argument1=valeur1|
 argument2=valeur2|
 argument3=valeur3|
 etc.|
}}</nowiki></pre>

; Paramètres
:* argument1 : description1 (obligatoire).
:* argument2 : description2 (falcultatif, ''défaut2'' par défaut).
:* argument3 : description3 (optionnel, lorsque argument2 est fournit, ''défaut2'' par défaut).
:* etc.

; Variantes
:* [[Modèle:Variantes de ce modèle]]

; Voir aussi
:* [[Pages à voir]]

[[Catégorie:Nom de la catégorie du modèle|{{subst:PAGENAME}}]]

[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone équivalent]]
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
</noinclude>

Une variante pour de "petits" modèles simples, sans paramètres nommées, "sur une ligne", et avec un exemple :

<noinclude><!--
  NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats !
-->
{{Documentation modèle}}

; Utilisation : Indiquez quand utiliser ce modèle.

; Syntaxe : <code><nowiki>{{{{PAGENAME}}|1|2|etc.}}</nowiki></code>
:* 1 : description1 (obligatoire).
:* 2 : description2 (falcultatif, ''défaut2'' par défaut).
:* etc.

; Exemple : <code><nowiki>{{<!---->{{PAGENAME}}|..à compléter..}}</nowiki></code> donne <!--
-->{{ {{PAGENAME}}|..idem..}}

; Variantes :
:* [[Modèle:Variantes de ce modèle]]

; Voir aussi :
:* [[Pages à voir]]

[[Catégorie:Nom de la catégorie du modèle|{{subst:PAGENAME}}]]

[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone équivalent]]
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
</noinclude>

Voir aussi

Aide:Modèle#Documentation_du_modèle

Variante

Modèle:M pour documenter un modèle compliqué

Exemples de modèles bien documentés