Template:MOS degrees/doc: Difference between revisions
Updated documentation to reflect new features |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| (9 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= | | Number of Alterations=1 | ||
}} | }} | ||
</pre> | </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> | |||