Module:Sharpness documentation - Revision history

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

2026-05-03T04:40:48Z

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

← Older revision		Revision as of 04:40, 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:39:02Z

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

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

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

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

	if math.abs(s) == 1 then		if math.abs(s) == 1 then
	result = result .. "is identical to standard notation."		result = result .. "is identical to standard notation."
	else		else
	if extension == "" then		if extension == "" then
	if math.abs(s) == 2 then		if math.abs(s) == 2 then
	-- If a sharp raises by two steps		-- If a sharp raises by two steps
			result = result
			.. "comprises sharps, flats, and Stein–Zimmermann [[24edo #Notation\|quartertone]] accidentals."
			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 [[Helmholtz–Ellis 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 [[Helmholtz–Ellis notation]]."		.. "with arrows from [[Helmholtz–Ellis 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

	-- Display a "see also" section for sharpness-2 and above, and sharpness-0		-- 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

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

2026-05-03T03:55:15Z

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

← Older revision		Revision as of 03:55, 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, basic)
			.. (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 (HEJI-like) arrows
			result = result .. string.format("{{#ifexist: %sa\|* [[%sa]] – ", basic, basic)
			.. "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)
	.. string.format("* [[{{#ifexist: %s\|%s~~\|%s}}~~]] – ", ~~basic_suf, basic_suf~~, basic)		.. "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 (HEJI-like) arrows~~		-- Otherwise, add an additional note for possible extended versions, if they exist
	result = result .. string.format("{{#ifexist: %sa\|* [[%sa]] – ", basic, basic)		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-extended]] – ", basic, basic)
			.. "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)~~		-- 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-extended]] –~~ "~~, basic, basic)~~		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:15:06Z

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

← Older revision		Revision as of 02:15, 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: Correct spelling of "Zimmermann" and refer to separate up and down symbols as "up and down chevrons" rather than "arrows".

2026-05-01T22:41:27Z

Correct spelling of "Zimmermann" and refer to separate up and down symbols as "up and down chevrons" rather than "arrows".

ArrowHead294 at 13:20, 1 June 2025

2025-06-01T13:20:17Z

← Older revision		Revision as of 13:20, 1 June 2025
Line 141:		Line 141:
	end		end

	~~return frame:preprocess(~~debugg == true ~~and~~ "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>" or result)		-- Debugger option
			if debugg == true then
			result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
			end

			return frame:preprocess(result)
	end		end

	return p		return p

ArrowHead294 at 18:20, 19 May 2025

2025-05-19T18:20:05Z

← Older revision		Revision as of 18:20, 19 May 2025
Line 1:		Line 1:
			local p = {}

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

	function ~~module~~.main(frame)		function p.main(frame)
	local in_str = frame.args["input"]		local in_str = frame.args["input"]
	local note = frame.args["note"] or ""		local note = frame.args["note"] or ""
Line 143:		Line 144:
	end		end

	return ~~module~~		return p

ArrowHead294 at 13:59, 2 May 2025

2025-05-02T13:59:17Z

← Older revision		Revision as of 13:59, 2 May 2025
Line 7:		Line 7:
	local aux_note = frame.args["auxnote"] or ""		local aux_note = frame.args["auxnote"] or ""
	local notation = frame.args["notation"] or ""		local notation = frame.args["notation"] or ""
	local ~~is_debug~~ = yesno(frame.args["debug"])		local debugg = yesno(frame.args["debug"])

	-- typ: "sharp" or "flat"		-- typ: "sharp" or "flat"
Line 140:		Line 140:
	end		end

	return frame:preprocess(~~is_debug~~ == true and "<~~pre~~>" .. result .. "</~~pre~~>" or result)		return frame:preprocess(debugg == true and "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>" or result)
	end		end

	return module		return module

ArrowHead294 at 19:56, 28 April 2025

2025-04-28T19:56:10Z

← Older revision		Revision as of 19:56, 28 April 2025
Line 115:		Line 115:
	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: %sa\|* [[%s]] – ", basic, basic)		result = result .. string.format("{{#ifexist: %s\|* [[%s]] – ", basic, basic)
	.. "the basic version of this template.\|}}"		.. "the basic version of this template.\|}}"
	else		else

ArrowHead294 at 19:54, 28 April 2025

2025-04-28T19:54:19Z

← Older revision		Revision as of 19:54, 28 April 2025
Line 115:		Line 115:
	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: %sa\|* [[%sa]] – ", basic, basic)		result = result .. string.format("{{#ifexist: %sa\|* [[%s]] – ", basic, basic)
	.. "the basic version of this template.\|}}"		.. "the basic version of this template.\|}}"
	else		else

← Older revision		Revision as of 22:41, 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 [[Helmholtz–Ellis notation]]."		.. "with arrows from [[Helmholtz–Ellis notation]]."
	end		end
	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
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, basic)
	.. (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 (HEJI-like) arrows		-- If the template shows integrated (HEJI-like) arrows
	result = result .. string.format("{{#ifexist: %sa\|* [[%sa]] – ", basic, basic)		result = result .. string.format("{{#ifexist: %sa\|* [[%sa]] – ", basic, basic)
	.. "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