Nuvola decision.png Prise de décision contre le vandalisme : votre avis est le bienvenu.

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

Un article de Ékopédia, l'encyclopédie pratique.
Aller à : Navigation, rechercher

Sommaire

[modifier] Où documenter ?

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

En apposant {{Doc modèle}} dans un modèle à documenter, vous serez assistés dans la création de sa sous-page de documentation.

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

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

[modifier] Comment documenter en dessous du 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).

[modifier] Documenter un modèle simple

Pour un « petit » modèle, sans paramètres nommés, « sur une ligne » :

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

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

[modifier] Documenter un modèle plus complexe

Pour un modèle plus complexe, avec paramètres nommés :

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

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

[modifier] Formulaire de documentation préchargé

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 » : <inputbox> type=create preload=Modèle:Préchargement de nouveau modèle buttonlabel=Créer le modèle default=Modèle:nom du modèle width=40 bgcolor=#ffeeee </inputbox>

[modifier] Exemples de modèles bien documentés

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

Copier-coller et adaptez le code ci-dessous 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.

[modifier] Documenter 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 (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>

[modifier] Documenter un modèle plus complexe

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

[[es:Template:Nom du modèle hispanophone équivalent]]
</includeonly>

[modifier] Exemples de modèles bien documentés

Outils personnels
Espaces de noms
Variantes
Actions
Naviguer
Contribuer
Boîte à outils