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 ...".
 
(39 intermediate revisions by 4 users not shown)
Line 1: Line 1:
local yesno = require("Module:yesno")
local p = {}
local p = {}
local yesno = require("Module:Yesno")


function p.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 ""
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"])
-- type: "sharp" or "flat"
 
-- value: absolute value of sharpness (the "n" as in sharp-n and flat-n)
-- typ: "sharp" or "flat"
-- extension: used for identifying alternative symbol set
-- value: Absolute value of sharpness (the "n" as in sharp-n and flat-n)
local type, value, extension = in_str:match("%-(%a*)(%d+)(%a*)")
-- extension: Used for identifying alternative symbol set
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 type == "flat" then
if typ == "flat" then
s = -s
s = -s
end
end
 
local sc = s * 12 -- edo number for supersets of 12edo
if extension == nil then
if extension == nil then
extension = ""
extension = ""
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"})[1] .. " by " .. math.abs(s) .. " step"
.. ((s < 0) and "lowers" or "raises")
.. " by "
.. math.abs(s)
.. " step"
 
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
 
out_str = out_str .. " This symbol set "
if notation == "" then
result = result .. "<br>This symbol set "
if math.abs(s) == 1 then
 
out_str = out_str .. "is identical to standard notation."
if math.abs(s) == 1 then
else
result = result .. "is identical to standard notation."
if extension == "" then
else
if math.abs(s) == 2 then
if extension == "" then
out_str = out_str .. "comprises sharps, flats, and Stein&ndash;Zimmerman [[24edo #Notation|quartertone]] accidentals."
if math.abs(s) == 2 then
-- If a sharp raises by two steps
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 .. "[[ups and downs notation]] and comprises sharps, flats, "
-- Otherwise (if a sharp raises by three or more steps)
.. (s % 2 == 0
result = result
and "naturals, and Stein&ndash;Zimmerman [[24edo #Notation|quartertone]] accidentals "
.. "is based on [[ups and downs notation]] and comprises sharps, flats, "
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
-- display custom note
result = result .. string.format(" It is based on %s.", notation)
if note then
end
out_str = out_str .. " " .. note
 
-- 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
end
result = result .. "."
end
-- Display a "see also" section for sharpness-2 and above, and sharpness-0
if s >= 2 or s <= -2 or s == 0 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"
-- display the note about supersets of 12edo for sharpness-1 and above
if (extension == "a" or extension == "A") then
if s >= 1 then
-- If the template shows separate up and down chevrons
out_str = out_str
result = result
.. "\n\n<h3>Parameters</h3>\n"
.. string.format("* [[{{#ifexist: %s|%s|%s}}]] &ndash; ", basic_suf, basic_suf, basic)
.. "Passing <code>{{pipe}}"
.. (s == 2
.. sc
and "uses Stein&ndash;Zimmermann quarter tone accidentals."
.. "</code> will change '''Step offset''' to '''Semitones''' in the case of [["
or "the classic version of this template that shows arrows attached to standard accidentals.")
.. sc .. "edo]]"
else
.. ((s >= 2) and {", since " .. sc .. "edo is a superset of [[12edo]]."} or {"."})[1]
-- If the template shows integrated (HEJI-like) arrows
end
result = result .. string.format("{{#ifexist: %sa|* [[%sa]] &ndash; ", basic, basic)
.. "an alternate version of this template that shows separate up and down chevrons.\n|}}"
-- display the see also section for sharpness-3 and above
if s >= 3 or (s == 2 and (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)
.. "\n\n<h3>See also</h3>\n"
result = result .. string.format("{{#ifexist: %s|* [[%s]] &ndash; ", basic, basic)
.. "* [[Alternative symbols for ups and downs notation]]"
.. "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]] &ndash; ", 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
end
local debugg = yesno(frame.args["debug"])
return frame:preprocess(result)
return frame:preprocess(debugg == true and "<pre>" .. out_str .. "</pre>" or out_str)
end
end


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