Template:MOS gamut/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
mNo edit summary
Ganaram inukshuk (talk | contribs)
Updated documentation to reflect changes to module
Line 5: Line 5:
! 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 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 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.
|-
|-
| UDP || 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>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>Note Symbols</pre> || 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.
|-
|-
| 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.
| <pre>Sharp Symbol</pre> || 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.
| <pre>Flat Symbol</pre> || 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.
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>
<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 ===


<pre>{{MOS gamut|Scale Signature = 4L 3s}}</pre>
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.
{{MOS gamut|Scale Signature = 4L 3s}}


=== Using a different step ratio and mode ===
<pre>{{MOS gamut|Scale Signature = 4L 3s|Step Ratio = 3/1}}</pre>
{{MOS gamut|Scale Signature = 4L 3s|Step Ratio = 3/1}}


An example of using a different step ratio and mode are shown below. To prevent any issues with the visual editor or source editing, use the character "," in place of the pipe symbol.
=== Using different notation and a different mode ===


<pre>{{MOS gamut|Scale Signature = 4L 3s|UDP = 3,3|Step Ratio = 3/1}}</pre>
This template uses the following defaults:
{{MOS gamut|Scale Signature = 4L 3s|UDP = 3,3|Step Ratio = 3/1}}
* 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 = 4L 3s|UDP = 3,3|Step Ratio = 3/2}}</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 = 4L 3s|UDP = 3,3|Step Ratio = 3/2}}
 
=== Using different notation ===
 
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).


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