Template:MOS degrees/doc: Difference between revisions
Jump to navigation
Jump to search
Added limitations section; alterations >1 breaks the template |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
== Parameters == | {{dochead}}{{lua}} | ||
=== Parameters === | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 26: | Line 26: | ||
|} | |} | ||
== Usage == | === Usage === | ||
The typical use of this template is for showing a table of scale degrees for a specific step ratio. | The typical use of this template is for showing a table of scale degrees for a specific step ratio. | ||
<pre>{{MOS degrees}}</pre> | <pre>{{MOS degrees}}</pre> | ||
=== Using a different scale signature === | ==== Using a different scale signature ==== | ||
A scale signature different from the page's title can be entered as shown. | A scale signature different from the page's title can be entered as shown. | ||
<pre>{{MOS degrees | <pre>{{MOS degrees|Scale Signature=5L 2s}}</pre> | ||
|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. | 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 | <pre>{{MOS degrees | ||
|Scale Signature=5L 2s | | Scale Signature=5L 2s | ||
|Step Ratio=2/1; 3/1; 3/2}}</pre> | | Step Ratio=2/1; 3/1; 3/2}}</pre> | ||
=== Changing the mos prefix === | === 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. | 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 | <pre>{{MOS degrees | ||
|Scale Signature=2L 5s | | Scale Signature=2L 5s | ||
|MOS Prefix=pel}}</pre> | | MOS Prefix=pel}}</pre> | ||
Typing in "NONE" for the prefix will not show any prefixes. | Typing in "NONE" for the prefix will not show any prefixes. | ||
<pre>{{MOS degrees | <pre>{{MOS degrees | ||
|Scale Signature=4L 3s | | Scale Signature=4L 3s | ||
|MOS Prefix=NONE}}</pre> | | MOS Prefix=NONE}}</pre> | ||
==== Using notation and UDP ==== | |||
By default, no notation is displayed unless entered as shown in the example below. | By default, no notation is displayed unless entered as shown in the example below. | ||
<pre>{{MOS degrees | <pre>{{MOS degrees | ||
|Scale Signature=7L 2s | | Scale Signature=7L 2s | ||
|Notation=123456789; #; b | | Notation=123456789; #; b | ||
}}</pre> | }}</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.) | 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 | <pre>{{MOS degrees | ||
|Scale Signature=7L 2s | | Scale Signature=7L 2s | ||
|Notation=123456789; #; b | | Notation=123456789; #; b | ||
|UDP=7,1}}</pre> | | 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. | 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 | <pre>{{MOS degrees | ||
|Scale Signature=4L 3s | | Scale Signature=4L 3s | ||
|Notation=Default | | Notation=Default | ||
}} | }} | ||
</pre> | </pre> | ||
== Advanced usage == | === Advanced usage === | ||
=== Adding JI ratios === | ==== 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. | 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. | ||
| Line 104: | Line 81: | ||
<pre>{{MOS degrees | <pre>{{MOS degrees | ||
|Scale Signature=4L 3s | | Scale Signature=4L 3s | ||
|Show Abbreviations=1 | | Show Abbreviations=1 | ||
|JI Ratios= | | JI Ratios= | ||
M1md: 8/7; | M1md: 8/7; | ||
P2md: 77/64, 6/5; | P2md: 77/64, 6/5; | ||
| Line 117: | Line 94: | ||
}} | }} | ||
</pre> | </pre> | ||
=== Showing alterations === | ==== 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). | 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 | <pre>{{MOS degrees | ||
|Scale Signature=4L 3s | | Scale Signature=4L 3s | ||
|Number of Alterations=1 | | Number of Alterations=1 | ||
}} | }} | ||
</pre> | </pre> | ||
=== Limitations === | |||
Setting the number of alterations to any value greater than 1 throws the following error: | 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> | <pre>Lua error: Internal error: The interpreter has terminated with signal "24".</pre> | ||
Latest revision as of 03:10, 16 February 2025
 |
This template uses Lua: |
Parameters
| 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. |
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. |
Show Abbreviations |
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. |
Number of Alterations |
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. |
JI Ratios |
No (optional) | Whether to include JI ratios for certain entries. For assistance with entering ratios, see below. |
UDP |
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. |
Notation |
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. |
MOS Prefix |
No (optional) | If using TAMNAMS mosdegree naming, does the mos have a prefix? |
Genchain Extend |
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. |
Degree Notation |
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
The typical use of this template is for showing a table of scale degrees for a specific step ratio.
{{MOS degrees}}
Using a different scale signature
A scale signature different from the page's title can be entered as shown.
{{MOS degrees|Scale Signature=5L 2s}}
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.
{{MOS degrees
| Scale Signature=5L 2s
| Step Ratio=2/1; 3/1; 3/2}}
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.
{{MOS degrees
| Scale Signature=2L 5s
| MOS Prefix=pel}}
Typing in "NONE" for the prefix will not show any prefixes.
{{MOS degrees
| Scale Signature=4L 3s
| MOS Prefix=NONE}}
Using notation and UDP
By default, no notation is displayed unless entered as shown in the example below.
{{MOS degrees
| Scale Signature=7L 2s
| Notation=123456789; #; b
}}
By default, the mode for which nominals are applied is the symmetric mode, corresponding to a UDP of n|n. In the case of a mos with an even number of modes and therefore two "middle" modes (n+1|n and n|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 | symbol.)
{{MOS degrees
| Scale Signature=7L 2s
| Notation=123456789; #; b
| UDP=7,1}}
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.
{{MOS degrees
| Scale Signature=4L 3s
| Notation=Default
}}
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.
{{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;
}}
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).
{{MOS degrees
| Scale Signature=4L 3s
| Number of Alterations=1
}}
Limitations
Setting the number of alterations to any value greater than 1 throws the following error:
Lua error: Internal error: The interpreter has terminated with signal "24".