Module:MOS scalesig

Module documentation[view] [edit] [history] [purge]

Note: Do not invoke this module directly; use the corresponding template instead: Template:MOS scalesig.

This module depends on the following other modules: Module: Arguments Module: MOS Module: Utils Module: Yesno

This module formats a string into a mos scale signature, with non-breaking spaces. Scale signatures can optionally be formatted as a link to the scale's wiki page.

To include this module in other modules, use local mos_scalesig = require("Module:MOS scalesig")._mos_scalesig.

---

local p = {}

local getArgs = require("Module:Arguments").getArgs
local mos = require("Module:MOS")
local yesno = require("Module:Yesno")

-- "Main" function; calls appropriate mos-string functions
function p._mos_scalesig(input_mos, is_link, is_long)
	local is_link = yesno(is_link, false)		-- Should the the scalesig be a link?
	local is_long = yesno(is_long, false)		-- Should the scalesig be in the long form "xL ys (p/q-equivalent)"?
	
	return (is_link == true
		and (is_long and mos.as_long_link(input_mos) or mos.as_link(input_mos))
		or (is_long and mos.as_long_string(input_mos) or mos.as_string(input_mos)))
end

-- Wrapper function
function p.mos_scalesig(frame)
	local args = getArgs(frame)
	
	local input_mos = mos.parse(args["scalesig"])
	local is_link = yesno(args["link"], false)
	local is_long = yesno(args["long"], false)
	local debugg = yesno(args["debug"])
	local result = p._mos_scalesig(input_mos, is_link, is_long)
	
	-- Debugger option
	if debugg == true then
		result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
	end
	
	return frame:preprocess(result)
end

function p.tester()
	local input_mos = mos.new(5, 2)
	return p._mos_scalesig(input_mos, true, true)
end

return p