Aide:Comment documenter un modèle ?

La bibliothèque libre.
Sauter à la navigation Sauter à la recherche

Vous êtes ici : accueil >Aide >Comment documenter un modèle ?

Aide : Manuel de Wikisource

Où documenter ?[modifier]

Pour toutes sortes de raison (facilité de maintenance, protection des modèles, homogénéité de présentation), la documentation n’est plus souhaitable dans la page du modèle.

La documentation d’un modèle doit être faite dans la sous-page /documentation : celle-ci est automatiquement créée par l’ajout du modèle {{Documentation}} entre balise noinclude au début (de préférence) ou à la fin du modèle.

<noinclude>{{Documentation}}</noinclude>

exemple de résultat :Modèle: M

Il ne reste plus alors qu’à cliquer sur le lien d’édition de la documentation créé pour y ajouter les informations.

Si vous tombez sur un modèle non documenté ou insuffisamment et que vous ne savez pas le documenter, merci d’ajouter le modèle {{sansdoc}} dans la sous-page /documentation.

Une bonne documentation devrait contenir, au minimum :

  • Une description de l’utilisation du modèle
  • La syntaxe du modèle
  • La définition des paramètres (s’il y a lieu)
  • Un exemple ou une démonstration d’utilisation
  • les variantes et précautions
  • les autres modèles liés (s’il y a lieu)
  • la ou les catégories du modèle (entre balises <includeonly>[[Catégorie:Modèles]]</includeonly>)
  • la catégorie de la documentation (<noinclude>[[Catégorie:Documentations]]</noinclude>

Exemples de modèles bien documentés[modifier]

Comment documenter dans la sous-page du modèle ?[modifier]

Copier-coller et adaptez le code ci-dessous directement sous la source du modèle :

<noinclude>
{{/Documentation}}<!-- Catégories et interwikis en sous-page de documentation -->
</noinclude>

Puis cliquez sur le lien rouge pour éditer la page. La documentation demeure globalement semblable.

Documenter un modèle simple[modifier]

{{Documentation modèle en sous-page}}

;Description
<!--indiquez quand utiliser ce modèle-->.

;Syntaxe(s)
<code><nowiki>{{</nowiki>{{PAGENAME}}|1|2|etc.}}</code>
* <code>1</code> : description1 (obligatoire).
* <code>2</code> : description2 (facultatif, ''défaut2'' par défaut).
* etc.

;Exemple(s)
« <code><nowiki>{{</nowiki>{{PAGENAME}}|<!-- à compléter -->}}</code> » donne <!--
-->« {{ {{PAGENAME}}|<!-- à compléter à l’identique -->}} »<!--pour un modèle simple (sur une ligne) -->

;Variante
* {{M|<!--nom de modèle connexe-->}}

;Voir aussi
* [[<!--nom de page à voir-->]]

<includeonly>
<!-- Catégories et interwikis du modèle -->
[[Catégorie:Nom de la catégorie du modèle|{{PAGENAME}}]]

[[it:Template:Nom du modèle italophone équivalent]]
</includeonly>

Documenter un modèle plus complexe[modifier]

{{Documentation modèle compliqué en sous-page}}

== Utilisation ==
<!--indiquez quand utiliser ce modèle-->.

== Syntaxe ==
 <nowiki>{{</nowiki><!-- nom du modèle -->
 |paramètre1={{Param|valeur1}}
 |paramètre2={{Param|valeur2}}
 |paramètre3={{Param|valeur3}}
 |etc.
 }}

== Paramètres ==
* <code>paramètre1</code> : description1 (obligatoire).
* <code>paramètre2</code> : description2 (facultatif, ''défaut2'' par défaut).
* <code>paramètre3</code> : description3 (optionnel, lorsque <code>paramètre2</code> est fourni, ''défaut3'' par défaut).
* etc.

== Exemple ==
{{Entête tableau "Code Rendu"}}
|-
|<pre><!-- le même code --></pre>
|<!-- le même code -->
|}

== Variante ==
* {{M|<!--nom de modèle connexe-->}}

== Voir aussi ==
* [[<!--nom de page à voir-->]]

<includeonly>
<!-- Catégories et interwikis du modèle -->
[[Catégorie:Nom de la catégorie du modèle|{{PAGENAME}}]]

[[es:Template:Nom du modèle hispanophone équivalent]]
</includeonly>

Voir aussi[modifier]