Template:MOS gamut/doc: Difference between revisions

Line 5:

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

| Scale Signature || Yes (optional on mos pages) || The mos's scale signature in the form "xL ys", or for non-octave mosses, <nowiki>"xL ys<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.

|-

| Step Ratio || No (optional) || The step ratio of the mos, denoted as a fraction p/q. If not simplified, then the ratio is automatically simplified. If left blank, then then step ratio 2/1 is used by default.

|-

~~| Step Ratio || No (optional) || The step ratio of the mos, denoted as a fraction p/q. If left blank, then then step ratio 2/1 is used by default.~~

| Bright Gens Up || No (optional) || The number of bright generators going up needed to produce the mode for which notation is applied. If a mode is denoted using its [[UDP]] (up|dp), this is the value up (u times p). If left blank, then the brightest mode is used by default.

|-

Line 16:

Line 17:

| Flat Symbol || No (optional) || The symbol used to denote lowering by a chroma, usually a flat (b) or diamond-MOS's at symbol (@). If left blank, then either b or @ is used by default.

|}

== Usage ==

The typical use of this template is for describing a mos's gamut, the set of named notes, with accidentals.

<pre>{{MOS gamut}}</pre>

=== Using a different scale signature ===

If desired, a different scale signature can be entered as shown below.

<pre>{{MOS gamut|Scale Signature = 2L 5s}}</pre>

=== Examples ===

An example of this template's usage can be shown using Armodue notation (used for 7L 2s) and Lambda notation (used for 3/1-equivalent 4L 5s).

<pre>{{MOS gamut|Scale Signature = 7L 2s|Bright Gens Up = 7|Note Symbols = 123456789|Sharp Symbol = #|Flat Symbol = b}}</pre>

{{MOS gamut|Scale Signature = 7L 2s|Bright Gens Up = 7|Note Symbols = 123456789|Sharp Symbol = #|Flat Symbol = b}}

<pre>{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|Bright Gens Up = 5|Note Symbols = CDEFGHJAB|Sharp Symbol = #|Flat Symbol = b}}</pre>

{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|Bright Gens Up = 5|Note Symbols = CDEFGHJAB|Sharp Symbol = #|Flat Symbol = b}}

== Limitations ==

This template currently cannot handle accidentals any smaller than a sharp or flat (such as ups and downs). An example of this is 5L 2s in 24edo, with a step ratio is 4/2. In such cases, the step ratio is simplified and a simpler gamut is shown.

<pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 4/2}}</pre>

This template can accept equalized step ratios, but currently not collapsed step ratios.

<pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/0}}</pre>

@@ Line 5: / Line 5: @@
 ! 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.
+| Scale Signature || Yes (optional on mos pages) || The mos's scale signature in the form "xL ys", or for non-octave mosses, <nowiki>"xL ys<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.
+|-
+| Step Ratio || No (optional) || The step ratio of the mos, denoted as a fraction p/q. If not simplified, then the ratio is automatically simplified. If left blank, then then step ratio 2/1 is used by default.
 |-
-| Step Ratio || No (optional) || The step ratio of the mos, denoted as a fraction p/q. If left blank, then then step ratio 2/1 is used by default.
 | Bright Gens Up || No (optional) || The number of bright generators going up needed to produce the mode for which notation is applied. If a mode is denoted using its [[UDP]] (up|dp), this is the value up (u times p). If left blank, then the brightest mode is used by default.
 |-
@@ Line 16: / Line 17: @@
 | Flat Symbol || No (optional) || The symbol used to denote lowering by a chroma, usually a flat (b) or diamond-MOS's at symbol (@). If left blank, then either b or @ is used by default.
 |}
+== Usage ==
+The typical use of this template is for describing a mos's gamut, the set of named notes, with accidentals.
+<pre>{{MOS gamut}}</pre>
+=== Using a different scale signature ===
+If desired, a different scale signature can be entered as shown below.
+<pre>{{MOS gamut|Scale Signature = 2L 5s}}</pre>
+{{MOS gamut|Scale Signature = 2L 5s}}
+=== Examples ===
+An example of this template's usage can be shown using Armodue notation (used for 7L 2s) and Lambda notation (used for 3/1-equivalent 4L 5s).
+<pre>{{MOS gamut|Scale Signature = 7L 2s|Bright Gens Up = 7|Note Symbols = 123456789|Sharp Symbol = #|Flat Symbol = b}}</pre>
+{{MOS gamut|Scale Signature = 7L 2s|Bright Gens Up = 7|Note Symbols = 123456789|Sharp Symbol = #|Flat Symbol = b}}
+<pre>{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|Bright Gens Up = 5|Note Symbols = CDEFGHJAB|Sharp Symbol = #|Flat Symbol = b}}</pre>
+{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|Bright Gens Up = 5|Note Symbols = CDEFGHJAB|Sharp Symbol = #|Flat Symbol = b}}
+== Limitations ==
+This template currently cannot handle accidentals any smaller than a sharp or flat (such as ups and downs). An example of this is 5L 2s in 24edo, with a step ratio is 4/2. In such cases, the step ratio is simplified and a simpler gamut is shown.
+<pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 4/2}}</pre>
+{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 4/2}}
+This template can accept equalized step ratios, but currently not collapsed step ratios.
+<pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/0}}</pre>
+{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/0}}