Template:MOS gamut/doc

From Xenharmonic Wiki
Revision as of 06:17, 9 June 2023 by Ganaram inukshuk (talk | contribs) (Limitations: Updated documentation to reflect changes to module)
Jump to navigation Jump to search

Parameters

Parameters Required? Description
Scale Signature Yes (optional on mos pages) The mos's scale signature in the form "xL ys", or for non-octave mosses, "xL ys<p/q>", "xL ys⟨p/q⟩", or "xL ys (p/q-equivalent)". If left blank and used on a mos page, then the page's title will be used.
Step Ratio No (optional) The step ratio of the mos, denoted as a fraction p/q. If not simplified, then the ratio is automatically simplified. If left blank, then the step ratio 2/1 is used by default.
Bright Gens Up No (optional) The number of bright generators going up needed to produce the mode for which notation is applied. If a mode is denoted using its UDP (up|dp), this is the value up (u times p). If left blank, then the brightest mode is used by default.
Note Symbols No (optional) A string of note symbols, such as CDEFGAB (for standard notation) and JKLMNOP (for diamond-MOS notation). This should be entered as a string, where one character is one note name. If left blank, then standard notation (for 5L 2s) or diamond-MOS notation (for anything else) is used by default.
Sharp Symbol No (optional) The symbol used to denote raising by a chroma, usually a sharp (#) or diamond-MOS's am/amp symbol (&). If left blank, then either # or & is used by default.
Flat Symbol No (optional) The symbol used to denote lowering by a chroma, usually a flat (b) or diamond-MOS's at symbol (@). If left blank, then either b or @ is used by default.

Usage

The typical use of this template is for describing a mos's gamut, the set of named notes, with accidentals.

{{MOS gamut}}

A scale signature different from the page's title can be specified as shown below.

{{MOS gamut|Scale Signature = 4L 3s}}

J, J&/K@, K, L, L&/M@, M, N, N&/O@, O, P, P&/J@, J

This produces a gamut with a step ratio of 2:1 for the brightest mode. Since it's common to use different step ratios and to apply notation to a different mode, an example of overriding the mode and step ratio is shown below.

{{MOS gamut|Scale Signature = 4L 3s|Bright Gens Up = 3|Step Ratio = 3/1}}

J, K@, J&, K, L, M@, L&, M, N, O@, N&, O, P, J@, P&, J

{{MOS gamut|Scale Signature = 4L 3s|Bright Gens Up = 3|Step Ratio = 3/2}}

J, J&, K@, K, K&/L@, L, L&, M@, M, M&/N@, N, N&, O@, O, O&/P@, P, P&, J@, J

Using different notation

An example of this template's usage with different notation can be shown using Armodue notation (used for 7L 2s) and notation used for Lambda (3/1-equivalent 4L 5s).

{{MOS gamut|Scale Signature = 7L 2s|Bright Gens Up = 7|Note Symbols = 123456789|Sharp Symbol = #|Flat Symbol = b}}

J, J&/K@, K, K&/L@, L, M, M&/N@, N, N&/O@, O, O&/P@, P, Q, Q&/R@, R, R&/J@, J

{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|Bright Gens Up = 5|Note Symbols = CDEFGHJAB|Sharp Symbol = #|Flat Symbol = b}}

J, K, K&/L@, L, M, M&/N@, N, O, O&/P@, P, Q, Q&/R@, R, J

Limitations

Equivalent pitch classes, such as enharmonic equivalents, are currently limited to pitches that fall at the exact midpoint of two other pitches, such as C# and Db being equivalent in standard notation, or C and B# being equivalent. This is to ensure note names have as few accidentals as possible.

Other means of notation, such as using ups and downs or half-accidentals, are currently not supported.

If a step ratio is entered without being simplified, the edo (or edequave) displayed will reflect that by being a larger division of the equave. An example of this is 5L 2s in 24edo, whose step ratio is 4/2. However, notation for the additional notes, which may be notated using ups and downs, are currently not added for the sake of keeping the output simple.

{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 4/2}}

J, J&/K@, K, L, L&/M@, M, M&/N@, N, N&/O@, O, P, P&/J@, J

This template can accept equalized step ratios, but collapsed step ratios result in an improperly formatted table. This is an aesthetic issue.

{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/0}}

J, K/L, M, N, O/P, J

The design of the template itself is not finalized and is open to suggestions.