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

De Pikmin FR
imported>Default
mise à jour - voir ici
 
m 5 versions importées
 
(5 versions intermédiaires par 2 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
;Description
==Description==
:Ce modèle est utilisé pour insérer des descriptions sur les pages de modèle.
This template is used to insert descriptions on template pages.
;Syntaxe
 
:Saisissez <code><nowiki><noinclude></nowiki>{{m|documentation}}<nowiki></noinclude></nowiki></code> à la fin de la page du modèle.
==Syntax==
Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
 
==Usage==
 
===On the Template page===
This is the normal format when used:


==Utilisation générale==
===Sur la page du modèle===
<pre>
<pre>
Code du modèle<includeonly>Toute catégorie à insérer dans les pages par le biais du modèle</includeonly><noinclude>
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
{{documentation}}</noinclude>
</pre>
</pre>


À noter que, en fonction du modèle, vous pouvez avoir besoin d'ajouter un clear ou finir un tableau/div avant que <code><nowiki>{{documentation}}</nowiki></code> soit inséré (dans les balises noinclude).
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).''


Le saut de ligne est aussi utile comme il aide à éviter que la documentation du modèle chevauche le code au-dessus.
''A line break right before <code><nowiki>{{documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''
 
===On the Template/doc page===
Normally, you will want to write something like the following on the documentation page:


===Sur la page Modèle/doc page===
<pre>
<pre>
;Description
==Description==
:Ce modèle est utilisé pour faire ceci.
This template is used to do something.
;Syntaxe
:Saisissez <code>{{m|nomdumodèle}}</code> quelque part.
;Exemple d'utilisation
:<code><nowiki>{{nomdumodèle|truc}}</nowiki></code> donne...
:{{nomdumodèle|truc}}


<includeonly>N'importe quelle catégorie pour le modèle lui-même</includeonly><noinclude>[[Catégorie:Documentation de modèle|{{PAGENAME}}]]</noinclude>
==Syntax==
Type <code>{{t|templatename}}</code> somewhere.
 
==Samples==
<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>
 
results in...
 
{{templatename|input}}
 
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
</pre>
</pre>


Utilisez n'importe quelle ou toutes les sections ci-dessus. Vous pouvez aussi vouloir ajouter une section « Voir aussi » ainsi que d'autres à titre d'information.
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
 
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.


À noter que l'exemple ci-dessus utilise aussi les modèles [[Modèle:M]] et [[Modèle:M/piece]].
<includeonly>[[Category:Modèles|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Documentation de modèle|{{PAGENAME}}]]</noinclude>
<noinclude>[[Catégorie:Documentation de modèle|{{PAGENAME}}]]</noinclude>

Dernière version du 8 avril 2025 à 16:59

Description

This template is used to insert descriptions on template pages.

Syntax

Add <noinclude>{{documentation}}</noinclude> at the end of the template page.

Usage

On the Template page

This is the normal format when used: 

TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>

If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).

A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

Normally, you will want to write something like the following on the documentation page: 

==Description==
This template is used to do something.

==Syntax==
Type <code>{{t|templatename}}</code> somewhere.

==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code> 

results in...

{{templatename|input}}

<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.

Note that the above example also uses the Template:T and Template:T/piece templates.

Récupérée de « https://pikmin-fr.wiki/w/index.php?title=Modèle:Documentation/doc&oldid=240 »