Template:MOS mode degrees: Difference between revisions

Ganaram inukshuk (talk | contribs)
Added documentation (added as part of the page rather than in a transcluded subpage)
ArrowHead294 (talk | contribs)
+Debugging option
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{#invoke:MOS_mode_degrees|mos_mode_degrees_frame
<includeonly>{{#invoke: MOS_mode_degrees | mos_mode_degrees
|Scale Signature={{{Scale Signature|{{PAGENAME}}}}}
| Scale Signature={{{Scale Signature|{{PAGENAME}}}}}
|MOS Prefix={{{MOS Prefix|}}}
| MOS Prefix={{{MOS Prefix|}}}
|Mode Names={{{Mode Names|}}}
| Collapsed={{{Collapsed|}}}
|MODMOS Step Pattern={{{MODMOS Step Pattern|}}}
| Mode Names={{{Mode Names|}}}
}}</includeonly>
| MODMOS Step Pattern={{{MODMOS Step Pattern|}}}
<noinclude>This template creates a table of a mos's (or modmos's) scale degrees for each mode.
| debug={{lc:{{{debug|}}}}}
== Parameters ==
}}</includeonly><noinclude>
{| class="wikitable"
{{documentation}}
|-
! Parameters !! Required? !! Description
|-
| <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.
|-
| <pre>MOS Prefix</pre> || No (optional) || If using TAMNAMS mosdegree naming, does the mos have a prefix?
|-
| <pre>MODMOS Step Pattern</pre> || No (optional) || Step pattern of a MODMOS.
|}
== Usage ==
 
The typical use of this template is for showing a table of scale degrees for each mode of a mos or modmos, a step pattern that deviates from the true mos pattern. Scale degrees are referred to as mosdegrees and are indexed starting at 0, per [[TAMNAMS]] parlance.
 
<pre>{{MOS mode degrees}}</pre>
 
=== Using a different scale signature ===
 
A scale signature different from the page's title can be entered as shown.
 
<pre>{{MOS mode degrees
|Scale Signature=5L 2s}}</pre>
{{MOS mode degrees
|Scale Signature=5L 2s}}
 
=== Using a different mos prefix ===
 
By default, the mos prefix is "mos". For TAMNAMS-named mosses, the mos prefix will be automatically added. For non-TAMNAMS mosses that have prefixes, enter it using the parameter "MOS Prefix", as shown.
 
<pre>{{MOS mode degrees
|Scale Signature=5L 2s
|MOS Prefix=mos}}</pre>
 
=== Using a modmos's step pattern ===
 
The modes of a modified step pattern, or modmos, can be entered instead. This changes the table to display the closest true mos modes, as well as display the modes in rotational order rather than in decreasing modal brightness.
 
<pre>{{MOS mode degrees
|Scale Signature=5L 2s
|MODMOS Step Pattern=LsLLsAs}}</pre>
{{MOS mode degrees
|Scale Signature=5L 2s
|MODMOS Step Pattern=LsLLsAs}}
 
=== Using mode names ===
 
The mode names can be entered as shown below. The number of names must exactly match the number of modes, and each mode must be separated with a semicolon.
 
<pre>{{MOS mode degrees
|Scale Signature=4L 3s
|Mode Names=Nerevarine; Vivecan; Lorkhanic; Sothic; Kagrenacan; Almalexian; Dagothic}}</pre>
{{MOS mode degrees
|Scale Signature=4L 3s
|Mode Names=Nerevarine; Vivecan; Lorkhanic; Sothic; Kagrenacan; Almalexian; Dagothic}}
 
Mode names for 5L 2s and its modmos LLsLsAs are provided by the template automatically.
 
{{MOS mode degrees
|Scale Signature=5L 2s}}
 
{{MOS mode degrees
|Scale Signature=5L 2s
|MODMOS Step Pattern=LsLLsAs}}
 
== Usage regarding modmos step patterns ==
 
The step pattern for a modmos uses the characters L and s, either arranged differently from the true mos pattern or may include the characters A, c, and d. Each character has a value represented in large and small steps. It is recommended to use a step pattern whose value of L's and s's matches that of the true mos pattern. The table below shows the sizes of each supported step type.
{| class="wikitable"
|-
! Character !! Case-sensitive? || Step name !! Size in L's and s's
|-
| L || Yes (uppercase) || The large step of a mos || L
|-
| s || No (uppercase or lowercase) || The small step of a mos|| s
|-
| c || Yes (lowercase) || The difference between a large and small step; the interval needed to add to a small step to make it a large step || L - s
|-
| A || Yes (uppercase) || An augmented step; a large step plus a chroma || 2L - s
|-
| d || Yes (lowercase) || A diminished step (or diesis in some contexts); a small step minus a chroma || -L + 2s
|}
 
As an example, the step pattern "LsLLsAs" is a modmos of 5L 2s, containing 3 large steps, 3 small steps, and one augmented step. The size of an augmented step is equivalent to that of a large step and chroma, and adding a chroma to a small step makes it a large step. In other words, the step pair "sA" is equivalent to that of "LL", since they have the same value in L's and s's, meaning that "LsLLsAs" is equal to 5 large steps and 2 small steps.


[[Category:MOS scale templates]]
</noinclude>
</noinclude>