« Aide:Modèle/Comment documenter un modèle ? » : différence entre les versions

Contenu supprimé Contenu ajouté
STyx (discussion | contributions)
m typo
STyx (discussion | contributions)
Ligne 27 :
 
; Syntaxe
: <pre><nowiki>{{{{PAGENAME}}|
argument1|paramètre1=valeur1|
argument2|paramètre2=valeur2|
argument3|paramètre3=valeur3|
|etc.|
}}</nowiki></pre>
 
; Paramètres
:* <code>argument1paramètre1</code> : description1 (obligatoire).
:* <code>argument2paramètre2</code> : description2 (falcultatif, ''défaut2'' par défaut).
:* <code>argument3paramètre3</code> : description3 (optionnel, lorsque argument2<code>paramètre2</code> est fourni, ''défaut2défaut3'' par défaut).
:* etc.
 
Ligne 46 :
:* [[Pages à voir]]
 
[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>subst:PAGENAME<nowiki>}}</nowiki>]]
 
[[de:Template:Nom du modèle germanophone équivalent]]
Ligne 52 :
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
&lt;/noinclude&gt;</pre>
</pre>
 
:Une variante pour de "petits" modèles simples, sans paramètres nommées, "sur une ligne", et avec un exemple :
Ligne 68 ⟶ 67 :
:* etc.
 
; Exemple : « &lt;code&gt;&lt;nowiki&gt;{{&lt;/nowiki&gt;{{PAGENAME}}|..à compléter..}}&lt;/code&gt; » donne <!--
-->« {{{{PAGENAME}}|..idem..}} »
 
; Variantes :
Ligne 83 ⟶ 82 :
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
&lt;/noinclude&gt;</pre>
</pre>
 
;Comment documenter dans la sous-page du modèle ?:
Ligne 93 ⟶ 91 :
{{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>]]
 
Ligne 99 ⟶ 98 :
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
&lt;/noinclude&gt;</pre>
 
</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