Template:MOS modes/doc: Difference between revisions

Line 1:

=== Arguments ===

The template currently supports the following arguments:

{| class="wikitable"

|+

!Argument

!Required?

!Description

|-

|Tuning

|No (optional)

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

|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, the template will default to the modes of 5L 2s, including mode names. The number of names must match the number of modes or they won't be included.

<syntaxhighlight>{{#invoke:MOS_modes|modes_table}}</syntaxhighlight>

=== Usage with a different tuning ===

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

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

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

=== 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.

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

{{MOS modes|Tuning=5L 3s|ModeNames=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}

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

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

=== To-do ===

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

@@ Line 1: / Line 1: @@
+=== Arguments ===
 The template currently supports the following arguments:
+{| class="wikitable"
+|+
+!Argument
+!Required?
+!Description
+|-
+|Tuning
+|No (optional)
+|"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
+|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, the template will default to the modes of 5L 2s, including mode names. The number of names must match the number of modes or they won't be included.
+<syntaxhighlight>{{#invoke:MOS_modes|modes_table}}</syntaxhighlight>
+{{#invoke:MOS_modes|modes_table}}
+=== Usage with a different tuning ===
+To specify a tuning, include it as shown below. Non-octave tunings are supported.
+<syntaxhighlight>{{MOS modes|Tuning=5L 3s}}</syntaxhighlight>
+{{MOS modes|Tuning=5L 3s}}
+<syntaxhighlight>{{MOS modes|Tuning=4L 5s <3/1>}}</syntaxhighlight>
+{{MOS modes|Tuning=4L 5s <3/1>}}
+=== 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.
+<syntaxhighlight>{{MOS modes|Tuning=5L 3s|ModeNames=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}</syntaxhighlight>
+{{MOS modes|Tuning=5L 3s|ModeNames=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian, Sarn}}
+<syntaxhighlight>{{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}}</syntaxhighlight>
+{{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}}
+=== To-do ===
+* Some mos pages have more than one set of names. This currently is not supported.