Template:MOS modes/doc

Revision as of 00:12, 25 May 2023 by Ganaram inukshuk (talk | contribs) (Corrected an error in documentation (incorrect sample code))

Arguments

The template currently supports the following arguments:

Argument Required? Description
Tuning 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.
ModeNames 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|Tuning=5L 3s}}

Lua error in Module:MOS at line 46: attempt to index local 'equave' (a nil value).

{{MOS modes|Tuning=4L 5s <3/1>}}

Lua error in Module:MOS at line 46: attempt to index local 'equave' (a nil value).

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|Tuning=5L 3s|ModeNames=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}

Lua error in Module:MOS at line 46: attempt to index local 'equave' (a nil value).

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

Lua error in Module:MOS at line 46: attempt to index local 'equave' (a nil value).

To-do

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