Template:MOS modes/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
Corrected an error in documentation (incorrect sample code)
Ganaram inukshuk (talk | contribs)
No edit summary
Line 7: Line 7:
!Description
!Description
|-
|-
|Tuning
|Scale Signature
|Yes (optional on mos pages)
|Yes (optional on mos pages)
|The mos pattern in the form "xL ys" (for 2/1-equivalent mosses), "xL ys<nowiki><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, then the page's title will be used instead.</nowiki>
|The mos pattern in the form "xL ys" (for 2/1-equivalent mosses), "xL ys<nowiki><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, then the page's title will be used instead.</nowiki>
|-
|-
|ModeNames
|Mode Names
|No (optional)
|No (optional)
|A list of names delimited using semicolons. The number of names must match the number of modes or names will not be added. If the tuning is "5L 2s", then mode names (Lydian, Ionian, etc) are automatically added.
|A list of names delimited using semicolons. The number of names must match the number of modes or names will not be added. If the tuning is "5L 2s", then mode names (Lydian, Ionian, etc) are automatically added.
Line 21: Line 21:
=== Usage with a different tuning ===
=== Usage with a different tuning ===
To specify a tuning, include it as shown below. Non-octave tunings are supported.
To specify a tuning, include it as shown below. Non-octave tunings are supported.
<pre>{{MOS modes|Tuning=5L 3s}}</pre>
<pre>{{MOS modes|Scale Signature=5L 3s}}</pre>
{{MOS modes|Tuning=5L 3s}}
{{MOS modes|Scale Signature=5L 3s}}
<pre>{{MOS modes|Tuning=4L 5s <3/1>}}</pre>
<pre>{{MOS modes|Scale Signature=4L 5s <3/1>}}</pre>
{{MOS modes|Tuning=4L 5s <3/1>}}
{{MOS modes|Scale Signature=4L 5s <3/1>}}
=== Usage with mode names ===
=== Usage with 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.
Names for each mode are separated by semicolons, as shown below. A mode may have multiple names or a name consisting of multiple words.


<pre>{{MOS modes|Tuning=5L 3s|ModeNames=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}</pre>
<pre>{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}</pre>
{{MOS modes|Tuning=5L 3s|ModeNames=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}
{{MOS modes|Scale Signature=5L 3s|ModeNames=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}


<pre>{{MOS modes|Tuning=4L 5s <3/1>|ModeNames=Walker I; Walker II; Moll I (Delta); Lambda; Moll II (Pierce); Harmonic; Dur I; Walker A; Walker B}}</pre>
<pre>{{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}}</pre>
{{MOS modes|Tuning=4L 5s <3/1>|ModeNames=Walker I; Walker II; Moll I (Delta); Lambda; Moll II (Pierce); Harmonic; Dur I; Walker A; Walker B}}
{{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}}
=== To-do ===
=== To-do ===
* Some mos pages have more than one set of names. This currently is not supported.
* Some mos pages have more than one set of names. This currently is not supported.

Revision as of 00:57, 25 May 2023

Arguments

The template currently supports the following arguments:

Argument Required? Description
Scale Signature Yes (optional on mos pages) The mos pattern 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, then the page's title will be used instead.
Mode Names No (optional) A list of names delimited using semicolons. The number of names must match the number of modes or names will not be added. If the tuning is "5L 2s", then mode names (Lydian, Ionian, etc) are automatically added.

Typical use

For most mos pages, simply include the code below. If included on any other page, a tuning must be specified.

{{MOS modes}}

Usage with a different tuning

To specify a tuning, include it as shown below. Non-octave tunings are supported.

{{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

Usage with 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.

{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}
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

To-do

  • Some mos pages have more than one set of names. This currently is not supported.