« Aide:Modèle/Comment documenter un modèle ? » : différence entre les versions
Contenu supprimé Contenu ajouté
transfert depuis Modèle:Documentation modèle + réecriture |
(Aucune différence)
|
Version du 14 novembre 2006 à 16:46
- 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é}} pour documenter un modèle compliqué), soit {{Documentation modèle en sous-page}}.
- 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 ?
- La documentation demeure la même que précédemment ; mais il faut ôter
<noinclude> {{Documentation modèle}}
...</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.