Wikiquote

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

Navigation interactive dans l’historique
← Modification précédenteModification suivante →
Contenu supprimé Contenu ajouté
VisuelWikicode
STyx (discussion | contributions)
7 modifications
commentaire et "Syntaxe"
STyx (discussion | contributions)
7 modifications
réécriture (la simplicité d'abord)
Ligne 17 :
</inputbox>
 
: Pour documenter un modèle déjà existant, copiez, collez et '''adaptez''' lel'un codedes codes ci-dessous à la fin de la source d’un modèle <small>(c’est-à-dire juste avant son dernier saut de ligne existant, et sans aucun autre saut de ligne inutile ajouté après)</small>&nbsp;. Pour un "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 en sous pagemodè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;
:* <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}}|<!-- à compléter à l'identique -->}} »<!--pour un modèle simple (sur un ligne) -->
 
; Variantes
:* {{M|<!--nom de modèle connexe-->}}
 
; 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>▼
 
:Pour un modèle plus complexe (avec arguments nommé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 !
Ligne 41 ⟶ 71 :
 
; Variantes
:* [[Modèle:Variantes{{M|<!--nom de ce modèle]] connexe-->}}
 
; Voir aussi
Ligne 54 ⟶ 84 :
&lt;/noinclude&gt;</pre>
 
;Comment documenter dans la sous-page du modèle ?:▼
:Une variante pour de "petits" modèles simples, sans paramètres nommées, "sur une ligne", et avec un exemple :
:Copiez, collez et '''adaptez''' le code ci-dessous, '''directement''' sous la source du modèle ▼
<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 en sous page}}
<!--{{{{FULLPAGENAMEPAGENAME}}/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 « documentation en sous-page » pour editer la page. La documentation demeure globalement semblable <small>(mais attention à l'usage différent des balises « noinclude » et il faut reporter le nom du modèle)</small>. Pour un modèle simple :
<pre>&lt;noinclude&gt;
Cette page est la documentation du modèle <nowiki>{{</nowiki>M|<!-- nom du modèle -->}}.
&lt;/noinclude&gt;
; Utilisation : Indiquez quand utiliser ce modèle.
 
; Syntaxe : &lt;code&gt;&lt;nowiki&gt;{{{{PAGENAME}}<!-- nom du modèle -->|1|2|etc.}}&lt;/nowiki&gt;&lt;/code&gt;
:* <code>1</code> : description1 (obligatoire).
:* <code>2</code> : description2 (falcultatif, ''défaut2'' par défaut).
Ligne 68 ⟶ 112 :
 
; Exemple : « <code><nowiki>{{</nowiki>{{PAGENAME}}|<!-- à compléter -->}}</code> » donne <!--
-->« {{{{PAGENAME}}<!-- nom du modèle -->|<!-- à compléter à l'identique -->}} »<!--pour un modèle simple (sur un ligne) -->
 
; Variantes :
:* [[Modèle:Variantes{{M|<!--nom de ce modèle]] connexe-->}}
 
; Voir aussi :
:* [[Pages à voir]]
</pre>
 
:Pour un modèle plus complexe (avec arguments nommés)&nbsp;:
▲[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>subst:PAGENAME<nowiki>}}</nowiki>]]
<pre>&lt;noinclude&gt;
Cette page est la documentation du modèle <nowiki>{{</nowiki>M|<!-- nom du modèle -->}}.
&lt;/noinclude&gt;
; Utilisation
: Indiquez quand utiliser ce modèle.
 
; Syntaxe
▲[[de:Template:Nom du modèle germanophone équivalent]]
&lt;nowiki&gt;{{&lt;/nowiki&gt;<!-- nom du modèle -->
▲[[en:Template:Nom du modèle anglophone équivalent]]
|paramètre1=valeur1
▲[[es:Template:Nom du modèle hispanophone équivalent]]
|paramètre2=valeur2
▲[[it:Template:Nom du modèle italophone équivalent]]
|paramètre3=valeur3
▲&lt;/noinclude&gt;</pre>
|etc.
}}
 
; Paramètres
▲;Comment documenter dans la sous-page du modèle ?:
:* <code>paramètre1</code> : description1 (obligatoire).
▲:Copiez, collez et '''adaptez''' le code ci-dessous, '''directement''' sous la source du modèle
:* <code>paramètre2</code> : description2 (falcultatif, ''défaut2'' par défaut).
▲<pre>&lt;noinclude&gt;&lt;!--
:* <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut).
▲ NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats !
:* etc.
▲--&gt;
▲{{Documentation en sous page}}
▲<!--{{{{FULLPAGENAME}}/Documentation}} pour afficher la documentation-->
 
; Variantes
▲[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>subst:PAGENAME<nowiki>}}</nowiki>]]
:* {{M|<!--nom de modèle connexe-->}}
 
; Voir aussi
▲[[de:Template:Nom du modèle germanophone équivalent]]
:* [[Pages à voir]]
▲[[en:Template:Nom du modèle anglophone équivalent]]
</pre>
▲[[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 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
:* [[Modèle:Coloré]]
Récupérée de « https://fr.wikiquote.org/wiki/Aide:Modèle/Comment_documenter_un_modèle_%3F »