Module:Yesno: Difference between revisions

From WIDEVERSE Wiki
Jump to navigation Jump to search
m (move boolean args to the respective if blocks)
(Created page with "-- Function allowing for consistent treatment of boolean-like wikitext input. -- It works similarly to the template {{yesno}}. return function (val, default) -- If your wiki...")
Line 1: Line 1:
--[[
-- Function allowing for consistent treatment of boolean-like wikitext input.
{{Helper module|name=Yesno
-- It works similarly to the template {{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( arg, default )
return function (val, default)
    arg = type( arg ) == 'string' and mw.ustring.lower( arg ) or arg
-- If your wiki uses non-ascii characters for any of "yes", "no", etc., you
 
-- should replace "val:lower()" with "mw.ustring.lower(val)" in the
    if arg == nil then
-- following line.
        return nil
val = type(val) == 'string' and val:lower() or val
    end
if val == nil then
 
return nil
    if
elseif val == true  
        arg == true or
or val == 'yes'
        arg == 'yes' or
or val == 'y'
        arg == 'y' or
or val == 'true'
        arg == 'true' or
or val == 't'
        tonumber( arg ) == 1
or val == 'on'
    then
or tonumber(val) == 1
        return true
then
    end
return true
 
elseif val == false
    if
or val == 'no'
        arg == false or
or val == 'n'
        arg == 'no' or
or val == 'false'
        arg == 'n' or
or val == 'f'
        arg == 'false' or
or val == 'off'
        arg == '' 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 18:56, 5 November 2021

This module is a helper module to be used by other modules; it may not designed to be invoked directly. See RuneScape:Lua/Helper modules for a full list and more information. For a full list of modules using this helper click here

FunctionTypeUse
(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

-- Function allowing for consistent treatment of boolean-like wikitext input.
-- It works similarly to the template {{yesno}}.

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