Redigerer Modul:Yesno/dok

{{Dokumentasjonsunderside}}
<includeonly>
{{Beskyttet side
| grunn = sentral modul
| liten = ja
}}
{{Mye brukt mal|over 37 000}}</includeonly>
Denne modulen tilbyr et konsekvent grensesnitt for å behandle boolske inndata, inkludert boolske tekststrengrepresentasjoner. Mens Lua bruker <code>true</code> og <code>false</code> som boolske verdier kan maler i wikikode bare representere boolske verdier i form av tekststrenger som "ja", "nei" etc. Denne modulen prosesserer slike strenger og konverterer dem til boolske verdier som kan brukes av Lua. Den returnerer også verdien <code>nil</code> som <code>nil</code> slik at man kan skille mellom <code>nil</code> og <code>false</code>. Modulen aksepterer også andre Lua-strukturer som inndata, f.eks. bool, tall, tabeller og funksjoner. Det er mulig å spesifisere en defaultverdi som skal returneres dersom modulen får inndata som den ikke gjenkjenner som en boolsk verdi eller <code>nil</code>.

== Syntaks ==
<syntaxhighlight lang="lua">yesno(value, default)</syntaxhighlight>

<code>value</code> er verdien som skal bli testet. Varianter av boolske verdier evalueres til enten <code>true</code> eller <code>false</code>, mens <code>nil</code> alltid evalueres til <code>nil</code>. Andre verdier evalueres til <code>default</code>.

== Bruk ==
Først må du laste modulen. Den kan bare lastes fra andre Lua-moduler, ikke fra vanlige wikisider. Fra vanlige wikisider kan du bruke malen {{tl|yesno}}.

<syntaxhighlight lang="lua">
local yesno = require('Module:Yesno')
</syntaxhighlight>

Noen inndataverdier returnerer alltid <code>true</code>, mens andre alltid returnerer <code>false</code>. <code>nil</code> returnerer alltid <code>nil</code>.

<syntaxhighlight lang="lua">
-- Disse skal alltid returnere true:
yesno('ja')
yesno('j')
yesno('yes')
yesno('y')
yesno('true')
yesno('1')
yesno(1)
yesno(true)

-- Disse skal alltid returnere false:
yesno('nei')
yesno('no')
yesno('n')
yesno('false')
yesno('0')
yesno(0)
yesno(false)

-- En nil-verdi returnerer alltid nil:
yesno(nil)
</syntaxhighlight>

Tekstverdier konverteres til små bokstaver før de blir sammenliknet:

<syntaxhighlight lang="lua">
-- Disse skal alltid returnere true:
yesno('JA')
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- Disse skal alltid returnere false:
yesno('nEi')
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')
</syntaxhighlight>

Du kan angi en defaultverdi som yesno returnerer dersom den får andre inndata enn de som er nevnt over. Dersom du ikke angir en defaultverdi returnerer modulen <code>nil</code> for slike verdier.

<syntaxhighlight lang="lua">
-- Disse returnerer nil:
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)

-- Disse returnerer true:
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)

-- Disse returnerer "bar":
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')
</syntaxhighlight>

Legg merke til at en tom streng oppfører seg på samme måte:
<syntaxhighlight lang="lua">
yesno('')        -- Returnerer nil.
yesno('', true)  -- Returnerer true.
yesno('', 'bar') -- Returnerer "bar".
</syntaxhighlight>

Legg merke til: Selv om en tom streng vanligvis blir evaluert til false i wikitekst og til true i Lua evalueres den til nil av denne modulen.

<includeonly>[[Kategori:Metamoduler]]</includeonly>