Aide:Modèle/Comment documenter un modèle ?

Où documenter ?

La documentation d'un modèle peut-être faite, soit dans la page du modèle (sous ce modèle), soit dans sa sous-page /Documentation. Il faut alors placer, dans la page du modèle et entre les bornes <noinclude>{{Documentation}}</noinclude>.

Il faut documenter en sous-page dans les cas suivants :

le modèle est très employé et utilise des paramètres qui prennent de multiples valeurs (il faut alors réduire au minimum le contenu des balises <noinclude>, </noinclude> et surtout, ne pas inclure la documentation).
le modèle et sa documentation sont particulièrement longs.
on souhaite rependre (ie., inclure) la documentation dans une page d'aide.

Comment documenter sous le modèle ?: Pour disposer d'un formulaire de documentation préchargé lors de la création d'un nouveau modèle, mettez le nom de modèle de votre choix dans la boîte suivante et cliquez sur le bouton "Créer le modèle" :

Pour documenter un modèle déjà existant, copiez, collez et adaptez l'un des codes 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). Pour un "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}}

; Utilisation : Indiquez quand utiliser ce modèle.

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

; Exemple : « <code><nowiki>{{</nowiki>{{PAGENAME}}|<!-- à compléter -->}}</code> » donne <!--
-->« {{{{PAGENAME}}|<!-- à compléter à l'identique -->}} »<!--pour un modèle simple (sur un ligne) -->

; Variantes
:* {{M|<!--nom de modèle connexe-->}}

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

[[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>

Pour un modèle plus complexe (avec arguments nommé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}}

; Utilisation
: Indiquez quand utiliser ce modèle.

; Syntaxe
 <nowiki>{{</nowiki>{{PAGENAME}}
   |paramètre1=valeur1
   |paramètre2=valeur2
   |paramètre3=valeur3
   |etc.
 }}

; Paramètres
:* <code>paramètre1</code> : description1 (obligatoire).
:* <code>paramètre2</code> : description2 (facultatif, ''défaut2'' par défaut).
:* <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut).
:* etc.

; Variantes
:* {{M|<!--nom de modèle connexe-->}}

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

[[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>

Comment documenter dans la sous-page du modèle ?: Copiez, collez et adaptez le code ci-dessous, directement sous la source du modèle

<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}}

[[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>

Puis cliquez sur « documentation en sous-page » pour éditer la page. La documentation demeure globalement semblable (mais attention à l'usage différent des balises « noinclude » et il faut reporter le nom du modèle). Pour un modèle simple :

<noinclude>{{Documentation}}</noinclude>
; Utilisation : Indiquez quand utiliser ce modèle.

; Syntaxe : <code><nowiki>{{<!-- nom du modèle -->|1|2|etc.}}</nowiki></code>
:* <code>1</code> : description1 (obligatoire).
:* <code>2</code> : description2 (facultatif, ''défaut2'' par défaut).
:* etc.

; Exemple : « <code><nowiki>{{</nowiki><!-- nom du modèle -->|<!-- à compléter -->}}</code> » donne <!--
-->« {{<!-- nom du modèle -->|<!-- à compléter à l'identique -->}} »<!--pour un modèle simple (sur un ligne) -->

; Variantes :
:* {{M|<!--nom de modèle connexe-->}}

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

Pour un modèle plus complexe (avec arguments nommés) :

<noinclude>{{Documentation}}</noinclude>
; Utilisation
: Indiquez quand utiliser ce modèle.

; Syntaxe
 <nowiki>{{</nowiki><!-- nom du modèle -->
   |paramètre1=valeur1
   |paramètre2=valeur2
   |paramètre3=valeur3
   |etc.
 }}

; Paramètres
:* <code>paramètre1</code> : description1 (obligatoire).
:* <code>paramètre2</code> : description2 (facultatif, ''défaut2'' par défaut).
:* <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut).
:* etc.

; Variantes
:* {{M|<!--nom de modèle connexe-->}}

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

Exemples de modèles bien documentés