L'Abri
m (A protégé « Modèle:Docparam » ([Modifier=Autoriser uniquement les utilisateurs autoconfirmés] (infini) [Renommer=Autoriser uniquement les utilisateurs autoconfirmés] (infini)))
(5 révisions intermédiaires par un autre utilisateur non affichées)
Ligne 2 : Ligne 2 :
   
 
--><div class="va-docparam"><!--
 
--><div class="va-docparam"><!--
--><div class="va-docparam-icon">{{#switch:{{{req}}}|no={{Icône|optionnel}}|semi={{Icône|semi-requis}}|yes|#default={{Icône|requis}}}}</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><!--
   
Ligne 15 : Ligne 15 :
 
{{Documentation}}
 
{{Documentation}}
   
[[Catégorie:Modèles de formatage]]
+
[[Catégorie:Modèles de mise en forme]]
   
 
[[en:Template:Docparam]]
 
[[en:Template:Docparam]]
 
[[ja:Template:Docparam]]
 
[[ja:Template:Docparam]]
  +
[[ru:Шаблон:Docparam]]

Version du 10 novembre 2020 à 10:37

Requis
Nom ?
Description ?
Documentation de modèle (Pour le modèle ci-dessus, parfois caché ou invisible)
Mbox default.png
Ce modèle est basé sur du 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

Requis
<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").
Optionnel
default, default2
La/les valeur(s) par défaut du paramètre.
Requis
desc
Description du paramètre.
Parfois requis ou au moins une fois
(défaut: "oui")
req
Spécifie si le paramètre est requis par le modèle pour fonctionner.

Options disponibles:

  • Oui oui : Toujours requis.
  • Neutre 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).
  • Neutre 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 :

Requis
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 :

Optionnel
(défaut: "paramètre par défaut")
Paramètre ou Alternatif, Similaire 1 jusqu'à Similaire 3
Description
Documentation extraite depuis Modèle:Docparam/doc.