« Modèle:Documentation modèle » : différence entre les versions

Contenu supprimé Contenu ajouté
Korrigan (discussion | contributions)
m A protégé « Modèle:Documentation modèle »: Modèle très utilisé [edit=autoconfirmed:move=autoconfirmed]
STyx (discussion | contributions)
transfert vers Aide:Modèle/Comment documenter un modèle ? (voir discussion)
Ligne 1 :
{|align="center" border="0" cellspacing="0" cellpadding="2" style="clear:both;border:1px solid #AAAAAA;background:#FFFFEE;color:#000000"
|[[Image:Info blue.svg|40px]]
|{{#if:{{{1|}}}|La [[ModèleAide:DocumentationModèle/Comment documenter un modèle ?|documentation]] de ce [[Aide:modèle|modèle]] est sur la [[Discussion {{{1}}}|page de discussion]]|Ci-dessous la [[ModèleAide:DocumentationModèle/Comment documenter un modèle ?|documentation]] de ce [[Aide:modèle|modèle]]}}. Voir la [[Wikipédia:Modèles|liste des modèles]].<br />
<small>''{{Purger le cache}} si le modèle utilise noinclude et vos modifications n’apparaissent pas.''</small>
|}<noinclude>
Ligne 7 :
 
; Utilisation
: À placer entre le code du modèle et sa documentation. Voir [[Aide:Modèle/Comment documenter un modèle ?|comment documenter un modèle ]] pour plus de précisions.
: 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)&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 !
--&gt;
{{Documentation modèle}}
 
; Syntaxe : &lt;<code&gt;&lt;><nowiki&gt;>{{</nowiki>{{PAGENAME}}|1|2|etc.}}&lt;/nowiki&gt;&lt;</code&gt;>
; Utilisation
: Indiquez quand utiliser ce modèle.
 
; Syntaxe
: &lt;pre&gt;&lt;nowiki&gt;{{{{PAGENAME}}|
argument1=valeur1|
argument2=valeur2|
argument3=valeur3|
etc.|
}}&lt;/nowiki&gt;&lt;/pre&gt;
 
; Paramètres
:* argument1 : description1 (obligatoire).
:* argument2 : description2 (falcultatif, ''défaut2'' par défaut).
:* argument3 : 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|<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>
 
:Une variante pour de "petits" modèles simples, sans paramètres nommées, "sur une ligne", et avec un exemple :
<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 modèle}}
 
; Utilisation : Indiquez quand utiliser ce modèle.
 
; Syntaxe : &lt;code&gt;&lt;nowiki&gt;{{{{PAGENAME}}|1|2|etc.}}&lt;/nowiki&gt;&lt;/code&gt;
:* 1 : description1 (obligatoire).
:* 2 : description2 (falcultatif, ''défaut2'' par défaut).
:* etc.
 
; Exemple : &lt;code&gt;&lt;nowiki&gt;{{&lt;/nowiki&gt;{{PAGENAME}}|..à compléter..}}&lt;/code&gt; donne <!--
-->{{{{PAGENAME}}|..idem..}}
 
; Variantes :
:* {{M|Documentation modèle en sous-page}}
:* [[Modèle:Variantes de ce modèle]]
 
; Voir aussi :
:* [[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]]
[[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>
 
; Voir aussi
:* [[Aide:Modèle#Documentation_du_modèle]]
 
; Variante
:* {{m|Documentation modèle compliqué}} pour documenter un modèle compliqué
 
; 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.
 
[[Catégorie:Avertissement permanent|Documentation modèle]]