Template:MOS modes/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
m Replaced "tuning" with "scale signature"
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
Reworded documentation (eg, "scale signature" instead of "tuning")
Line 1: Line 1:
== Documentation ==
=== Arguments ===
=== Arguments ===
The template currently supports the following arguments:
The template currently supports the following parameters:
{| class="wikitable"
{| class="wikitable"
|+
|+
!Argument
!Parameters
!Required?
!Required?
!Description
!Description
Line 13: Line 14:
|Mode Names
|Mode Names
|No (optional)
|No (optional)
|A list of names delimited using semicolons. If the tuning is "5L 2s", then mode names (Lydian, Ionian, etc) are automatically added.
|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.
|}
|}


=== Typical use ===
== Usage ==
For most mos pages, simply include the code below. If included on any other page, a tuning must be specified.
For mos pages, which is the typical use, simply include the code below.
<pre>{{MOS modes}}</pre>
<pre>{{MOS modes}}</pre>
=== Usage with a different scale signature ===
=== Using a different scale signature ===
To specify a scale signature, include it as shown below. Non-octave mosses are supported.
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.
<pre>{{MOS modes|Scale Signature=5L 3s}}</pre>
<pre>{{MOS modes|Scale Signature=5L 3s}}</pre>
{{MOS modes|Scale Signature=5L 3s}}
{{MOS modes|Scale Signature=5L 3s}}
<pre>{{MOS modes|Scale Signature=4L 5s <3/1>}}</pre>
<pre>{{MOS modes|Scale Signature=4L 5s <3/1>}}</pre>
{{MOS modes|Scale Signature=4L 5s <3/1>}}
{{MOS modes|Scale Signature=4L 5s <3/1>}}
=== Usage with mode names ===
<pre>{{MOS modes|Scale Signature=4L 6s}}</pre>
Names for each mode are separated by semicolons, as shown below. A mode may have multiple names or a name consisting of multiple words. Mode names should be ordered by decreasing modal brightness.
{{MOS modes|Scale Signature=4L 6s}}
 
=== 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.
<pre>{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian}}</pre>
<pre>{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian}}</pre>
{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian}}
{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian}}
<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>
<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|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}}
{{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 ===
== Limitations ==
* Some mos pages have more than one set of names. This currently is not supported.
Some mos pages have an additional column that displays additional names or additional info. Additional columns are currently not supported.

Revision as of 20:59, 25 May 2023

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.

Retrieved from "https://en.xen.wiki/index.php?title=Template:MOS_modes/doc&oldid=114650"