« Modèle:Docparam » : différence entre les versions
Aucun résumé des modifications Balise : Éditeur de wikicode 2017 |
Aucun résumé des modifications Balise : Éditeur de wikicode 2017 |
||
(2 versions intermédiaires par le même utilisateur non affichées) | |||
Ligne 2 : | Ligne 2 : | ||
--><div class="va-docparam"><!-- | --><div class="va-docparam"><!-- | ||
--><div class="va-docparam- | --><div class="va-docparam-icon">{{#switch:{{{req}}}|no={{Icône|optional|petit}}|semi={{Icône|semi-required|petit}}|yes|#default={{Icône|required|petit}}}}</div><!-- | ||
-->{{#if:{{{default|}}}|<div class="va-docparam-default">(default: {{#switch:{{lc:{{{default}}}}}|none|-=none|#default="{{{default}}}"}}{{#if:{{{default2|}}}| ou {{#switch:{{lc:{{{default2}}}}}|none|-=none|#default="{{{default2}}}"}}}})</div>}}<!-- | -->{{#if:{{{default|}}}|<div class="va-docparam-default">(default: {{#switch:{{lc:{{{default}}}}}|none|-=none|#default="{{{default}}}"}}{{#if:{{{default2|}}}| ou {{#switch:{{lc:{{{default2}}}}}|none|-=none|#default="{{{default2}}}"}}}})</div>}}<!-- | ||
--><span class="va-docparam-params">'''{{#if:{{{name|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{name|{{{1|}}}}}}|| }}| >> |''' à '''}}| // |''' ou '''}}| ++ |''', '''}}|Nom ?}}</span>'''<!-- | --><span class="va-docparam-params">'''{{#if:{{{name|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{name|{{{1|}}}}}}|| }}| >> |''' à '''}}| // |''' ou '''}}| ++ |''', '''}}|Nom ?}}</span>'''<!-- |
Dernière version du 23 mars 2025 à 12:58
Nom ?
Description ?
Usage
{{Docparam|name=parameter|req=oui|desc=description}}
Parameters
<unnamed 1> ou name
Nom de(s) paramètre(s). Certaines chaînes sont automatiquement traduites pour permettre la spécification des choix alternatifs ou des plages de paramètres.
Chaînes traduites (tous ces besoin d'être entouré par des espaces):
>>
est converti en un tableau de bord avec des espaces autour de lui ("-"); utilisé pour indiquer plages de paramètres (eg "Game1 - game5")./ /
est converti en «ou»; utilisé pour d'autres choix (par exemple "<unnamed 1> ou titre»).+ +
est converti en virgule par un espace de fuite (","); utilisé pour une liste des paramètres qui sont séparés mais fonctionnent de la même (par exemple "contentA1, contentB1").
default, default2
Les valeur(s) par défaut du paramètre.
desc
Description du paramètre.
(default: "yes")
reqIndique si ce paramètre est requis pour le modèle de fonction.
Les options disponibles:
- non: totalement facultatif.
- semi: Le paramètre est nécessaire dans certaines circonstances, mais facultative dans d'autres. Pour une gamme de paramètres (réglage via
jusqu'à
, cela signifie qu'au moins un d'entre eux est nécessaire. - oui: toujours nécessaire.
Copier/coller
{{Docparam|name=|req=|default=|desc= }}
Exemples
Simple
{{Docparam|name=parameter|req=oui|default=|desc= Description }}
Devient :
parameter
Description
Avancé
{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc= Description }}
results in:
(default: "default setting")
parameter ou alternative, similar1 à similar3Description