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 (il faut alors placer, dans la page du modèle et entre les bornes <noinclude> ... </noinclude>, soit {{Documentation modèle}} (ou {{Documentation modèle compliqué}})
• soit dans sa sous-page /Documentation (il faut alors placer {{Documentation modèle en sous-page}}, ou un autre, dans la sous-page de documentation et sans bornes).

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

1. 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).
2. le modèle et sa documentation sont particulièrement longs.
3. on souhaite rependre (ie., inclure) la documentation dans une page d’aide.
4. avant de protéger un modèle, il faut déplacer sa documentation en sous-page

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 "petit" modèle simple, sans paramètres nommés, "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>{{</nowiki>{{PAGENAME}}|1|2|etc.}}</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) -->

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

; Voir aussi
:* [[<!--nom de page à voir-->]]

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

[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone é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 modèle}}

; 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.

; Exemple :
{{Entête tableau "Code Rendu"}}
|-
|<pre><!-- le même code --></pre>
|<!-- le même code -->
|}

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

; Voir aussi
:* [[<!--nom de page à voir-->]]

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

[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone é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>
{{/Documentation}}<!-- Métadonnées (catégories, interwikis, …) en sous-page de documentation -->
</noinclude>

Puis cliquez sur le lien rouge pour éditer la page. La documentation demeure globalement semblable.

Pour un modèle simple :

{{Documentation modèle en sous-page}}

; Utilisation : <!--indiquez quand utiliser ce modèle-->.

; Syntaxe : <code><nowiki>{{</nowiki>{{PAGENAME}}|1|2|etc.}}</code>
:* <code>1</code> : description1 (obligatoire).
:* <code>2</code> : description2 (falcultatif, ''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) -->

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

; Voir aussi
:* [[<!--nom de page à voir-->]]

<includeonly>
<!-- Catégories et interwikis du modèle -->
[[Catégorie:Nom de la catégorie du modèle|{{PAGENAME}}]]

[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone équivalent]]
</includeonly>

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

{{Documentation modèle compliqué en sous-page}}


; Utilisation
: <!--indiquez quand utiliser ce modèle-->.

; Syntaxe
 <nowiki>{{</nowiki><!-- nom du modèle -->
 |paramètre1={{Param|valeur1}}
 |paramètre2={{Param|valeur2}}
 |paramètre3={{Param|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.

; Exemple :
{{Entête tableau "Code Rendu"}}
|-
|<pre><!-- le même code --></pre>
|<!-- le même code -->
|}

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

; Voir aussi
:* [[<!--nom de page à voir-->]]

<includeonly>
<!-- Catégories et interwikis du modèle -->
[[Catégorie:Nom de la catégorie du modèle|{{PAGENAME}}]]

[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone équivalent]]
</includeonly>