Template:MOS modes/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
ArrowHead294 (talk | contribs)
14,512 edits
mNo edit summary
ArrowHead294 (talk | contribs)
14,512 edits
m Delimiters have been changed to use dollar signs instead of semicolons.
Line 4: Line 4:
=== Parameters ===
=== Parameters ===
The template currently supports the following parameters:
The template currently supports the following parameters:
{| class="wikitable"
{| class="wikitable"
|-
|-
Line 38: Line 39:
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.
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}}
{{{{ROOTPAGENAME}}|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>}}
{{{{ROOTPAGENAME}}|Scale Signature=4L 5s <3/1>}}
<pre>{{MOS modes|Scale Signature=4L 6s}}</pre>
<pre>{{MOS modes|Scale Signature=4L 6s}}</pre>
{{MOS modes|Scale Signature=4L 6s}}
{{{{ROOTPAGENAME}}|Scale Signature=4L 6s}}


==== Collapsing the table ====
==== Collapsing the table ====
The table can be collapsed by default by passing a "1" for the Collapsed parameter. This is recommended for pages with too much information (such as MOS scales with a very large number of modes).
The table can be collapsed by default by passing a "1" for the Collapsed parameter. This is recommended for pages with too much information (such as MOS scales with a very large number of modes).
<pre>{{MOS modes|Scale Signature=4L 6s|Collapsed=1}}</pre>
<pre>{{MOS modes|Scale Signature=4L 6s|Collapsed=1}}</pre>
{{MOS modes|Scale Signature=4L 6s|Collapsed=1}}
{{{{ROOTPAGENAME}}|Scale Signature=4L 6s|Collapsed=1}}


==== Adding mode names ====
==== Adding mode names ====
Names for each mode are separated by semicolons, as shown below. A mode may have multiple names (such as with 5L 3s) or a name consisting of multiple words (such as with the mode names described by Elaine Walker for 4L 5s <3/1>). The number of mode names must match the number of modes the mos has, or the column won't be added.
Names for each mode are separated by semicolons, as shown below. A mode may have multiple names (such as with 5L 3s) or a name consisting of multiple words (such as with the mode names described by Elaine Walker for 4L 5s <3/1>). 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}}
{{{{ROOTPAGENAME}}|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}}
{{{{ROOTPAGENAME}}|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}}


==== Adding multiple columns ====
==== Adding multiple columns ====
Line 60: Line 61:
<pre>{{MOS modes|Scale Signature=6L 3s|Table Headers=Mode name$ Name origin|Table Entries=Zeldan$ Named after Zelda$ Linkan$ Named after Link$ Ganan, Ganondoran$ Named after Ganon/Ganondorf}}</pre>
<pre>{{MOS modes|Scale Signature=6L 3s|Table Headers=Mode name$ Name origin|Table Entries=Zeldan$ Named after Zelda$ Linkan$ Named after Link$ Ganan, Ganondoran$ Named after Ganon/Ganondorf}}</pre>
<pre>{{MOS modes|Scale Signature=6L 3s|Mode Names=Zeldan$ Linkan$ Ganan, Ganondoran|Table Headers=Name origin|Table Entries=Named after Zelda$ Named after Link$ Named after Ganon/Ganondorf}}</pre>
<pre>{{MOS modes|Scale Signature=6L 3s|Mode Names=Zeldan$ Linkan$ Ganan, Ganondoran|Table Headers=Name origin|Table Entries=Named after Zelda$ Named after Link$ Named after Ganon/Ganondorf}}</pre>
{{MOS modes|Scale Signature=6L 3s|Table Headers=Mode name$ Name origin|Table Entries=Zeldan$ Named after Zelda$ Linkan$ Named after Link$ Ganan, Ganondoran$ Named after Ganon/Ganondorf}}
{{{{ROOTPAGENAME}}|Scale Signature=6L 3s|Table Headers=Mode name$ Name origin|Table Entries=Zeldan$ Named after Zelda$ Linkan$ Named after Link$ Ganan, Ganondoran$ Named after Ganon/Ganondorf}}


=== Limitations ===
=== Limitations ===

Revision as of 17:05, 28 February 2025

This template uses Lua:

This template is used for mos pages to automatically generate and list that mos's modes, along with the modes' UDP. It can also be used to display mode names, with supplementary information intended for footnotes, pronunciation guides, or alternate names.

Parameters

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", or for non-octave mosses, "xL ys<p/q>", "xL ys⟨p/q⟩", or "xL ys (p/q-equivalent)". 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.
Table Headers No (optional) A list of column headers delimited using dollar signs, if more than one column of information is needed. If either this or the parameter Entries are left blank, no columns are added.
Table Entries No (optional) A list of entries delimited using semicolons, if more than one column of information is needed. There must be as many entries as there are as headers multiplied by modes, or no columns will be added. If either this or the Headers parameter are left blank, no columns are added.
Collapsed No (optional) An option to have the table collapsed. Enter "1" to have the table collapsed by default.

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

Collapsing the table

The table can be collapsed by default by passing a "1" for the Collapsed parameter. This is recommended for pages with too much information (such as MOS scales with a very large number of modes). 

{{MOS modes|Scale Signature=4L 6s|Collapsed=1}}
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 (such as with 5L 3s) or a name consisting of multiple words (such as with the mode names described by Elaine Walker for 4L 5s <3/1>). 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		 Mode names
7|0 1 LLsLLsLs Dylathian, Dylian
6|1 4 LLsLsLLs Ilarnekian
5|2 7 LsLLsLLs Celephaïsian
4|3 2 LsLLsLsL Ultharian
3|4 5 LsLsLLsL Mnarian
2|5 8 sLLsLLsL Kadathian, Kadian
1|6 3 sLLsLsLL Hlanithian, Hlanian
0|7 6 sLsLLsLL Sarnathian, Sarnian 
{{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		 Mode names
8|0 1 LsLsLsLss Walker I
7|1 3 LsLsLssLs Walker II
6|2 5 LsLssLsLs Moll I (Delta)
5|3 7 LssLsLsLs Lambda
4|4 9 sLsLsLsLs Moll II (Pierce)
3|5 2 sLsLsLssL Harmonic
2|6 4 sLsLssLsL Dur I
1|7 6 sLssLsLsL Walker A
0|8 8 ssLsLsLsL Walker B

Adding multiple columns

In situations where more than one column is needed, list the headers and entries as shown below. Entries are filled in by row. The two examples show mode names added in two ways – using Mode Names and Entries – so both examples produce the same table. 

{{MOS modes|Scale Signature=6L 3s|Table Headers=Mode name$ Name origin|Table Entries=Zeldan$ Named after Zelda$ Linkan$ Named after Link$ Ganan, Ganondoran$ Named after Ganon/Ganondorf}}
{{MOS modes|Scale Signature=6L 3s|Mode Names=Zeldan$ Linkan$ Ganan, Ganondoran|Table Headers=Name origin|Table Entries=Named after Zelda$ Named after Link$ Named after Ganon/Ganondorf}}
Modes of 6L 3s
UDP Cyclic
order		 Step
pattern		 Mode name Name origin
6|0(3) 1 LLsLLsLLs Zeldan Named after Zelda
3|3(3) 2 LsLLsLLsL Linkan Named after Link
0|6(3) 3 sLLsLLsLL Ganan, Ganondoran Named after Ganon/Ganondorf

Limitations

If adding table entries through the Entries parameter, blank entries cannot be entered and the table rows and headers won't be added.

See also

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