Template:MOS gamut/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
Limitations: Template design (simple text output) is deemed complete
ArrowHead294 (talk | contribs)
mNo edit summary
 
(12 intermediate revisions by 4 users not shown)
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"
{| class="wikitable"
|-
|-
! Parameters !! Required? !! Description
! 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, <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.
|-
|-
| Step Ratio || 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.
| <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.
|-
|-
| Bright Gens Up || No (optional) || The number of bright generators going up needed to produce the mode for which notation is applied. In [[UDP notation]], this corresponds to the value u in the UDP of u|d, or up (u times p) in the UDP of up<nowiki>|</nowiki>dp for multi-period mosses. If left blank, then the brightest mode is used by default.
| <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.
|-
|-
| Note Symbols || No (optional) || A sequence of note symbols entered as a string, such as "CDEFGAB" and "JKLMNOP", the default for standard notation and [[diamond-MOS]] respectively, if left blank.
| <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.
|-
| Sharp Symbol || No (optional) || The symbol used to denote raising by a chroma, usually a sharp (#) or "am/amp" symbol (&), the default for standard notation and diamond-MOS respectively, if left blank.
|-
| Flat Symbol || No (optional) || The symbol used to denote lowering by a chroma, usually a flat (b) or "at" symbol (@), the default for standard notation and diamond-MOS respectively, if left blank.
|}
|}


== 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.
The typical use of this template is for describing a mos's gamut, the set of named notes.


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


A scale signature different from the page's title can be specified as shown below. This produces a gamut using the step ratio 2/1 and the brightest mode.
==== 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}}</pre>
{{MOS gamut|Scale Signature = 4L 3s}}
 
=== Using a different step ratio and mode ===
 
An example of using a different step ratio and mode are shown below.
 
<pre>{{MOS gamut|Scale Signature = 4L 3s|Bright Gens Up = 3|Step Ratio = 3/1}}</pre>
{{MOS gamut|Scale Signature = 4L 3s|Bright Gens Up = 3|Step Ratio = 3/1}}
 
<pre>{{MOS gamut|Scale Signature = 4L 3s|Bright Gens Up = 3|Step Ratio = 3/2}}</pre>
{{MOS gamut|Scale Signature = 4L 3s|Bright Gens Up = 3|Step Ratio = 3/2}}


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


An example of this template's usage with different notation can be shown using Armodue notation (used for 7L 2s) and notation used for Lambda (3/1-equivalent 4L 5s).
==== Using different notation and a different mode ====
This template uses the following defaults:
* Default notation: Diamond-MOS notation (nominals of JKL..., accidentals of & and @)
* Default UDP: middle mode (EG, for 4L 3s, this is mode <nowiki>3|3</nowiki>)


<pre>{{MOS gamut|Scale Signature = 7L 2s|Bright Gens Up = 7|Note Symbols = 123456789|Sharp Symbol = #|Flat Symbol = b}}</pre>
Two examples of changing the notation and mode are shown below, for Armodue notation (associated with 7L 2s) and Lambda (associated with 4L 5s {{Angbr|3/1}}).
{{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>
<pre>{{MOS gamut|Scale Signature = 7L 2s|UDP= 7,1|Notation = 123456789; #; b}}</pre>
{{MOS gamut|Scale Signature = 4L 5s (3/1-equivalent)|Bright Gens Up = 5|Note Symbols = CDEFGHJAB|Sharp Symbol = #|Flat Symbol = b}}
{{{{ROOTPAGENAME}}|Scale Signature = 7L 2s|UDP = 7,1|Notation = 123456789; #; b}}


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


=== 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.
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 56: Line 46:


<pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 4/2}}</pre>
<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.
Specific symbols for double-accidentals, such as "x" for double-sharps, are not supported.
Line 63: Line 53:


<pre>{{MOS gamut|Scale Signature = 5L 2s|Step Ratio = 1/1}}</pre>
<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>
<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}}