Module:Yesno/doc/fr
 | Ceci est une sous-page de documentation de Module:Yesno/doc. Elle regroupe les informations d'utilisation, les catégories et d'autres contenus ne figurant pas sur la page originale Module. |
 Attention: | Cette page est partagée entre plusieurs wikis. Toutes les modifications apportées à cette page seront automatiquement copiées sur tous les wikis répertoriés dans la barre de gauche. |
 | Ce module Lua est utilisé sur plusieurs pages. Pour éviter de propager les dégradations sur une large échelle et une surcharge inutile des serveurs, toute modification apportée à ce module doit d'abord être testée à partir de ses sous-pages /sandbox ou /testcases . Les modifications testées peuvent ensuite être ajoutées à cette page en une seule passe. Veuillez débattre de toute modification sur la page de discussion avant de l'implémenter. |
 | Ce $1 est utilisé dans les messages système. Sa modification peut entraîner des modifications immédiates de l'interface utilisateur MediaWiki. Pour éviter les dégradations à grande échelle, toute modification doit d'abord être testée dans cette sous page /sandbox ou /testcases de module, ou dans votre propre espace utilisateur.Les modifications testées peuvent ensuite être ajoutées en une fois dans ce $1. Veuillez d'abord discuter toute modification sur la page de discussion avant de l'implémenter. |
 | Ce module est évalué à prêt pour utilisation générale. Il a atteint un degré de maturité suffisant et est supposé sans bogue et prêt à être utilisé où il est nécessaire. Il est prêt à être référencé dans les pages d'aide et autres ressources en tant qu'option pour que les nouveaux utilisateurs en prennent connaissance. Pour réduire la charge des serveurs et les sorties erronées, il doit être mis au point en faisant les tests dans le bac à sable plutôt que de boucler la séquence correction / test sur la page officielle. |
 | Ce module est sujet à la protection de page. Il est très visible car il est utilisé sur un très grand nombre de pages. Il est protégé en écriture parce que le vandalisme ou des erreurs perturberaient un grand nombre de pages, et même des modifications basiques peuvent apporter une surcharge substantielle aux serveurs. |
Ce module fournit une interface cohérente pour traiter les entrées booléennes ou des chaînes de ce style.
While Lua allows the true and false boolean values, wikicode templates can only express boolean values through strings such as "1", "0", "yes", "no", etc.
This module processes these kinds of strings and turns them into boolean input for Lua to process.
It also returns nil values as nil, to allow for distinctions between nil and false.
The module also accepts other Lua structures as input, i.e. booleans, numbers, tables, and functions.
If it is passed input that it does not recognise as boolean or nil, it is possible to specify a default value to return.
Qualité du module
- Diff sandbox code
Syntaxe
yesno(value, default)
value est la valeur à tester.
Boolean input or boolean-style input (see below) always evaluates to either true or false, and nil always evaluates to nil.
Other values evaluate to default.
Utilisation
First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages. For normal wiki pages you can use {{yesno}} instead.
local yesno = require('Module:Yesno')
Some input values always return true, and some always return false.
nil values always return nil.
-- These always return true:
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)
-- These always return false:
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)
-- A nil value always returns nil:
yesno(nil)
String values are converted to lower case before they are matched:
-- These always return true:
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')
-- These always return false:
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')
You can specify a default value if yesno receives input other than that listed above.
If you don't supply a default, the module will return nil for these inputs.
-- These return nil:
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)
-- These return true:
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)
-- These return "bar":
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')
Note that the blank string also functions this way:
yesno('') -- Returns nil.
yesno('', true) -- Returns true.
yesno('', 'bar') -- Returns "bar".
Although the blank string usually evaluates to false in wikitext, it evaluates to true in Lua.
This module prefers the Lua behaviour over the wikitext behaviour.
If treating the blank string as false is important for your module, you will need to remove blank arguments at an earlier stage of processing.