Comment documenter un modèle
Un article de ReseauGerontologiqueAutunois.
Sommaire |
[modifier]
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}} soit {{Documentation modèle compliqué}}
- soit dans sa sous-page /Documentation
- il faut alors placer {{Documentation modèle en sous-page}}, {{Documentation modèle compliqué 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 , .
- le modèle et sa documentation sont particulièrement longs.
- avant de protéger un modèle, il faut déplacer sa documentation en sous-page
[modifier]
Comment documenter sous 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.
<includeonly>Code du modèle</includeonly>
[modifier]
Pour un modèle simple
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.
; Affichage: « {{ {{PAGENAME}} }} »
; Exemples:
{{tableau "Code Wiki-Rendu"
|Exemple1=<nowiki><!--Code--></nowiki>
|Rendu1=<!--Même Code-->
|Exemple2=
|Rendu2=
|Exemple3=
|Rendu3=
|Exemple4=
|Rendu4=
|Exemple5=
|Rendu5=
}}
; Variante
:* {{M|<!--nom de modèle connexe-->}}
; Voir aussi
:* [[<!--nom de page à voir-->]]
[[Catégorie:Nom de la catégorie du modèle]]
</noinclude>
[modifier]
Pour un modèle plus complexe
avec arguments nommés:
<noinclude>
{{Documentation modèle compliqué}}
; 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.
; Affichage: « {{ {{PAGENAME}} }} »
; Exemple :
{{tableau "Code Wiki-Rendu"
|Exemple1=<nowiki><!--Code--></nowiki>
|Rendu1=<!--Même Code-->
|Exemple2=
|Rendu2=
|Exemple3=
|Rendu3=
|Exemple4=
|Rendu4=
|Exemple5=
|Rendu5=
}}
; Variante
:* {{M|<!--nom de modèle connexe-->}}
; Voir aussi
:* [[<!--nom de page à voir-->]]
[[Catégorie:Nom de la catégorie du modèle]]
</noinclude>
[modifier]
Comment documenter dans la sous-page du modèle ?
Copiez, collez et adaptez le code ci-dessous, directement sous la source du modèle
<includeonly>Code du modèle</includeonly>
<noinclude>
{{Documentation modèle en sous-page}}
{{{{PAGENAME}}/Documentation}}
</noinclude>
Puis cliquez sur le lien rouge pour éditer la page. La documentation demeure globalement semblable.
[modifier]
Pour un modèle simple
sans paramètres nommés, "sur une ligne"
<noinclude>Retour {{m|Nom du modèle}}<br/>
{{Modèle Bandeau sous page}}</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.
; Affichage: « {{ {{PAGENAME}} }} »
; Exemples:
{{tableau "Code Wiki-Rendu"
|Exemple1=<nowiki><!--Code--></nowiki>
|Rendu1=<!--Même Code-->
|Exemple2=
|Rendu2=
|Exemple3=
|Rendu3=
|Exemple4=
|Rendu4=
|Exemple5=
|Rendu5=
}}
; Variante
:* {{M|<!--nom de modèle connexe-->}}
; Voir aussi
:* [[<!--nom de page à voir-->]]
<includeonly>
[[Catégorie:Nom de la catégorie du modèle]]
</includeonly><noinclude>
[[Catégorie:Documentation en sous-page]]
</noinclude>
[modifier]
Pour un modèle plus complexe
avec arguments nommés:
<pre><noinclude>Retour {{m|Nom du modèle}}<br/>
{{Modèle Bandeau sous-page}}
{{Bandeau modèle compliqué}}</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.
; Affichage: « {{ {{PAGENAME}} }} »
; Exemples:
{{tableau "Code Wiki-Rendu"
|Exemple1=<nowiki><!--Code--></nowiki>
|Rendu1=<!--Même Code-->
|Exemple2=
|Rendu2=
|Exemple3=
|Rendu3=
|Exemple4=
|Rendu4=
|Exemple5=
|Rendu5=
}}
; Variante
:* {{M|<!--nom de modèle connexe-->}}
; Voir aussi
:* [[<!--nom de page à voir-->]]
<includeonly>
[[Catégorie:Nom de la catégorie du modèle]]
</includeonly><noinclude>
[[Catégorie:Documentation en sous-page]]
</noinclude>
