Différences entre les versions de « Aide:Modèle/Comment documenter un modèle ? »

m
aucun résumé de modification
(simplification par le modèle catégorisant conforme interwikis)
m
:La documentation d'un [[Aide:modèle|modèle]] peut-être faite, soit dans la page du modèle (sous ce modèle), soit dans sa sous-page <code>/Documentation</code>. Il faut alors placer, dans la page du modèle et entre les bornes <code><nowiki><noinclude></nowiki>{{m|Documentation}}<nowiki></noinclude></nowiki></code>.
: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 <small>(il faut alors reduireréduire au minimum le contenu des balises <code><nowiki><noinclude></nowiki></code>, <code><nowiki></noinclude></nowiki></code> et surtout, ne pas inclure la documentation)</small>.
::#le modèle et sa documentation sont particulièrement longs.
::#on souhaite rependre (ie., inclure) la documentation dans une page d'aide.
; Syntaxe : &lt;code&gt;&lt;nowiki&gt;{{{{PAGENAME}}|1|2|etc.}}&lt;/nowiki&gt;&lt;/code&gt;
:* <code>1</code> : description1 (obligatoire).
:* <code>2</code> : description2 (falcultatiffacultatif, ''défaut2'' par défaut).
:* etc.
 
; Paramètres
:* <code>paramètre1</code> : description1 (obligatoire).
:* <code>paramètre2</code> : description2 (falcultatiffacultatif, ''défaut2'' par défaut).
:* <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut).
:* etc.
--&gt;
{{Documentation}}
<!--{{{{PAGENAME}}/Documentation}} pour afficher la documentation-->
 
[[de:Template:Nom du modèle germanophone équivalent]]
&lt;/noinclude&gt;</pre>
 
:Puis cliquez sur « documentation en sous-page » pour editeréditer la page. La documentation demeure globalement semblable <small>(mais attention à l'usage différent des balises « noinclude » et il faut reporter le nom du modèle)</small>. Pour un modèle simple :
<pre>&lt;noinclude&gt;{{Documentation}}&lt;/noinclude&gt;
Cette page est la documentation du modèle <nowiki>{{</nowiki>M|<!-- nom du modèle -->}}.
&lt;/noinclude&gt;
; Utilisation : Indiquez quand utiliser ce modèle.
 
; Syntaxe : &lt;code&gt;&lt;nowiki&gt;{{<!-- nom du modèle -->|1|2|etc.}}&lt;/nowiki&gt;&lt;/code&gt;
:* <code>1</code> : description1 (obligatoire).
:* <code>2</code> : description2 (falcultatiffacultatif, ''défaut2'' par défaut).
:* etc.
 
 
:Pour un modèle plus complexe (avec arguments nommés)&nbsp;:
<pre>&lt;noinclude&gt;{{Documentation}}&lt;/noinclude&gt;
Cette page est la documentation du modèle <nowiki>{{</nowiki>M|<!-- nom du modèle -->}}.
&lt;/noinclude&gt;
; Utilisation
: Indiquez quand utiliser ce modèle.
; Paramètres
:* <code>paramètre1</code> : description1 (obligatoire).
:* <code>paramètre2</code> : description2 (falcultatiffacultatif, ''défaut2'' par défaut).
:* <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut).
:* etc.