Template:MOS degrees/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
Added documentation; specific info for certain params will be added later on
 
ArrowHead294 (talk | contribs)
mNo edit summary
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Parameters ==
{{dochead}}{{lua}}
 
=== Parameters ===
{| class="wikitable"
{| class="wikitable"
|-
|-
Line 9: Line 9:
| <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.
| <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.
|-
|-
| <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>Show Abbreviations</pre> || No (optional) || Whether to show degree abbreviations. Abbreviations are shown without a mos prefix, and are intended to be an aid with entering JI ratios. Enter "1" to show abbreviations.
|-
|-
| <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>Number of Alterations</pre> || No (optional) || Whether to show alterations to a mos's specific interval sizes. One alteration shows the large size with +1 chroma and the small size with -1 chroma, or for periods (including the unison and equave), the perfect size with +1 and -1 chroma.
|-
|-
| <pre>Genchain Extend</pre> || No (optional) || Additional intervals corresponding to the number of additional generators going up and/or down after those represented by the UDP. This value is per period, and the default value is the number of large steps per period.
| <pre>JI Ratios</pre> || No (optional) || Whether to include JI ratios for certain entries. For assistance with entering ratios, see below.
|-
|-
| <pre>Degree Notation</pre> || No (optional) || How should degrees be named? Options include TAMNAMS mosdegree naming and ordinal naming (EG, the unison is either called the 0-mosstep or 1st).
| <pre>UDP</pre> || No (optional) || The UDP representing the mode for which notation is applied; this is to be used in conjunction with notation. 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". Notation will not be displayed unless entered.
|-
|-
| <pre>MOS Prefix</pre> || No (optional) || If using TAMNAMS mosdegree naming, does the mos have a prefix?
| <pre>MOS Prefix</pre> || No (optional) || If using TAMNAMS mosdegree naming, does the mos have a prefix?
|-
| <pre>Genchain Extend</pre> || Deprecated || Additional intervals corresponding to the number of additional generators going up and/or down after those represented by the UDP. This value is per period, and the default value is the number of large steps per period.
|-
| <pre>Degree Notation</pre> || Deprecated || How should degrees be named? Options include TAMNAMS mosdegree naming and ordinal naming (EG, the unison is either called the 0-mosstep or 1st).
|}
|}


== Usage ==
=== Usage ===
The typical use of this template is for showing a table of scale degrees for a specific step ratio.
 
<pre>{{MOS degrees}}</pre>


The typical use of this template is for showing a table of scale degrees for a specific step ratio.
==== Using a different scale signature ====
A scale signature different from the page's title can be entered as shown.
 
<pre>{{MOS degrees|Scale Signature=5L 2s}}</pre>
 
==== Using a different step ratio ====
By default, cent and step values will be calculated for a step ratio of 2:1. A different step ratio can be entered as shown below. Up to 5 step ratios can be entered, written as p/q and with each ratio separated by semicolons.
 
<pre>{{MOS degrees
| Scale Signature=5L 2s
| Step Ratio=2/1; 3/1; 3/2}}</pre>
 
=== Changing the mos prefix ===
A mos-prefix, if defined under TAMNAMS, is automatically added. For mosses outside of TAMNAMS that have a prefix, enter it as shown below.
<pre>{{MOS degrees
| Scale Signature=2L 5s
| MOS Prefix=pel}}</pre>
 
Typing in "NONE" for the prefix will not show any prefixes.
<pre>{{MOS degrees
| Scale Signature=4L 3s
| MOS Prefix=NONE}}</pre>
 
==== Using notation and UDP ====
By default, no notation is displayed unless entered as shown in the example below.
<pre>{{MOS degrees
| Scale Signature=7L 2s
| Notation=123456789; #; b
}}</pre>
 
By default, the mode for which nominals are applied is the symmetric mode, corresponding to a UDP of n<nowiki>|</nowiki>n. In the case of a mos with an even number of modes and therefore two "middle" modes (n+1<nowiki>|</nowiki>n and n<nowiki>|</nowiki>n+1), the brighter of the two is used as the default instead. Since some notation schemes may use a different mode as its "default", the UDP can be changed, as shown below. (Use a comma instead of the pipe <nowiki>|</nowiki> symbol.)
<pre>{{MOS degrees
| Scale Signature=7L 2s
| Notation=123456789; #; b
| UDP=7,1}}</pre>
 
The template will attempt to use default notation with a default UDP if the keyword "Default" is entered. The default is standard notation on C (for 5L 2s) and diamond-mos for any nondiatonic mosses.
<pre>{{MOS degrees
| Scale Signature=4L 3s
| Notation=Default
}}
</pre>
 
=== Advanced usage ===
==== Adding JI ratios ====
JI ratios can be added by writing a semicolon-delimited list of entries, where each entry is an abbreviation for a scale degree, followed by a colon, followed by the JI ratio.
 
To help with entering ratios, set the parameter "Show Abbreviations" to 1 to show scale degrees.
 
<pre>{{MOS degrees
| Scale Signature=4L 3s
| Show Abbreviations=1
| JI Ratios=
M1md: 8/7;
P2md: 77/64, 6/5;
m3md: 14/11;
M3md:11/8;
m4md: 16/11;
M4md: 11/7;
P5md: 5/3;
m6md: 7/4;
}}
</pre>
 
==== Showing alterations ====
Alterations refer to raising scale degrees by a chroma beyond the large and small sizes of a mos. For the number of alterations added, an additional altered degree is shown from raising the large size of a scale degree and lowering the small size of a scale degree (or the perfect size for period, unison, and equaves).
<pre>{{MOS degrees
| Scale Signature=4L 3s
| Number of Alterations=1
}}
</pre>


<pre>{{MOS gamut}}</pre>
=== Limitations ===
Setting the number of alterations to any value greater than 1 throws the following error:
<pre>Lua error: Internal error: The interpreter has terminated with signal "24".</pre>