Module:Yesno: Difference between revisions

From Old School Near-Reality Wiki
Jump to navigation Jump to search
(Undid revision 948472533 by [[Special:Contributions/w>Vogone|w>Vogone]] ([[User talk:w>Vogone|talk]]))
 
(Created page with "--[[ {{Helper module|name=Yesno |fname1=(arg) |ftype1=Any value |fuse1=Reads arg for yes/no and returns the appropriate boolean or nil |fname2=(arg1,arg2) |ftype2=Any value, Any value |fuse2=Reads arg1 for yes/no and returns the appropriate boolean; returns arg2 if arg1 was not an applicable value }} --]] -- <pre> -- Used to evaluate args to booleans where applicable -- -- Based on <https://en.wikipedia.org/wiki/Module:Yesno> -- see page history there for contributors --...")
Line 1: Line 1:
-- Function allowing for consistent treatment of boolean-like wikitext input.
--[[
-- It works similarly to the template {{yesno}}.
{{Helper module|name=Yesno
|fname1=(arg)
|ftype1=Any value
|fuse1=Reads arg for yes/no and returns the appropriate boolean or nil
|fname2=(arg1,arg2)
|ftype2=Any value, Any value
|fuse2=Reads arg1 for yes/no and returns the appropriate boolean; returns arg2 if arg1 was not an applicable value
}}
--]]
-- <pre>
-- Used to evaluate args to booleans where applicable
--
-- Based on <https://en.wikipedia.org/wiki/Module:Yesno>
-- see page history there for contributors
--


return function (val, default)
return function( arg, default )
-- If your wiki uses non-ascii characters for any of "yes", "no", etc., you
    arg = type( arg ) == 'string' and mw.ustring.lower( arg ) or arg
-- should replace "val:lower()" with "mw.ustring.lower(val)" in the
 
-- following line.
    if arg == nil then
val = type(val) == 'string' and val:lower() or val
        return nil
if val == nil then
    end
return nil
 
elseif val == true  
    if
or val == 'yes'
        arg == true or
or val == 'y'
        arg == 'yes' or
or val == 'true'
        arg == 'y' or
or val == 't'
        arg == 'true' or
or val == 'on'
        tonumber( arg ) == 1
or tonumber(val) == 1
    then
then
        return true
return true
    end
elseif val == false
 
or val == 'no'
    if
or val == 'n'
        arg == false or
or val == 'false'
        arg == 'no' or
or val == 'f'
        arg == 'n' or
or val == 'off'
        arg == 'false' or
or tonumber(val) == 0
        tonumber( arg ) == 0
then
    then
return false
        return false
else
    end
return default
 
end
    return default
end
end

Revision as of 17:46, 3 October 2022

--[[ This module is a helper module to be used by other modules; it may not be designed to be invoked directly. See Near-Reality:Lua/Helper modules for a full list and more information.

ModuleFunctionTypeUse
Yesno(arg)Any valueReads arg for yes/no and returns the appropriate boolean or nil
(arg1,arg2)Any value, Any valueReads arg1 for yes/no and returns the appropriate boolean; returns arg2 if arg1 was not an applicable value

--]]

--

-- Used to evaluate args to booleans where applicable
--
-- Based on <https://en.wikipedia.org/wiki/Module:Yesno>
-- see page history there for contributors
--

return function( arg, default )
    arg = type( arg ) == 'string' and mw.ustring.lower( arg ) or arg

    if arg == nil then
        return nil
    end

    if
        arg == true or
        arg == 'yes' or
        arg == 'y' or
        arg == 'true' or
        tonumber( arg ) ==  1
    then
        return true
    end

    if
        arg == false or
        arg == 'no' or
        arg == 'n' or
        arg == 'false' or
        tonumber( arg ) == 0
    then
        return false
    end

    return default
end