Template:MOS modes/doc: Difference between revisions

Line 1:

== Documentation ==

=== Arguments ===

The template currently supports the following ~~arguments~~:

The template currently supports the following parameters:

{| class="wikitable"

|+

!~~Argument~~

!Parameters

!Required?

!Description

Line 13:

Line 14:

|Mode Names

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

=== ~~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=4L 5s <3/1>}}</pre>

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

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

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

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

@@ Line 1: / Line 1: @@
+== Documentation ==
 === Arguments ===
-The template currently supports the following arguments:
+The template currently supports the following parameters:
 {| class="wikitable"
 |+
-!Argument
+!Parameters
 !Required?
 !Description
@@ Line 13: / Line 14: @@
 |Mode Names
 |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>
-=== 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>
 {{MOS modes|Scale Signature=5L 3s}}
 <pre>{{MOS modes|Scale Signature=4L 5s <3/1>}}</pre>
 {{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>
 {{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>
 {{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.