Module:Yesno/documentation
Utilisation
Ce module propose une interface consistante pour traiter les entrées champ booléennes ou de style booléen. Alors que Lua autorise comme valeur booléennes true
et false
, les modèles en code wiki ne peuvent exprimer des valeurs booléennes qu'au travers de champs égaux à « oui », « non », etc. Ce module traite ce type de champs et les transforment en entrées booléennes qui peuvent être traitées par Lua. Il retourne la valeur nil
en l'absence de paramètre, ceci afin de faire la différence entre nil
et false
. Lorsque ce paramètre a une valeur imprévue, le module retourne la valeur par défaut ou nil
. Ce module accepte aussi les autres structures Lua comme entrée comme les booléens, les nombres, les tables et les fonctions.
Syntaxe
yesno(valeur, défaut, défautVide)
Paramètres
Champ | Fonction |
---|---|
valeur |
Valeur à tester |
défaut |
Valeur par défaut pour les valeurs qui ne sont ni assimilé à des booléens ni nil .
|
défautVide |
Si ce paramètre n'est pas nil , ce sera la valeur par défaut pour les chaines vides ou uniquement composée d'espaces, sauts de ligne…
|
Utilisation
Tout d'abord, il faut charger le module. Très important, ce module ne peut être chargé que depuis d'autres modules Lua et non depuis des pages wikis classiques. Pour celles-ci, utilisez plutôt le modèle {{Ouinon}}.
local yesno = require('Module:Yesno')