Template:MOS gamut/doc: Difference between revisions

(7 intermediate revisions by 3 users not shown)

Line 1:

~~== Parameters ==~~

This template is used for mos pages and similar pages to list the note names of a mos for a given step ratio.

=== Parameters ===

{| class="wikitable"

|-

! Parameters !! Required? !! Description

|-

| <pre>Scale Signature</pre> || 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.

| <pre>Scale Signature</pre> || 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.

|-

| <pre>Step Ratio</pre> || No (optional) || The step ratio of the mos, denoted as a fraction p/q and separated with a slash. If left blank, then the step ratio "2/1" is used by default.

Line 11:

Line 13:

| <pre>UDP</pre> || No (optional) || The UDP representing the mode for which notation is applied. Due to technical limitations, using the pipe symbol is not advised and the "," character (comma) should be used instead.

|-

| <pre>Notation</pre> || No (optional) || The notation for note names, consisting of the naturals (written without separators), sharp symbol, and flat symbol, each separated by semicolons. For example, standard notation is entered as "CDEFGAB; #; b". If left blank, the default is diamond-MOS notation (JKLMNOP for naturals, & for the sharp symbol, and @ for the flat symbol), or if the scale signature is 5L 2s, the default is standard notation.

| <pre>Notation</pre> || No (optional) || The notation for note names, consisting of the naturals (written without separators), sharp symbol, and flat symbol, each separated by semicolons. For example, standard notation is entered as "CDEFGAB; #; b". If left blank, the default is diamond-MOS notation (JKLMNOP for naturals, & for the sharp symbol, and @ for the flat symbol), or if the scale signature is 5L 2s, the default is standard notation.

|}

== Usage ==

=== Usage ===

The typical use of this template is for describing a mos's gamut, the set of named notes. This produces a gamut using the step ratio 2/1 with nominals (notes without accidentals) assigned to the middle mode. The middle mode has a UDP of n|n, but if there is an even number of modes and there are two "middle" modes, then the brighter of the two is used.

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

=== Using a different step ratio ===

==== Using a different step ratio ====

An example of using a different step ratio is shown below. Accidentals (or notes with accidentals) are only added for any scale degrees that lie between nominals, and the amount will depend on the step ratio.

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

{{{{ROOTPAGENAME}}|Scale Signature = 4L 3s|Step Ratio = 3/1}}

~~=== Using different notation and a different mode ===~~

==== Using different notation and a different mode ====

This template uses the following defaults:

* Default notation: Diamond-MOS notation (nominals of JKL..., accidentals of & and @)

Line 36:

Line 35:

<pre>{{MOS gamut|Scale Signature = 7L 2s|UDP= 7,1|Notation = 123456789; #; b}}</pre>

{{~~MOS gamut~~|Scale Signature = 7L 2s|UDP = 7,1|Notation = 123456789; #; b}}

{{{{ROOTPAGENAME}}|Scale Signature = 7L 2s|UDP = 7,1|Notation = 123456789; #; b}}

<pre>{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|UDP = 5,3|Notation = CDEFGHJAB; #; b}}</pre>

{{~~MOS gamut~~|Scale Signature = 4L 5s (3/1-equivalent)|UDP = 5,3|Notation = CDEFGHJAB; #; b}}

{{{{ROOTPAGENAME}}|Scale Signature = 4L 5s (3/1-equivalent)|UDP = 5,3|Notation = CDEFGHJAB; #; b}}

~~== Limitations ==~~

=== Limitations ===

Equivalent pitch classes are currently limited to pitches that fall at the exact midpoint of two other pitches, such as C# and Db being equivalent in standard notation, or C and B# being equivalent. This is to ensure note names have as few accidentals as possible.

Line 48:

Line 46:

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

{{{{ROOTPAGENAME}}|Scale Signature = 5L 2s|Step Ratio = 4/2}}

Specific symbols for double-accidentals, such as "x" for double-sharps, are not supported.

Line 55:

Line 53:

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

{{{{ROOTPAGENAME}}|Scale Signature = 5L 2s|Step Ratio = 1/1}}

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

{{{{ROOTPAGENAME}}|Scale Signature = 5L 2s|Step Ratio = 1/0}}

@@ Line 1: / Line 1: @@
-== Parameters ==
+{{dochead}}{{lua}}
+This template is used for mos pages and similar pages to list the note names of a mos for a given step ratio.
+=== Parameters ===
 {| class="wikitable"
 |-
 ! Parameters !! Required? !! Description
 |-
-| <pre>Scale Signature</pre> || 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.
+| <pre>Scale Signature</pre> || Yes (optional on mos pages) || 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.
 |-
 | <pre>Step Ratio</pre> || No (optional) || The step ratio of the mos, denoted as a fraction p/q and separated with a slash. If left blank, then the step ratio "2/1" is used by default.
@@ Line 11: / Line 13: @@
 | <pre>UDP</pre> || No (optional) || The UDP representing the mode for which notation is applied. Due to technical limitations, using the pipe symbol is not advised and the "," character (comma) should be used instead.
 |-
-| <pre>Notation</pre> || No (optional) || The notation for note names, consisting of the naturals (written without separators), sharp symbol, and flat symbol, each separated by semicolons. For example, standard notation is entered as "CDEFGAB; #; b". If left blank, the default is diamond-MOS notation (JKLMNOP for naturals, & for the sharp symbol, and @ for the flat symbol), or if the scale signature is 5L 2s, the default is standard notation.
+| <pre>Notation</pre> || No (optional) || The notation for note names, consisting of the naturals (written without separators), sharp symbol, and flat symbol, each separated by semicolons. For example, standard notation is entered as "CDEFGAB; #; b". If left blank, the default is diamond-MOS notation (JKLMNOP for naturals, & for the sharp symbol, and @ for the flat symbol), or if the scale signature is 5L&nbsp;2s, the default is standard notation.
 |}
-== Usage ==
+=== Usage ===
 The typical use of this template is for describing a mos's gamut, the set of named notes. This produces a gamut using the step ratio 2/1 with nominals (notes without accidentals) assigned to the middle mode. The middle mode has a UDP of n|n, but if there is an even number of modes and there are two "middle" modes, then the brighter of the two is used.
 <pre>{{MOS gamut}}</pre>
-=== Using a different step ratio ===
+==== Using a different step ratio ====
 An example of using a different step ratio is shown below. Accidentals (or notes with accidentals) are only added for any scale degrees that lie between nominals, and the amount will depend on the step ratio.
 <pre>{{MOS gamut|Scale Signature = 4L 3s|Step Ratio = 3/1}}</pre>
-{{MOS gamut|Scale Signature = 4L 3s|Step Ratio = 3/1}}
+{{{{ROOTPAGENAME}}|Scale Signature = 4L 3s|Step Ratio = 3/1}}
-=== Using different notation and a different mode ===
+==== Using different notation and a different mode ====
 This template uses the following defaults:
 * Default notation: Diamond-MOS notation (nominals of JKL..., accidentals of & and @)
@@ Line 36: / Line 35: @@
 <pre>{{MOS gamut|Scale Signature = 7L 2s|UDP= 7,1|Notation = 123456789; #; b}}</pre>
-{{MOS gamut|Scale Signature = 7L 2s|UDP = 7,1|Notation = 123456789; #; b}}
+{{{{ROOTPAGENAME}}|Scale Signature = 7L 2s|UDP = 7,1|Notation = 123456789; #; b}}
 <pre>{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|UDP = 5,3|Notation = CDEFGHJAB; #; b}}</pre>
-{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|UDP = 5,3|Notation = CDEFGHJAB; #; b}}
+{{{{ROOTPAGENAME}}|Scale Signature = 4L 5s (3/1-equivalent)|UDP = 5,3|Notation = CDEFGHJAB; #; b}}
-== Limitations ==
+=== Limitations ===
 Equivalent pitch classes are currently limited to pitches that fall at the exact midpoint of two other pitches, such as C# and Db being equivalent in standard notation, or C and B# being equivalent. This is to ensure note names have as few accidentals as possible.
@@ Line 48: / Line 46: @@
 <pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 4/2}}</pre>
-{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 4/2}}
+{{{{ROOTPAGENAME}}|Scale Signature = 5L 2s|Step Ratio = 4/2}}
 Specific symbols for double-accidentals, such as "x" for double-sharps, are not supported.
@@ Line 55: / Line 53: @@
 <pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/1}}</pre>
-{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/1}}
+{{{{ROOTPAGENAME}}|Scale Signature = 5L 2s|Step Ratio = 1/1}}
 <pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/0}}</pre>
-{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/0}}
+{{{{ROOTPAGENAME}}|Scale Signature = 5L 2s|Step Ratio = 1/0}}