Module:Sharpness documentation

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

This module should not be invoked directly; use its corresponding template instead: Template:Sharpness documentation.

This module is used for Template:Sharpness documentation to automate information for sharpness templates (templates that show how many steps sharps or flats raise or lower by).

By default, it handles standard sharps and flats, quarter-tone accidentals, and ups and downs notation.

Introspection summary for Module:Sharpness documentation
Functions provided (1) Line Function Params 4 main (invokable) (frame)	Lua modules required (1) Variable Module Functions used yesno Module:yesno yesno

No function descriptions were provided. The Lua code may have further information.

See also

• Category:Sharpness tables

---

local yesno = require("Module:yesno")
local module = {}

function module.main(frame)
	local in_str = frame.args["input"]
	local note = frame.args["note"] or ""
	local notation = frame.args["notation"] or ""

	-- typ: "sharp" or "flat"
	-- value: absolute value of sharpness (the "n" as in sharp-n and flat-n)
	-- extension: used for identifying alternative symbol set
	local typ, value, extension, suffix = in_str:match("%-(%a*)(%d+)(%a*)-?(%a*)")

	-- signed sharpness
	local s = tonumber(value)
	if typ == "flat" then
		s = -s
	end

	if extension == nil then
		extension = ""
	end

	local out_str = "This template is used "

	if s == 0 then
		out_str = out_str
			.. "for {{EDOs| 7, 14, 21, 28, and 35 }} [[equal divisions of the octave]]. "
			.. "Since these tunings temper out the 3-limit augmented unison ([[2187/2048]], known as the Pythagorean apotome), "
			.. "going up seven fifths brings one back to the root note, and as such, "
			.. "the traditional sharps and flats are redundant and cannot raise or lower the pitch."
	else
		out_str = out_str
			.. "for [[edo]]s where a sharp "
			.. ((s < 0) and "lowers" or "raises")
			.. " by "
			.. math.abs(s)
			.. " step"

		if math.abs(s) ~= 1 then
			out_str = out_str .. "s"
		end

		out_str = out_str .. "."

		if notation == "" then
			out_str = out_str .. " This symbol set "

			if math.abs(s) == 1 then
				out_str = out_str .. "is identical to standard notation."
			else
				if extension == "" then
					if math.abs(s) == 2 then
						out_str = out_str
							.. "comprises sharps, flats, and Stein&ndash;Zimmerman [[24edo #Notation|quartertone]] accidentals."
					else
						out_str = out_str
							.. "is based on [[ups and downs notation]] and comprises sharps, flats, "
							.. (s % 2 == 0 and "naturals, and Stein&ndash;Zimmerman [[24edo #Notation|quartertone]] accidentals " or "and naturals ")
							.. "with arrows from [[Helmholtz&ndash;Ellis notation]]."
					end
				elseif extension == "a" or extension == "A" then -- extension for modern-style ups and downs
					out_str = out_str .. "is based on [[ups and downs notation]] using separate arrows."
				end
			end
		else
			out_str = out_str .. " It is based on " .. notation .. "."
		end

		-- display custom note
		if note then
			out_str = out_str .. " " .. note
		end

		-- display the note about supersets of 12edo for sharpness-1 and above
		if s >= 1 then
			local n_edo = s * 12 -- edo number for supersets of 12edo

			out_str = out_str
				.. "\n\n<h3>Parameters</h3>\n"
				.. "Passing <code>{{pipe}}"
				.. n_edo
				.. "</code> will change '''Step offset''' to '''Semitones''' in the case of [["
				.. n_edo
				.. "edo]]"
			if s >= 2 then
				out_str = out_str .. ", since " .. n_edo .. "edo is a superset of [[12edo]]"
			end
			out_str = out_str .. "."
		end

		-- display the "see also" section for sharpness-2 and above
		if s >= 2 then
			local basic = "Template:Sharpness-" .. typ .. value
			local basic_suf = basic .. "-" .. suffix
			out_str = out_str .. "\n\n<h3>See also</h3>\n"
			
			if (extension == "a" or extension == "A") then
				out_str = out_str
					.. "* [[Alternative symbols for ups and downs notation]]\n"
					.. "* [[{{#ifexist: " .. basic_suf .. "|" .. basic_suf .. "|" .. basic .. "}}]] &ndash; "
					.. (s == 2
						and "uses Stein&ndash;Zimmerman quarter tone accidentals."
						or "the classic version of this template that shows arrows attached to standard accidentals.")
			else
				out_str = out_str .. "{{#ifexist: " .. basic .. "a|* [[" .. basic .. "a]] &ndash; "
					.. "an alternate version of this template that shows separate arrows.|}}\n"
				
				if string.lower(suffix) ~= "extended" then
					out_str = out_str .. "{{#ifexist: " .. basic .. "-extended|* [[" .. basic .. "-extended]] &ndash; "
					.. "an alternate version of this template that includes "
				end
				
				if s == 3 then
					out_str = out_str .. "double"
				elseif s == 5 then
					out_str = out_str .. "triple"
				end
				
				out_str = out_str .. " arrows.|}}"
			end
		end
	end

	local is_debug = yesno(frame.args["debug"])
	return frame:preprocess(is_debug == true and "<pre>" .. out_str .. "</pre>" or out_str)
end

return module