Template:MOS modes/doc

From Xenharmonic Wiki
Revision as of 20:59, 25 May 2023 by Ganaram inukshuk (talk | contribs) (Reworded documentation (eg, "scale signature" instead of "tuning"))
Jump to navigation Jump to search

Documentation

Arguments

The template currently supports the following parameters:

Parameters Required? Description
Scale Signature Yes (optional on mos pages) The mos's scale signature in the form "xL ys" (for 2/1-equivalent mosses), "xL ys<p/q>" or "xL ys⟨p/q⟩" (for non-2/1 mosses), or "xL ys (p/q-equivalent)" (if the tuning is specified in the page's title). If left blank and used on a mos page, then the page's title will be used.
Mode Names No (optional) A list of names delimited using semicolons. If provided, then a column for modes names are added. If the scale signature is "5L 2s", then mode names (Lydian, Ionian, etc) are automatically added.

Usage

For mos pages, which is the typical use, simply include the code below.

{{MOS modes}}

Using a different scale signature

To specify a scale signature different from the title of the page, include it as shown below. Non-octave mosses are supported, as are multi-period mosses.

{{MOS modes|Scale Signature=5L 3s}}
Modes of 5L 3s
UDP Cyclic
order
Step
pattern
7|0 1 LLsLLsLs
6|1 4 LLsLsLLs
5|2 7 LsLLsLLs
4|3 2 LsLLsLsL
3|4 5 LsLsLLsL
2|5 8 sLLsLLsL
1|6 3 sLLsLsLL
0|7 6 sLsLLsLL
{{MOS modes|Scale Signature=4L 5s <3/1>}}
Modes of 4L 5s⟨3/1⟩
UDP Cyclic
order
Step
pattern
8|0 1 LsLsLsLss
7|1 3 LsLsLssLs
6|2 5 LsLssLsLs
5|3 7 LssLsLsLs
4|4 9 sLsLsLsLs
3|5 2 sLsLsLssL
2|6 4 sLsLssLsL
1|7 6 sLssLsLsL
0|8 8 ssLsLsLsL
{{MOS modes|Scale Signature=4L 6s}}
Modes of 4L 6s
UDP Cyclic
order
Step
pattern
8|0(2) 1 LsLssLsLss
6|2(2) 3 LssLsLssLs
4|4(2) 5 sLsLssLsLs
2|6(2) 2 sLssLsLssL
0|8(2) 4 ssLsLssLsL

Adding mode names

Names for each mode are separated by semicolons, as shown below. A mode may have multiple names or a name consisting of multiple words. The number of mode names must match the number of modes the mos has, or the column won't be added.

{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian}}
Modes of 5L 3s
UDP Cyclic
order
Step
pattern
7|0 1 LLsLLsLs
6|1 4 LLsLsLLs
5|2 7 LsLLsLLs
4|3 2 LsLLsLsL
3|4 5 LsLsLLsL
2|5 8 sLLsLLsL
1|6 3 sLLsLsLL
0|7 6 sLsLLsLL
{{MOS modes|Scale Signature=4L 5s <3/1>|Mode Names=Walker I; Walker II; Moll I (Delta); Lambda; Moll II (Pierce); Harmonic; Dur I; Walker A; Walker B}}
Modes of 4L 5s⟨3/1⟩
UDP Cyclic
order
Step
pattern
8|0 1 LsLsLsLss
7|1 3 LsLsLssLs
6|2 5 LsLssLsLs
5|3 7 LssLsLsLs
4|4 9 sLsLsLsLs
3|5 2 sLsLsLssL
2|6 4 sLsLssLsL
1|7 6 sLssLsLsL
0|8 8 ssLsLsLsL

Limitations

Some mos pages have an additional column that displays additional names or additional info. Additional columns are currently not supported.