« Aide:Modèle/Comment documenter un modèle ? » : différence entre les versions
Contenu supprimé Contenu ajouté
m lourdeur inutile |
compléments |
||
Ligne 1 : | Ligne 1 : | ||
;Où documenter ?: |
;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}}. |
: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 ?: |
;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) : |
: 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) : |
||
<pre><noinclude><!-- |
<pre><noinclude><!-- |
||
NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats ! |
NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats ! |
||
Ligne 73 : | Ligne 77 : | ||
;Comment documenter dans la sous-page du modèle ?: |
;Comment documenter dans la sous-page du modèle ?: |
||
:Copiez, collez et '''adaptez''' le code ci-dessous, '''directement''' sous la source du modèle |
|||
⚫ | |||
<pre><noinclude><!-- |
|||
NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats ! |
|||
--> |
|||
{{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]] |
|||
</noinclude> |
|||
</pre> |
|||
⚫ | :Puis cliquez sur la documentation pour editer la page. La documentation demeure la même que précédemment ; mais il faut bien sur soustraire les parties ci-dessus de la documentation (en particulier ne pas mettre les balises <code><nowiki><noinclude></nowiki></code>, <code><nowiki></noinclude></nowiki></code>). |
||
; Exemples de modèles bien documentés |
; Exemples de modèles bien documentés |
||
:* [[Modèle:Coloré]] |
:* [[Modèle:Coloré]] |
Version du 14 novembre 2006 à 17:20
- Où documenter ?
- La documentation d'un modèle peut-être faite, soit dans la page du modèle (sous ce modèle), soit dans sa sous-page
/Documentation
. Il faut alors placer, dans la page du modèle et entre les bornes<noinclude> ... </noinclude>
, soit {{Documentation modèle}} (ou {{Documentation modèle compliqué}}), soit {{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 (il faut alors reduire au minimum le contenu des balises
<noinclude>
,</noinclude>
et surtout, ne pas inclure la documentation). - le modèle et sa documentation sont particulièrement longs.
- on souhaite rependre (ie., inclure) la documentation dans une page d'aide.
- le modèle est très employé et utilise des paramètres qui prennent de multiples valeurs (il faut alors reduire au minimum le contenu des balises
- Comment documenter sous le modèle ?
- Pour documenter un 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) :
<noinclude><!-- NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats ! --> {{Documentation modèle}} ; Utilisation : Indiquez quand utiliser ce modèle. ; Syntaxe : <pre><nowiki>{{{{PAGENAME}}| argument1=valeur1| argument2=valeur2| argument3=valeur3| etc.| }}</nowiki></pre> ; Paramètres :* <code>argument1</code> : description1 (obligatoire). :* <code>argument2</code> : description2 (falcultatif, ''défaut2'' par défaut). :* <code>argument3</code> : description3 (optionnel, lorsque argument2 est fourni, ''défaut2'' par défaut). :* etc. ; Variantes :* [[Modèle:Variantes de ce modèle]] ; Voir aussi :* [[Pages à voir]] [[Catégorie:Nom de la catégorie du modèle|{{subst:PAGENAME}}]] [[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]] </noinclude>
- Une variante pour de "petits" modèles simples, sans paramètres nommées, "sur une ligne", et avec un exemple :
<noinclude><!-- NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats ! --> {{Documentation modèle}} ; Utilisation : Indiquez quand utiliser ce modèle. ; Syntaxe : <code><nowiki>{{{{PAGENAME}}|1|2|etc.}}</nowiki></code> :* <code>1</code> : description1 (obligatoire). :* <code>2</code> : description2 (falcultatif, ''défaut2'' par défaut). :* etc. ; Exemple : <code><nowiki>{{</nowiki>{{PAGENAME}}|..à compléter..}}</code> donne <!-- -->{{{{PAGENAME}}|..idem..}} ; Variantes : :* [[Modèle:Variantes de ce modèle]] ; Voir aussi : :* [[Pages à voir]] [[Catégorie:Nom de la catégorie du modèle|{{subst:PAGENAME}}]] [[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]] </noinclude>
- Comment documenter dans la sous-page du modèle ?
- Copiez, collez et adaptez le code ci-dessous, directement sous la source du modèle
<noinclude><!-- NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats ! --> {{Documentation en sous page}} <!--{{{{FULLPAGENAME}}/Documentation}} pour afficher la documentation--> [[Catégorie:Nom de la catégorie du modèle|{{subst:PAGENAME}}]] [[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]] </noinclude>
- Puis cliquez sur la documentation pour editer la page. La documentation demeure la même que précédemment ; mais il faut bien sur soustraire les parties ci-dessus de la documentation (en particulier ne pas mettre les balises
<noinclude>
,</noinclude>
). - Exemples de modèles bien documentés
-
- Modèle:Coloré
- Modèle:Icône de titre
- Modèle:Test 2
- Modèle:Voir l'aide (variante), etc.