Où documenter ?[]
La documentation d’un modèle peut être faite :
- Soit dans la page du modèle, directement dans ce modèle : il faut placer
{{Documentation modèle}}ou{{Documentation modèle compliqué}}dans la page du modèle et entre les bornes<noinclude>…</noinclude>. Se reporter au chapitre Comment documenter directement dans le modèle ? - Soit dans la sous-page /Documentation : il faut alors placer
{{Documentation modèle vue directement}}, ou un autre , dans la sous-page, entre les bornes<noinclude>…</noinclude>. Se reporter au chapitre Comment documenter dans la sous-page du modèle ?
En apposant {{Documentation}} dans un modèle à documenter, vous serez assisté(e) dans la création de sa sous-page de documentation.
Quand doit-on placer la documentation en sous-page ?[]
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 directement dans le modèle). - Le modèle et/ou sa documentation sont particulièrement longs.
- On souhaite reprendre (c'est-à-dire inclure) la documentation dans une page d’aide.
- Avant de protéger un modèle, il faut déplacer sa documentation en sous-page.
Comment documenter directement dans le modèle ?[]
Pour documenter un modèle déjà existant, copiez-collez et adaptez l’un des codes ci-après à 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).
Documenter un modèle simple[]
Pour un « petit » modèle, sans paramètres nommés, « sur une ligne » :
<noinclude>
== 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 une ligne) -->
== Variante ==
* {{M|<!-- nom de modèle connexe -->}}
== Voir aussi ==
* [[<!-- Nom de page à voir -->]]
[[Catégorie:Nom de la catégorie du modèle]]
[[en:Template:Nom du modèle anglophone équivalent]]
</noinclude>
Documenter un modèle plus complexe[]
Pour un modèle plus complexe, avec paramètres nommés :
<noinclude>
== 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 ==
{{En-tê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]]
[[de:Vorlage:Nom du modèle germanophone équivalent]]
</noinclude>
Comment documenter dans la sous-page du modèle ?[]
Copiez-collez et adaptez le code ci-après directement à la fin de la source du modèle :
<noinclude>
{{Documentation}}<!-- Catégories et liens interwikis en sous-page de documentation -->
</noinclude>
Puis cliquez sur le lien rouge pour éditer la page. La documentation demeure globalement semblable.
Documenter un modèle simple[]
== Utilisation ==
<!-- Indiquez quand utiliser ce modèle. -->
== Syntaxe ==
<code><nowiki>{{</nowiki>{{PAGENAME}}|1|2|etc.}}</code>
* 1 : description1 (obligatoire).
* 2 : description2 (facultatif, défaut2 par défaut).
* etc.
== Exemple ==
« {{{{PAGENAME}}|<!-- à compléter -->}}</code> » donne « {{{{PAGENAME}}|<!-- à compléter à l’identique -->}} »<!-- pour un modèle simple (sur une ligne) -->
== Variante ==
* {{M|<!-- nom de modèle connexe -->}}
== Voir aussi ==
* [[<!-- Nom de page à voir -->]]
<includeonly>
<!-- Catégories et liens interwikis du modèle -->
[[Catégorie:Nom de la catégorie du modèle]]
[[it:Template:Nom du modèle italophone équivalent]]
</includeonly>
Documenter un modèle plus complexe[]
== 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 ==
{{En-tê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 liens interwikis du modèle -->
[[Catégorie:Nom de la catégorie du modèle]]
[[es:Plantilla:Nom du modèle hispanophone équivalent]]
</includeonly>