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

compléments
m (lourdeur inutile)
(compléments)
;Où documenter ?:
: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> ... <nowiki></noinclude></nowiki></code>, soit {{m|Documentation modèle}} (ou {{m|Documentation modèle compliqué}}), soit {{m|Documentation modèle 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 <small>(il faut alors reduire 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.
 
;Comment documenter sous le modèle ?:
: Pour documenter un [[Aide:modèle|modèle]], copiez, collez et '''adaptez''' le code 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)&nbsp;:
<pre>&lt;noinclude&gt;&lt;!--
NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats !
 
;Comment documenter dans la sous-page du modèle ?:
:Copiez, collez et '''adaptez''' le code ci-dessous, '''directement''' sous la source du modèle
:La documentation demeure la même que précédemment ; mais il faut ôter <code><nowiki><noinclude> {{Documentation modèle}}</nowiki></code> ... <code><nowiki></noinclude></nowiki></code>
<pre>&lt;noinclude&gt;&lt;!--
NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats !
--&gt;
{{Documentation en sous page}}
<!--{{{{FULLPAGENAME}}/Documentation}} pour afficher la documentation-->
[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>subst:PAGENAME<nowiki>}}</nowiki>]]
 
[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone équivalent]]
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
&lt;/noinclude&gt;
</pre>
:Puis cliquez sur la documentation pour editer la page. La documentation demeure la même que précédemment ; mais il faut ôterbien sur soustraire les parties ci-dessus de la documentation (en particulier ne pas mettre les balises <code><nowiki><noinclude> {{Documentation modèle}}</nowiki></code> ..., <code><nowiki></noinclude></nowiki></code> ).
; Exemples de modèles bien documentés
:* [[Modèle:Coloré]]
1

modification