Docparam

Version du 10 novembre 2020 à 10:37

Nom ?

Description ?

Documentation de modèle (Pour le modèle ci-dessus, parfois caché ou invisible)

Sommaire

1 Utilisation
- 1.1 Paramètres
2 Copier / coller
3 Exemples
- 3.1 Simple
- 3.2 Avancé

	Ce modèle est basé sur du CSS MediaWiki:Common.css.

Modèle pour les formatages standardisés des paramètres de modèles dans la documentation de modèle.

Utilisation

{{Docparam|nom=paramètre|req=oui|desc=description}}

Paramètres

<sans nom 1> ou nom

Le nom des paramètre(s). Certaines lignes sont automatiquement traduites pour permettre une spécification d'un choix alternatif ou de de distance de paramètres.

Les phrases traduites (celles-ci on besoin d'être clôturées par des espaces):

>> est converti en "jusqu'à"; utilisée pour indiquer les extrémités du paramètre (par exemple : "Jeu 1 jusqu'à Jeu 5").
// est converti en "ou"; utilisée pour des choix alternatifs (par exemple "<Sans nom 1> or titre").
++ est converti en une virgule avec un espace de fuite (", "); utilisé pour lister les paramètres séparés mais fonctionne de la même manière (par exemple "ContenuA1, ContenuB1").

default, default2

La/les valeur(s) par défaut du paramètre.

desc

Description du paramètre.

(défaut: "oui")

req

Spécifie si le paramètre est requis par le modèle pour fonctionner.

Options disponibles:

oui : Toujours requis.
semi : Le paramètre est requis dans certains circonstances mais optionnel dans d'autres. Pour un intervalle de paramètres (fixés via la ligne up to), ceci signifie qu'au moins l'un d'entre eux est requis).
non : Complètement optionnel.

Copier / coller

{{Docparam|nom=|req=|défaut=|desc=
}}

Exemples

Simple

{{Docparam|nom=paramètre|req=oui|défaut=|desc=
Description
}}

Résulte en :

Paramètre

Description

Avancé

{{Docparam|nom=paramètre // alternative ++ similar1 >> similar3|req=non|défaut=paramètre par défaut|desc=
Description
}}

Résulte en :

(défaut: "paramètre par défaut")

Paramètre ou Alternatif, Similaire 1 jusqu'à Similaire 3

Description

Documentation extraite depuis Modèle:Docparam/doc.

@@ Ligne 1 : / Ligne 1 : @@
-<!--
+<onlyinclude><!--
 --><div class="va-docparam"><!--
- --><div class="va-docparam-icon">{{#switch:{{{req}}}|no={{Icône|optional}}|semi={{Icône|semi-required}}|yes|#default={{Icône|required}}}}</div><!--
+ --><div class="va-docparam-icon">{{#switch:{{{req}}}|non={{Icône|optionnel}}|semi={{Icône|semirequis}}|oui|#défaut={{Icône|requis}}}}</div><!--
- -->{{#if:{{{default|}}}|<div class="va-docparam-default">(default: {{#switch:{{lc:{{{default}}}}}|none|-=none|#default="{{{default}}}"}}{{#if:{{{default2|}}}|&#032;or {{#switch:{{lc:{{{default2}}}}}|none|-=none|#default="{{{default2}}}"}}}})</div>}}<!--
+ -->{{#if:{{{défaut|}}}|<div class="va-docparam-default">(défaut: {{#switch:{{lc:{{{défaut}}}}}|aucun|-=none|#défaut="{{{défaut}}}"}}{{#if:{{{défaut2|}}}|&#032;or {{#switch:{{lc:{{{défaut2}}}}}|aucun|-=none|#défaut="{{{défaut2}}}"}}}})</div>}}<!--
- --><span class="va-docparam-params">'''{{#if:{{{name|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{name|{{{1|}}}}}}||&#032;}}|&#032;>>&#032;|''' jusqu'à '''}}|&#032;//&#032;|''' ou '''}}|&#032;++&#032;|''', '''}}|Name?}}</span>'''<!--
+ --><span class="va-docparam-params">'''{{#if:{{{nom|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{nom|{{{1|}}}}}}||&#032;}}|&#032;>>&#032;|''' jusqu'à '''}}|&#032;//&#032;|''' ou '''}}|&#032;++&#032;|''', '''}}|Nom ?}}</span>'''<!--
 --></div><!--
 --><div class="va-docparam-desc"><!--
- -->{{{desc|Description?}}}<!--
+ -->{{{desc|Description ?}}}<!--
 --></div><!--
+--></onlyinclude>
--->
+{{Documentation}}
-[[Catégorie:Modèles de formatage]]
+[[Catégorie:Modèles de mise en forme]]
 [[en:Template:Docparam]]
 [[ja:Template:Docparam]]
+[[ru:Шаблон:Docparam]]