Difference between revisions of "Module:Yesno"

From Game Detectives Wiki
Jump to: navigation, search
(Add inline comments)
m (31 revisions imported)
 
(33 intermediate revisions by 10 users not shown)
Line 1: Line 1:
local p = {}
+
-- Function allowing for consistent treatment of boolean-like wikitext input.
+
-- It works similarly to the template {{yesno}}.
function p.yesno( frame )
+
 
+
return function (val, default)
    -- defaults
+
-- If your wiki uses non-ascii characters for any of "yes", "no", etc., you
    local retvals = {
+
-- should replace "val:lower()" with "mw.ustring.lower(val)" in the
        yes  = "yes",
+
-- following line.
        no   = "",
+
val = type(val) == 'string' and val:lower() or val
        ["¬"] = ""
+
if val == nil then
    }
+
return nil
+
elseif val == true
    -- Allow arguments to override defaults.
+
or val == 'yes'
    -- 'any' tracks the presence of any arguments at all.
+
or val == 'y'
    local any = false
+
or val == 'true'
    for k,v in pairs( frame.args ) do
+
or val == 't'
        any = true
+
or tonumber(val) == 1
        retvals[k] = v
+
then
    end
+
return true
+
elseif val == false
    val = frame.args[1]
+
or val == 'no'
+
or val == 'n'
    -- According to the template docs, the input should be considered nil
+
or val == 'false'
    -- only when no params were provided. If any params at all were present,
+
or val == 'f'
    -- the value must be considered blank. A bit weird, if you ask me.
+
or tonumber(val) == 0
    if (val == nil and not any) or val == '¬' then
+
then
        return retvals['¬']
+
return false
    end
+
else
+
return default
    val = (val or ''):lower()          -- Coerce to blank if nil; make lowercase.
+
end
    val = val:match'^%s*(.*%S)' or ''  -- Trim whitespace.
 
 
    if val == '' then
 
        return retvals['blank'] ~= nil and retvals['blank'] or retvals['no']
 
    elseif val == 'n' or val == 'no' or val == '0' then
 
        return retvals['no']
 
    elseif val == 'y' or val == 'yes' or val == '1' or retvals['def'] == nil then
 
        return retvals['yes']
 
    else
 
        return retvals['def']
 
    end
 
 
end
 
end
 
return p
 

Latest revision as of 02:45, 18 May 2018

Documentation for this module may be created at Module:Yesno/doc

-- 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 tonumber(val) == 1
	then
		return true
	elseif val == false
		or val == 'no'
		or val == 'n'
		or val == 'false'
		or val == 'f'
		or tonumber(val) == 0
	then
		return false
	else
		return default
	end
end