Template:MOS modes/doc: Difference between revisions
Update documentation to reflect common use |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{dochead}} | {{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. | 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 === | === Parameters === | ||
The template currently supports the following parameters: | The template currently supports the following parameters: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Parameters | ! Parameters | ||
! Required? | ! Required? | ||
| Line 11: | Line 13: | ||
| Scale Signature | | Scale Signature | ||
| Yes (optional on mos pages) | | Yes (optional on mos pages) | ||
| The mos's scale signature in the form "xL ys", or for non-octave mosses, "xL ys | | 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 | | Mode Names | ||
| No (optional) | | No (optional) | ||
| A list of names delimited using | | A list of names delimited using dollar signs.* 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 | | Table Headers | ||
| No (optional) | | No (optional) | ||
| A list of column headers delimited using | | 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 | | Table Entries | ||
| No (optional) | | No (optional) | ||
| A list of entries delimited using | | 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 | | Collapsed | ||
| Line 29: | Line 31: | ||
| An option to have the table collapsed. Enter "1" to have the table collapsed by default. | | 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>&#x24;</code> or <code>&#36;</code>. | |||
=== Usage === | === Usage === | ||
| Line 37: | Line 40: | ||
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> | ||
{{ | {{{{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> | ||
{{ | {{{{ROOTPAGENAME}}|Scale Signature=4L 5s <3/1>}} | ||
<pre>{{MOS modes|Scale Signature=4L 6s}}</pre> | <pre>{{MOS modes|Scale Signature=4L 6s}}</pre> | ||
{{ | {{{{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> | ||
{{ | {{{{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 | 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{{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=5L 3s|Mode Names=Dylathian, Dylian | <pre>{{MOS modes|Scale Signature=5L 3s|Mode Names=Dylathian, Dylian$ Ilarnekian$ Celephaïsian$ Ultharian$ Mnarian$ Kadathian, Kadian$ Hlanithian, Hlanian$ Sarnathian, Sarnian}}</pre> | ||
{{ | {{{{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 | <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 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 ==== | ||
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. | 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 | <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 | <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 === | === Limitations === | ||
| Line 65: | Line 68: | ||
=== See also === | === See also === | ||
* | * [[Template:MOS mode degrees]], a similar template that displays the qualities of each mode's scale degrees. | ||