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

Où documenter ? modifier

La documentation d’un modèle peut être faite :

soit dans la page du modèle, sous ce modèle : il faut placer {{Documentation}} dans la page du modèle et entre les bornes <noinclude>…</noinclude>. Se reporter au chapitre Comment documenter en dessous du modèle ?.
soit dans la sous-page /Documentation : il faut alors placer {{Documentation}}, 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és dans la création de sa sous-page de documentation.

Quand doit-on placer la documentation en sous-page ? modifier

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

Depuis le 11 mars 2014, Éditeur Visuel demande que les documentions utilisent la balise TemplateData.

Procédure en vigueur avant le 11 mars 2014

Comment documenter en dessous du modèle ? modifier

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

Documenter un modèle simple modifier

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|{{PAGENAME}}]]

[[en:Template:Nom du modèle anglophone équivalent]]

</noinclude>

Documenter un modèle plus complexe modifier

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 ==
{{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:Vorlage:Nom du modèle germanophone équivalent]]

</noinclude>

Comment documenter dans la sous-page du modèle ? modifier

Copiez-collez et adaptez le code ci-après directement sous la source du modèle :

<noinclude>
{{Documentation}}<!-- Catégories et 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 modifier

{{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 (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 -->]]

<includeonly>

<!-- Catégories et interwikis du modèle -->

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

[[it:Template:Nom du modèle italophone équivalent]]

</includeonly>

Documenter un modèle plus complexe modifier

{{Documentation}}

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

[[es:Plantilla:Nom du modèle hispanophone équivalent]]

</includeonly>

Exemples de modèles bien documentés modifier

Formulaire de documentation préchargé modifier

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 » :

Voir aussi modifier

Aide:Documentation de modèle sur l’encyclopédie Wikipédia