Xenharmonic Wiki

Template:MOS modes/doc: Difference between revisions

← Older edit
VisualWikitext
Ganaram inukshuk (talk | contribs)
autopatrolled
4,810 edits
No edit summary
ArrowHead294 (talk | contribs)
14,512 edits
mNo edit summary
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Parameters ==
{{dochead}}{{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:
The template currently supports the following parameters:
{| class="wikitable"
{| class="wikitable"
|+
!Parameters
!Required?
!Description
|-
|-
|Scale Signature
! Parameters
|Yes (optional on mos pages)
! Required?
|The mos's scale signature in the form "xL ys", or for non-octave mosses, "xL ys<nowiki><p/q></nowiki>", "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.
! Description
|-
|-
|Mode Names
| Scale Signature
|No (optional)
| Yes (optional on mos pages)
|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.
| The mos's scale signature in the form "xL&nbsp;ys", or for non-octave mosses, "xL&nbsp;ys&lt;p/q&gt;", "xL&nbsp;ys⟨p/q⟩", or "xL&nbsp;ys&nbsp;(p/q-equivalent)". If left blank and used on a mos page, then the page's title will be used.
|-
|-
|Headers
| Mode Names
|No (optional)
| No (optional)
|A list of column headers delimited using semicolons, if more than one column of information is needed. If either this or the parameter Entries are left blank, no columns are added.
| A list of names delimited using dollar signs.* If provided, then a column for modes names are added. If the scale signature is "5L&nbsp;2s", then mode names (Lydian, Ionian, etc) are automatically added.
|-
|-
|Entries
| Table Headers
|No (optional)
| 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.
| 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 dollar signs,* 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.
|}
|}
<nowiki />* In these fields, literal dollar signs must be escaped as <code>&amp;#x24;</code> or <code>&amp;#36;</code>.


== Usage ==
=== Usage ===
For mos pages, which is the typical use, simply include the code below.
For mos pages, which is the typical use, simply include the code below.
<pre>{{MOS modes}}</pre>
<pre>{{MOS modes}}</pre>
=== Using a different scale signature ===
 
==== 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.
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}}
=== 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.
==== Collapsing the table ====
<pre>{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian}}</pre>
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=5L 3s|Mode Names=Dylathian, Dylian; Ilarnekian; Celephaïsian; Ultharian; Mnarian; Kadathian, Kadian; Hlanithian, Hlanian; Sarnathian, Sarnian}}
<pre>{{MOS modes|Scale Signature=4L 6s|Collapsed=1}}</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>
{{{{ROOTPAGENAME}}|Scale Signature=4L 6s|Collapsed=1}}
{{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}}
 
=== Adding multiple columns ===
==== Adding mode names ====
In situations where more than one column is needed, list the headers and entries as shown below. Entries are filled in by row.
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&nbsp;5s{{angbr|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=6L 3s|Headers=Mode name; Name origin|Entries=Zeldan; Named after Zelda; Linkan; Named after Link; Ganan, Ganondoran; Named after Ganon/Ganondorf}}</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=6L 3s|Headers=Mode name; Name origin|Entries=Zeldan; Named after Zelda; Linkan; Named after Link; Ganan, Ganondoran; Named after Ganon/Ganondorf}}
{{{{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=2L 3s|Mode Names=Blues minor; Minor pentatonic; Egyptian; Blues major; Major pentatonic|Headers=Closest diatonic mode|Entries=Phrygian; Aeolian (minor); Dorian; Mixolydian; Ionian (major)}}</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>
Mode names and column entries may be used together.
{{{{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}}
{{MOS modes|Scale Signature=2L 3s|Mode Names=Blues minor; Minor pentatonic; Egyptian; Blues major; Major pentatonic|Headers=Closest diatonic mode|Entries=Phrygian; Aeolian (minor); Dorian; Mixolydian; Ionian (major)}}
 
==== 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.
<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>
{{{{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 ===
If adding table entries through the Entries parameter, blank entries cannot be entered and the table rows and headers won't be added.


== Limitations ==
=== See also ===
If adding table entries through the Entries parameter, blank entries cannot be entered.
* [[Template:MOS mode degrees]], a similar template that displays the qualities of each mode's scale degrees.
Retrieved from "https://en.xen.wiki/w/Template:MOS_modes/doc"