Xenharmonic Wiki

Module:Sharpness documentation: Difference between revisions

← Older edit
ArrowHead294 (talk | contribs)
15,213 edits
mNo edit summary
Dave Keenan (talk | contribs)
autopatrolled, emailconfirmed
2,270 edits
Added line break <br> before "This symbol set ...".
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
local yesno = require("Module:yesno")
local p = {}
local module = {}


function module.main(frame)
local yesno = require("Module:Yesno")
 
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 ""
local aux_note = frame.args["auxnote"] or ""
local notation = frame.args["notation"] or ""
local notation = frame.args["notation"] or ""
local debugg = yesno(frame.args["debug"])


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


-- signed sharpness
-- Signed sharpness
local s = tonumber(value)
local s = tonumber(value)
if typ == "flat" then
if typ == "flat" then
Line 22: Line 25:
end
end


local out_str = "This template is used "
local result = "This template is used "


if s == 0 then
if s == 0 then
out_str = out_str
-- 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]]. "
.. "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), "
.. "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, "
.. "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."
.. "the traditional sharps and flats are redundant and cannot raise or lower the pitch."
else
else
out_str = out_str
-- Otherwise
result = result
.. "for [[edo]]s where a sharp "
.. "for [[edo]]s where a sharp "
.. ((s < 0) and "lowers" or "raises")
.. ((s < 0) and "lowers" or "raises")
Line 39: Line 44:


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


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


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


if math.abs(s) == 1 then
if math.abs(s) == 1 then
out_str = out_str .. "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
out_str = out_str
-- If a sharp raises by two steps
.. "comprises sharps, flats, and Stein&ndash;Zimmerman [[24edo #Notation|quartertone]] accidentals."
result = result
.. "comprises sharps, flats, and Stein&ndash;Zimmermann [[24edo #Notation|quartertone]] accidentals."
else
if s == 0 then
result = result
.. "is based on [[ups and downs notation]] and comprises naturals "
.. "with arrows from [[Helmholtz&ndash;Ellis notation]]."
else
else
out_str = out_str
-- Otherwise (if a sharp raises by three or more steps)
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&ndash;Zimmerman [[24edo #Notation|quartertone]] accidentals " or "and naturals ")
.. (s % 2 == 0 and "naturals, and Stein&ndash;Zimmermann [[24edo #Notation|quartertone]] accidentals " or "and naturals ")
.. "with arrows from [[Helmholtz&ndash;Ellis notation]]."
.. "with arrows from [[Helmholtz&ndash;Ellis notation]]."
end
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
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
out_str = out_str .. " It is based on " .. notation .. "."
end
end
else
result = result .. string.format(" It is based on %s.", notation)
end


-- display custom note
-- display custom notes
if note then
if note or aux_note then
out_str = out_str .. " " .. note
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
-- 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 -- edo number for supersets of 12edo
local n_edo = s * 12


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


-- display the "see also" section for sharpness-2 and above
-- Display a "see also" section for sharpness-2 and above, and sharpness-0
if 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
out_str = out_str .. "\n\n<h3>See also</h3>\n"
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 up and down chevrons
result = result
.. string.format("* [[{{#ifexist: %s|%s|%s}}]] &ndash; ", basic_suf, basic_suf, basic)
.. (s == 2
and "uses Stein&ndash;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]] &ndash; ", 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
out_str = out_str
-- If we are on a different version of a template (e.g. "extended" ones that show more arrows than the minimum)
.. "* [[Alternative symbols for ups and downs notation]]"
result = result .. string.format("{{#ifexist: %s|* [[%s]] &ndash; ", basic, basic)
.. "\n* [[{{#ifexist: " .. basic_suf .. "|" .. basic_suf .. "|" .. basic .. "}}]] &ndash; "
.. "the basic version of this template.|}}"
.. (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
else
out_str = out_str
-- Otherwise, add an additional note for possible extended versions, if they exist
.. "\n{{#ifexist: " .. basic .. "a|* [[" .. basic .. "a]] &ndash; "
if s % 2 == 1 and s >= 3 then
.. "an alternate version of this template that shows separate arrows.|}}"
result = result .. string.format("{{#ifexist: %s-extended|* [[%s-extended]] &ndash; ", basic, basic)
.. "\n{{#ifexist: " .. basic .. "-extended|* [[" .. basic .. "-extended]] &ndash; "
.. "an alternate version of this template that includes "
.. "an alternate version of this template that includes "
if s == 3 then
if s == 3 then
out_str = out_str .. "double"
-- Sharp-3 EDOs normally only need single arrows, but note that
elseif s == 5 then
-- sometimes double arrows may be needed
out_str = out_str .. "triple"
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
out_str = out_str .. " arrows.|}}"
end
end
end
end
end
end


local is_debug = yesno(frame.args["debug"])
-- Debugger option
return frame:preprocess(is_debug == true and "<pre>" .. out_str .. "</pre>" or out_str)
if debugg == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end
return frame:preprocess(result)
end
end


return module
return p
Retrieved from "https://en.xen.wiki/w/Module:Sharpness_documentation"