Template:Documentation/fr/doc

Description

Ce modèle est utilisé pour insérer des descriptions sur les pages de modèles.

Syntaxe

Ajoutez <noinclude>{{Documentation/fr}}</noinclude> à la fin de la page du modèle.

Ajoutez <noinclude>{{Documentation/fr|<page de documentation>}}</noinclude> pour transclure une page alternative de la sous-page /doc.

Utilisation

Sur la page Modèle

Ceci est le format normal lorsqu'il est utilisé :

CODE DU MODÈLE
<includeonly>Toutes les catégories à insérer dans les articles par le modèle</includeonly>
<noinclude>{{Documentation/fr}}</noinclude>

Si votre modèle n'est pas un div ou un tableau terminé, vous devrez peut-être fermer les balises juste avant que la partie {{Documentation/fr}} soit inséré (dans les balises noinclude).

Un saut de ligne juste avant {{Documentation/fr}} peut également être utile car il permet d'éviter que le modèle de documentation ne "se heurte" au code précédent.

Sur la page de documentation

La page de documentation se trouve généralement sur la sous-page /doc d'un modèle, mais une page différente peut être spécifiée avec le premier paramètre du modèle (voir Syntaxe).

Normalement, vous souhaiterez écrire quelque chose comme ce qui suit sur la page de documentation :

== Description ==
Ce modèle est utilisé pour faire quelque chose.

== Syntaxe ==
Tapez <code>{{t|templatename}}</code> quelque part.

==Samples==

<includeonly>[[Category:Documentation templates]]</includeonly><noinclude></noinclude>
<noinclude>[[Category:Template Docs]]</noinclude>

==Échantillons==
<code><nowiki>{{templatename|input}}</nowiki></code> 

résulte en...

{{templatename|input}}

<includeonly>Toutes catégories pour le modèle lui-même</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>

Utilisez tout ou partie des sections de description/syntaxe/exemple de sortie ci-dessus. Vous souhaiterez peut-être également ajouter « voir aussi » ou d'autres sections.

Notez que l'exemple ci-dessus utilise également le modèle Template:T.