Modèle:Docparam/doc

De Les Archives de Vault-Tec
Sauter à la navigation Sauter à la recherche

Usage[modifier le wikicode]

{{Docparam|name=parameter|req=oui|desc=description}}

Parameters[modifier le wikicode]

RequiertIcon required.png
<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").
RequiertIcon required.png
default, default2

Les valeur(s) par défaut du paramètre.

RequiertIcon required.png
desc

Description du paramètre.

Sometimes required or at least one requiredIcon semi-required.png
(default: "yes")
req

Indique 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[modifier le wikicode]

{{Docparam|name=|req=|default=|desc=

}}

Exemples[modifier le wikicode]

Simple[modifier le wikicode]

{{Docparam|name=parameter|req=oui|default=|desc=
Description
}}

Devient :

RequiertIcon required.png
parameter

Description

Avancé[modifier le wikicode]

{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
Description
}}

results in:

OptionnelIcon optional.png
(default: "default setting")
parameter ou alternative, similar1 à similar3

Description

Source[modifier le wikicode]