Module:Sharpness szg documentation - Revision history

FloraC at 11:26, 12 May 2026

2026-05-12T11:26:38Z

← Older revision		Revision as of 11:26, 12 May 2026
Line 107:		Line 107:
	local basic_suf = basic .. "-" .. suffix		local basic_suf = basic .. "-" .. suffix
	result = result .. "\n\n<h3>See also</h3>\n"		result = result .. "\n\n<h3>See also</h3>\n"
	.. "* [[~~Alternative symbols for ups and downs~~ notation]]\n"		.. "* [[Stein–Zimmermann–Gould notation]]\n"

	if (extension == "a" or extension == "A") then		if (extension == "a" or extension == "A") then

Dave Keenan: Added line break
before "This symbol set ...".

2026-05-03T04:31:20Z

Added line break <br> before "This symbol set ...".

← Older revision		Revision as of 04:31, 3 May 2026
Line 51:		Line 51:

	if notation == "" then		if notation == "" then
	result = result .. " This symbol set "		result = result .. "<br>This symbol set "

	if math.abs(s) == 1 then		if math.abs(s) == 1 then

Dave Keenan: Further modifications to make sharpness-0 documentation behave more like others.

2026-05-03T04:26:40Z

Further modifications to make sharpness-0 documentation behave more like others.

← Older revision		Revision as of 04:26, 3 May 2026
Line 48:		Line 48:

	result = result .. "."		result = result .. "."
			end

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

	~~if notation == "" then~~		if math.abs(s) == 1 then
	~~result = result .. " This symbol set "~~		result = result .. "is identical to standard notation."
			else
	if math.abs(s) == 1 then		if extension == "" then
	result = result .. "is identical to standard notation."		if math.abs(s) == 2 then
	else		-- If a sharp raises by two steps
	if extension == "" then		result = result
	if math.abs(s) == 2 then		.. "comprises sharps, flats, and Stein–Zimmermann [[24edo #Notation\|quartertone]] accidentals."
	-- If a sharp raises by two steps		else
			if s == 0 then
	result = result		result = result
	.. "~~comprises sharps, flats, and Stein–Zimmermann~~ [[~~24edo #Notation\|quartertone~~]] accidentals."		.. "is based on [[ups and downs notation]] and comprises naturals "
			.. "with arrows from [https://w3c-cg.github.io/smufl/latest/tables/gould-arrow-quartertone-accidentals-24-edo.html Gould notation]."
	else		else
	-- Otherwise (if a sharp raises by three or more steps)		-- Otherwise (if a sharp raises by three or more steps)
Line 67:		Line 73:
	.. "with arrows from [https://w3c-cg.github.io/smufl/latest/tables/gould-arrow-quartertone-accidentals-24-edo.html Gould notation]."		.. "with arrows from [https://w3c-cg.github.io/smufl/latest/tables/gould-arrow-quartertone-accidentals-24-edo.html Gould notation]."
	end		end
	~~elseif extension == "a" or extension == "A" then~~
	~~-- Extension for modern-style ups and downs~~
	~~result = result .. "is based on [[ups and downs notation]] using separate up and down chevrons."~~
	end		end
			elseif extension == "a" or extension == "A" then
			-- Extension for modern-style ups and downs
			result = result .. "is based on [[ups and downs notation]] using separate up and down chevrons."
	end		end
	~~else~~
	~~result = result .. string.format(" It is based on %s.", notation)~~
	end		end
			else
			result = result .. string.format(" It is based on %s.", notation)
			end

	-- display custom notes		-- display custom notes
	if note or aux_note then		if note or aux_note then
	result = result .. " " .. note ..(aux_note ~= "" and "\n\n" .. aux_note or "")		result = result .. " " .. note ..(aux_note ~= "" and "\n\n" .. aux_note or "")
	end		end

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

	result = result		result = result
	.. "\n\n<h3>Parameters</h3>\n"		.. "\n\n<h3>Parameters</h3>\n"
	.. string.format("Passing in <code>%d</code> as a single unnamed parameter will change "		.. string.format("Passing in <code>%d</code> as a single unnamed parameter will change "
	.. "'''Step offset''' to '''Semitones''' in the case of [[%dedo]]", n_edo, n_edo)		.. "'''Step offset''' to '''Semitones''' in the case of [[%dedo]]", n_edo, n_edo)
	if s >= 2 then		if s >= 2 then
	result = result .. string.format(", since %dedo is a superset of [[12edo]]", n_edo)		result = result .. string.format(", since %dedo is a superset of [[12edo]]", n_edo)
	~~end~~
	~~result = result .. "."~~
	end		end
			result = result .. "."
	end		end

Dave Keenan: Change the if-then-else nesting so that the See Also section works for sharpness zero.

2026-05-03T03:57:35Z

Change the if-then-else nesting so that the See Also section works for sharpness zero.

← Older revision		Revision as of 03:57, 3 May 2026
Line 94:		Line 94:
	result = result .. "."		result = result .. "."
	end		end
			end

	-- Display a "see also" section for sharpness-2 and above		-- Display a "see also" section for sharpness-2 and above, and sharpness-0
	if s >= 2 or s <= -2 or s == 0 then		if s >= 2 or s <= -2 or s == 0 then
	local basic = "Template:Sharpness-" .. typ .. value		local basic = "Template:Sharpness-" .. typ .. value
	local basic_suf = basic .. "-" .. suffix		local basic_suf = basic .. "-" .. suffix
	result = result .. "\n\n<h3>See also</h3>\n"		result = result .. "\n\n<h3>See also</h3>\n"
	.. "* [[Alternative symbols for ups and downs notation]]\n"		.. "* [[Alternative symbols for ups and downs notation]]\n"

			if (extension == "a" or extension == "A") then
			-- If the template shows separate up and down chevrons
			result = result
			.. string.format("* [[{{#ifexist: %s\|%s\|%s}}]] – ", basic_suf, basic_suf.."-szg", basic.."-szg")
			.. (s == 2
			and "uses Stein–Zimmermann quarter tone accidentals."
			or "the classic version of this template that shows arrows attached to standard accidentals.")
			else
			-- If the template shows integrated (Gould-like) arrows
			result = result .. string.format("{{#ifexist: %sa\|* [[%s]] – ", basic, basic.."a-szg")
			.. "an alternate version of this template that shows separate up and down chevrons.\n\|}}"

	if (~~extension == "a" or extension =~~= "A") then		if string.lower(suffix) ~= "" then
	-- If the ~~template shows separate up and down chevrons~~		-- If we are on a different version of a template (e.g. "extended" ones that show more arrows than the minimum)
	result = result		result = result .. string.format("{{#ifexist: %s\|* [[%s]] – ", basic, basic.."-szg")
	.. string.format("* [[{{#ifexist: %s\|%s~~\|%s}}~~]] – ", ~~basic_suf, basic_suf.."-szg"~~, basic.."-szg")		.. "the basic version of this template.\|}}"
	.. ~~(s == 2~~
	~~and "uses Stein–Zimmermann quarter tone accidentals."~~
	or "the ~~classic~~ version of this template ~~that shows arrows attached to standard accidentals~~.")
	else		else
	-- ~~If the template shows integrated (Gould-like) arrows~~		-- Otherwise, add an additional note for possible extended versions, if they exist
	result = result .. string.format("{{#ifexist: %sa\|* [[%s]] – ", basic, basic.."a-szg")		if s % 2 == 1 and s >= 3 then
	.. "an alternate version of this template that ~~shows separate up and down chevrons.\n\|}}~~"		result = result .. string.format("{{#ifexist: %s-extended\|* [[%s]] – ", basic, basic.."-extended-szg")
			.. "an alternate version of this template that includes "

	if ~~string.lower(suffix) ~~~= "" then		if s == 3 then
	-- ~~If we are on a different version of a template (e.g. "extended" ones~~ that ~~show more~~ arrows ~~than the minimum)~~		-- Sharp-3 EDOs normally only need single arrows, but note that
	result = result .. ~~string.format(~~"~~{{#ifexist: %s\|* [[%s]] – ", basic, basic.."-szg")~~		-- sometimes double arrows may be needed
	~~.. "the basic version of this template.\|}}~~"		result = result .. "double"
	~~else~~		elseif s == 5 then
	~~-- Otherwise, add an additional note for possible extended versions, if they exist~~		-- Sharp-5 EDOs normally need double arrows, and note that sometimes
	if s ~~% 2~~ == ~~1 and s >= 3~~ then		-- triple arrows may be needed
	~~result = result .. string.format("{{#ifexist: %s~~-~~extended\|* [[%s]] – "~~, ~~basic, basic.."~~-~~extended~~-~~szg")~~		result = result .. "triple"
	.. "~~an alternate version of this template that includes~~ "		end

	~~if s == 3 then~~		result = result .. " arrows.\|}}"
	~~-- Sharp-3 EDOs normally only need single arrows, but note that~~
	~~-- sometimes double arrows may be needed~~
	~~result = result .. "double"~~
	~~elseif s == 5 then~~
	~~-- Sharp-5 EDOs normally need double arrows, and note that sometimes~~
	~~-- triple arrows may be needed~~
	~~result = result .. "triple"~~
	~~end~~

	result = result .. " arrows.\|}}"
	~~end~~
	end		end
	end		end

Dave Keenan: Enable a See Also section with alternatives in the case of sharpness = 0.

2026-05-03T02:13:44Z

Enable a See Also section with alternatives in the case of sharpness = 0.

← Older revision		Revision as of 02:13, 3 May 2026
Line 96:		Line 96:

	-- Display a "see also" section for sharpness-2 and above		-- Display a "see also" section for sharpness-2 and above
	if s >= 2 or s <= -2 then		if s >= 2 or s <= -2 or s == 0 then
	local basic = "Template:Sharpness-" .. typ .. value		local basic = "Template:Sharpness-" .. typ .. value
	local basic_suf = basic .. "-" .. suffix		local basic_suf = basic .. "-" .. suffix

Dave Keenan at 23:06, 1 May 2026

2026-05-01T23:06:59Z

← Older revision		Revision as of 23:06, 1 May 2026
Line 112:		Line 112:
	-- If the template shows integrated (Gould-like) arrows		-- If the template shows integrated (Gould-like) arrows
	result = result .. string.format("{{#ifexist: %sa\|* [[%s]] – ", basic, basic.."a-szg")		result = result .. string.format("{{#ifexist: %sa\|* [[%s]] – ", basic, basic.."a-szg")
	.. "an alternate version of this template that shows separate ~~arrows~~.\n\|}}"		.. "an alternate version of this template that shows separate up and down chevrons.\n\|}}"

	if string.lower(suffix) ~= "" then		if string.lower(suffix) ~= "" then
Line 121:		Line 121:
	-- Otherwise, add an additional note for possible extended versions, if they exist		-- Otherwise, add an additional note for possible extended versions, if they exist
	if s % 2 == 1 and s >= 3 then		if s % 2 == 1 and s >= 3 then
	result = result .. string.format("{{#ifexist: %s-extended\|* [[%s~~-extended~~]] – ", basic, basic.."-szg")		result = result .. string.format("{{#ifexist: %s-extended\|* [[%s]] – ", basic, basic.."-extended-szg")
	.. "an alternate version of this template that includes "		.. "an alternate version of this template that includes "

Dave Keenan at 22:15, 1 May 2026

2026-05-01T22:15:24Z

← Older revision		Revision as of 22:15, 1 May 2026
Line 111:		Line 111:
	else		else
	-- If the template shows integrated (Gould-like) arrows		-- If the template shows integrated (Gould-like) arrows
	result = result .. string.format("{{#ifexist: %sa\|* [[%sa]] – ", basic, basic.."-szg")		result = result .. string.format("{{#ifexist: %sa\|* [[%s]] – ", basic, basic.."a-szg")
	.. "an alternate version of this template that shows separate arrows.\n\|}}"		.. "an alternate version of this template that shows separate arrows.\n\|}}"

Dave Keenan at 22:04, 1 May 2026

2026-05-01T22:04:48Z

Dave Keenan at 21:22, 1 May 2026

2026-05-01T21:22:29Z

← Older revision		Revision as of 21:22, 1 May 2026
Line 4:		Line 4:

	function p.main(frame)		function p.main(frame)
	local in_str = frame.args["input"]		local in_str = string.sub(frame.args["input"],1,-5) -- trim off "-szg"
	local note = frame.args["note"] or ""		local note = frame.args["note"] or ""
	local aux_note = frame.args["auxnote"] or ""		local aux_note = frame.args["auxnote"] or ""
Line 69:		Line 69:
	elseif extension == "a" or extension == "A" then		elseif extension == "a" or extension == "A" then
	-- Extension for modern-style ups and downs		-- Extension for modern-style ups and downs
	result = result .. "is based on [[ups and downs notation]] using separate ~~arrows~~."		result = result .. "is based on [[ups and downs notation]] using separate up and down chevrons."
	end		end
	end		end

Dave Keenan: Create szg (Stein-Zimmermann-Gould) version of Sharpness documentation.

2026-05-01T05:31:13Z

Create szg (Stein-Zimmermann-Gould) version of Sharpness documentation.

New page

local p = {}

local yesno = require("Module:Yesno")

function p.main(frame)
local in_str = frame.args["input"]
local note = frame.args["note"] or ""
local aux_note = frame.args["auxnote"] or ""
local notation = frame.args["notation"] or ""
local debugg = yesno(frame.args["debug"])

-- 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 = string.lower(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 result = "This template is used "

if s == 0 then
-- Sharp-0 EDOs (lower 5 multiples of 7) are redundant, take care of that right away
result = result
.. "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
-- Otherwise
result = result
.. "for [[edo]]s where a sharp "
.. ((s < 0) and "lowers" or "raises")
.. " by "
.. math.abs(s)
.. " step"

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

result = result .. "."

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

if math.abs(s) == 1 then
result = result .. "is identical to standard notation."
else
if extension == "" then
if math.abs(s) == 2 then
-- If a sharp raises by two steps
result = result
.. "comprises sharps, flats, and Stein–Zimmerman [[24edo #Notation|quartertone]] accidentals."
else
-- Otherwise (if a sharp raises by three or more steps)
result = result
.. "is based on [[ups and downs notation]] and comprises sharps, flats, "
.. (s % 2 == 0 and "naturals, and Stein–Zimmerman [[24edo #Notation|quartertone]] accidentals " or "and naturals ")
.. "with arrows from [https://w3c-cg.github.io/smufl/latest/tables/gould-arrow-quartertone-accidentals-24-edo.html Gould notation]."
end
elseif extension == "a" or extension == "A" then
-- Extension for modern-style ups and downs
result = result .. "is based on [[ups and downs notation]] using separate arrows."
end
end
else
result = result .. string.format(" It is based on %s.", notation)
end

-- display custom notes
if note or aux_note then
result = result .. " " .. note ..(aux_note ~= "" and "\n\n" .. aux_note or "")
end

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

result = result
.. "\n\n<h3>Parameters</h3>\n"
.. string.format("Passing in <code>%d</code> as a single unnamed parameter will change "
.. "'''Step offset''' to '''Semitones''' in the case of [[%dedo]]", n_edo, n_edo)
if s >= 2 then
result = result .. string.format(", since %dedo is a superset of [[12edo]]", n_edo)
end
result = result .. "."
end

-- Display a "see also" section for sharpness-2 and above
if s >= 2 or s <= -2 then
local basic = "Template:Sharpness-" .. typ .. value
local basic_suf = basic .. "-" .. suffix
result = result .. "\n\n<h3>See also</h3>\n"
.. "* [[Alternative symbols for ups and downs notation]]\n"

if (extension == "a" or extension == "A") then
-- If the template shows separate arrows
result = result
.. string.format("* [[{{#ifexist: %s|%s|%s}}]] – ", basic_suf, basic_suf, basic)
.. (s == 2
and "uses Stein–Zimmerman quarter tone accidentals."
or "the classic version of this template that shows arrows attached to standard accidentals.")
else
-- If the template shows integrated (Gould-like) arrows
result = result .. string.format("{{#ifexist: %sa|* [[%sa]] – ", basic, basic)
.. "an alternate version of this template that shows separate arrows.\n|}}"

if string.lower(suffix) ~= "" then
-- If we are on a different version of a template (e.g. "extended" ones that show more arrows than the minimum)
result = result .. string.format("{{#ifexist: %s|* [[%s]] – ", basic, basic)
.. "the basic version of this template.|}}"
else
-- Otherwise, add an additional note for possible extended versions, if they exist
if s % 2 == 1 and s >= 3 then
result = result .. string.format("{{#ifexist: %s-extended|* [[%s-extended]] – ", basic, basic)
.. "an alternate version of this template that includes "

if s == 3 then
-- Sharp-3 EDOs normally only need single arrows, but note that
-- sometimes double arrows may be needed
result = result .. "double"
elseif s == 5 then
-- Sharp-5 EDOs normally need double arrows, and note that sometimes
-- triple arrows may be needed
result = result .. "triple"
end

result = result .. " arrows.|}}"
end
end
end
end
end

-- Debugger option
if debugg == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end

return frame:preprocess(result)
end

return p

← Older revision		Revision as of 22:04, 1 May 2026
Line 59:		Line 59:
	-- If a sharp raises by two steps		-- If a sharp raises by two steps
	result = result		result = result
	.. "comprises sharps, flats, and Stein–~~Zimmerman~~ [[24edo #Notation\|quartertone]] accidentals."		.. "comprises sharps, flats, and Stein–Zimmermann [[24edo #Notation\|quartertone]] accidentals."
	else		else
	-- Otherwise (if a sharp raises by three or more steps)		-- Otherwise (if a sharp raises by three or more steps)
	result = result		result = result
	.. "is based on [[ups and downs notation]] and comprises sharps, flats, "		.. "is based on [[ups and downs notation]] and comprises sharps, flats, "
	.. (s % 2 == 0 and "naturals, and Stein–~~Zimmerman~~ [[24edo #Notation\|quartertone]] accidentals " or "and naturals ")		.. (s % 2 == 0 and "naturals, and Stein–Zimmermann [[24edo #Notation\|quartertone]] accidentals " or "and naturals ")
	.. "with arrows from [https://w3c-cg.github.io/smufl/latest/tables/gould-arrow-quartertone-accidentals-24-edo.html Gould notation]."		.. "with arrows from [https://w3c-cg.github.io/smufl/latest/tables/gould-arrow-quartertone-accidentals-24-edo.html Gould notation]."
	end		end
Line 103:		Line 103:

	if (extension == "a" or extension == "A") then		if (extension == "a" or extension == "A") then
	-- If the template shows separate ~~arrows~~		-- If the template shows separate up and down chevrons
	result = result		result = result
	.. string.format("* [[{{#ifexist: %s\|%s\|%s}}]] – ", basic_suf, basic_suf, basic)		.. string.format("* [[{{#ifexist: %s\|%s\|%s}}]] – ", basic_suf, basic_suf.."-szg", basic.."-szg")
	.. (s == 2		.. (s == 2
	and "uses Stein–~~Zimmerman~~ quarter tone accidentals."		and "uses Stein–Zimmermann quarter tone accidentals."
	or "the classic version of this template that shows arrows attached to standard accidentals.")		or "the classic version of this template that shows arrows attached to standard accidentals.")
	else		else
	-- If the template shows integrated (Gould-like) arrows		-- If the template shows integrated (Gould-like) arrows
	result = result .. string.format("{{#ifexist: %sa\|* [[%sa]] – ", basic, basic)		result = result .. string.format("{{#ifexist: %sa\|* [[%sa]] – ", basic, basic.."-szg")
	.. "an alternate version of this template that shows separate arrows.\n\|}}"		.. "an alternate version of this template that shows separate arrows.\n\|}}"

	if string.lower(suffix) ~= "" then		if string.lower(suffix) ~= "" then
	-- If we are on a different version of a template (e.g. "extended" ones that show more arrows than the minimum)		-- If we are on a different version of a template (e.g. "extended" ones that show more arrows than the minimum)
	result = result .. string.format("{{#ifexist: %s\|* [[%s]] – ", basic, basic)		result = result .. string.format("{{#ifexist: %s\|* [[%s]] – ", basic, basic.."-szg")
	.. "the basic version of this template.\|}}"		.. "the basic version of this template.\|}}"
	else		else
	-- Otherwise, add an additional note for possible extended versions, if they exist		-- Otherwise, add an additional note for possible extended versions, if they exist
	if s % 2 == 1 and s >= 3 then		if s % 2 == 1 and s >= 3 then
	result = result .. string.format("{{#ifexist: %s-extended\|* [[%s-extended]] – ", basic, basic)		result = result .. string.format("{{#ifexist: %s-extended\|* [[%s-extended]] – ", basic, basic.."-szg")
	.. "an alternate version of this template that includes "		.. "an alternate version of this template that includes "