Wikiversité

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

Navigation interactive dans l’historique
← Modification précédenteModification suivante →
Contenu supprimé Contenu ajouté
VisuelWikicode
Nnemo (discussion | contributions)
0 modification
Nnemo (discussion | contributions)
0 modification
Notamment — Accessibilité. Soyons clairs et exacts. Ce n'est pas documenter sous le modèle, ni même après le modèle. C'est documenter directement dans le modèle.
Ligne 2 :
 
La documentation d’un modèle peut être faite :
* Soit dans la page du modèle, '''sousdirectement dans ce modèle'''  : il faut placer {{m|Documentation modèle}} ou {{m|Documentation modèle compliqué}} dans la page du modèle et entre les bornes {{nobr|<code>{{Balise|noinclude}}…{{Balise|/noinclude}}</code>}}. Se reporter au [[#Comment documenter endirectement dessousdans dule modèle  ?|chapitre ''Comment documenter endirectement dessousdans dule modèle  ?'']]
* Soit '''dans la sous-page <code>/Documentation</code>''' : il faut alors placer {{m|Documentation modèle vue directement}}, ou un autre {{quoi}}, dans la sous-page, entre les bornes {{nobr|<code>{{Balise|noinclude}}…{{Balise|/noinclude}}</code>}}. Se reporter au [[#Comment documenter dans la sous-page du modèle  ?|chapitre ''Comment documenter dans la sous-page du modèle  ?'']]
 
En apposant {{m|Documentation}} dans un modèle à documenter, vous serez assisté(e) dans la création de sa sous-page de documentation.
 
==== Quand doit-on placer la documentation 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 réduire au minimum le contenu des balises <code>{{Balise|noinclude}}</code>…<code>{{Balise|/noinclude}}</code> et surtout ne pas inclure la documentation directement dans le modèle).
* Le modèle et/ou sa documentation sont particulièrement '''longs'''.
* On souhaite '''reprendre''' (c'est-à-dire inclure) la documentation dans une page d’aide.
* '''Avant de protéger un modèle''', il faut déplacer sa documentation en sous-page.
 
=== Comment documenter endirectement dessousdans dule modèle  ? ===
 
Pour documenter un modèle déjà existant, [[copier-coller|copiez-collez]] et '''adaptez''' l’un des codes ci-dessousaprès à 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).
 
==== Documenter un modèle simple ====
Ligne 36 ⟶ 38 :
 
== Exemple ==
« <code>&lt;nowiki>{{&lt;/nowiki>{{PAGENAME}}|<!-- à compléter -->}}</code> » donne « {{{{PAGENAME}}|<!-- à compléter à l’identique -->}}  »<!-- pour un modèle simple (sur une ligne) -->
 
== Variante ==
Ligne 44 ⟶ 46 :
* [[<!-- Nom de page à voir -->]]
 
[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>PAGENAME<nowiki>}}</nowiki>]]
 
[[en:Template:Nom du modèle anglophone équivalent]]
Ligne 53 ⟶ 55 :
 
Pour un modèle plus complexe, avec paramètres nommés :
 
<pre>&lt;noinclude&gt;
 
Ligne 62 ⟶ 65 :
 
== Syntaxe ==
 
&lt;nowiki&gt;{{&lt;/nowiki&gt;{{PAGENAME}}
|paramètre1=valeur1
Ligne 70 ⟶ 74 :
 
== Paramètres ==
 
* <code>paramètre1</code> : description1 (obligatoire).
* <code>paramètre2</code> : description2 (facultatif, ''défaut2'' par défaut).
Ligne 76 ⟶ 81 :
 
== Exemple ==
 
{{EntêteEn-tête tableau "Code Rendu"}}
|-
|&lt;pre&gt;<!-- leLe même code -->&lt;/pre&gt;
|<!-- leLe même code -->
|}
 
Ligne 88 ⟶ 94 :
* [[<!-- Nom de page à voir -->]]
 
[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>PAGENAME<nowiki>}}</nowiki>]]
 
[[de:Vorlage:Nom du modèle germanophone équivalent]]
Ligne 95 ⟶ 101 :
 
==== Formulaire de documentation préchargé ====
 
Pour disposer d’un formulaire de documentation préchargé lors de la création d’un nouveau modèle, mettez le nom de modèle de votre choix dans la boîte suivante et cliquez sur le bouton «  Créer le modèle  »  :
 
<inputbox>
type=create
Ligne 111 ⟶ 119 :
* [[Modèle:Voir l'aide]] (variante)
 
=== Comment documenter dans la sous-page du modèle  ? ===
 
[[Copier-coller|Copiez-collez]] et '''adaptez''' le code ci-après '''directement''' sousà la fin de la source du modèle  :
 
<pre>&lt;noinclude&gt;
{{Documentation}}<!-- Catégories et liens interwikis en sous-page de documentation -->
&lt;/noinclude&gt;</pre>
 
Ligne 135 ⟶ 143 :
 
== Exemple ==
« <code>&lt;nowiki>{{&lt;/nowiki>{{PAGENAME}}|<!-- à compléter -->}}</code> » donne « {{{{PAGENAME}}|<!-- à compléter à l’identique -->}}  »<!-- pour un modèle simple (sur une ligne) -->
 
== Variante ==
Ligne 145 ⟶ 153 :
<includeonly>
 
<!-- Catégories et liens interwikis du modèle -->
 
[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>PAGENAME<nowiki>}}</nowiki>]]
 
[[it:Template:Nom du modèle italophone équivalent]]
Ligne 176 ⟶ 184 :
 
== Exemple ==
 
{{EntêteEn-tête tableau "Code Rendu"}}
|-
|&lt;pre&gt;<!-- leLe même code -->&lt;/pre&gt;
|<!-- leLe même code -->
|}
 
Ligne 190 ⟶ 199 :
<includeonly>
 
<!-- Catégories et liens interwikis du modèle -->
 
[[Catégorie:Nom de la catégorie du modèle|<nowiki>{{</nowiki>PAGENAME<nowiki>}}</nowiki>]]
 
[[es:Plantilla:Nom du modèle hispanophone équivalent]]
Ligne 203 ⟶ 212 :
 
<noinclude>
 
[[Catégorie:Aide:Modèle|Documentation modele]]
 
</noinclude>
 
Récupérée de « https://fr.wikiversity.org/wiki/Aide:Documentation_de_modèle »