Template:MOS in EDO: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
Simplified args, added (some) documentation
Ganaram inukshuk (talk | contribs)
Added rest of documentation; removed todo
Line 7: Line 7:
|Generation Limit={{{Generation Limit|}}}
|Generation Limit={{{Generation Limit|}}}
}}</includeonly><noinclude>
}}</includeonly><noinclude>
{{Todo|add documentation|inline=1}}
This template creates a table showing the mosses found in an [[edo]] that are made using a generator of a given size.
This template creates a table showing the mosses found in an [[edo]] that are made using a generator of a given size.
== Parameters ==
== Parameters ==
Line 21: Line 20:
|-
|-
| <pre>Generation Limit</pre> || No (optional) || If set, this puts a maximum limit to the number of rows in the resulting table.
| <pre>Generation Limit</pre> || No (optional) || If set, this puts a maximum limit to the number of rows in the resulting table.
|-
| <pre>Step Visualization</pre> || No || Unused.
|}
|}
== Usage ==
== Usage ==
Line 31: Line 32:
|Generator=7}}
|Generator=7}}
=== Multi-period mosses ===
=== Multi-period mosses ===
To display the mosses for a multi-period mos, enter the number of periods as shown below. The number of periods must divide the number of divisions without a remainder.
To display the mosses for a multi-period mos, enter the number of periods as shown below. The number of periods must divide the number of divisions without a remainder. The default value is 1 period.
<pre>{{MOS in EDO
<pre>{{MOS in EDO
|EDO=12
|EDO=12
|Generator=5
|Generator=5
|Periods=}}</pre>
|Periods=2}}</pre>
{{MOS in EDO
{{MOS in EDO
|EDO=12
|EDO=12
|Generator=5
|Generator=5
|Periods=2}}
|Periods=2}}
=== Limiting the number of rows ===
For large edos and for some generators, the number of rows in the table can be quite large. A limit on the number of rows can be entered as shown. The default is -1, which is no limit.
<pre>{{MOS in EDO
|EDO=31
|Generator=1
|Generation Limit=10}}</pre>
{{MOS in EDO
|EDO=31
|Generator=1
|Generation Limit=10}}
=== Temperament names ===
To add a temperament name, add it as shown. Note that how this is displayed is still work-in-progress.
<pre>{{MOS in EDO
|EDO=12
|Generator=5
|Periods=2
|Temperament=pajara}}</pre>
{{MOS in EDO
|EDO=12
|Generator=5
|Periods=2
|Temperament=pajara}}
[[Category:Templates]]
[[Category:Templates]]
</noinclude>
</noinclude>

Revision as of 03:43, 17 December 2023

This template creates a table showing the mosses found in an edo that are made using a generator of a given size.

Parameters

Parameters Required? Description
EDO
Yes The number of divisions in the edo.
Periods
No (optional) The number of periods in the mos. Default is 1.
Temperament
No (optional) The name of any temperaments associated with this mos.
Generation Limit
No (optional) If set, this puts a maximum limit to the number of rows in the resulting table.
Step Visualization
No Unused.

Usage

For typical use, enter the edo and generator in edosteps as shown.

{{MOS in EDO
|EDO=12
|Generator=7}}
Generators 7\12 and 5\12
Step visualization MOS (name) Step sizes Step ratio
├──────┼────┤ 1L 1s 7, 5 7:5
├─┼────┼────┤ 2L 1s 5, 2 5:2
├─┼─┼──┼─┼──┤ 2L 3s 3, 2 3:2
├─┼─┼─┼┼─┼─┼┤ 5L 2s (diatonic) 2, 1 2:1
├┼┼┼┼┼┼┼┼┼┼┼┤ 12edo 1, 1 1:1

Multi-period mosses

To display the mosses for a multi-period mos, enter the number of periods as shown below. The number of periods must divide the number of divisions without a remainder. The default value is 1 period.

{{MOS in EDO
|EDO=12
|Generator=5
|Periods=2}}
Generators 5\12 and 1\12
Step visualization MOS (name) Step sizes Step ratio
├────┼┼────┼┤ 2L 2s 5, 1 5:1
├───┼┼┼───┼┼┤ 2L 4s (malic) 4, 1 4:1
├──┼┼┼┼──┼┼┼┤ 2L 6s (subaric) 3, 1 3:1
├─┼┼┼┼┼─┼┼┼┼┤ 2L 8s (jaric) 2, 1 2:1
├┼┼┼┼┼┼┼┼┼┼┼┤ 12edo 1, 1 1:1

Limiting the number of rows

For large edos and for some generators, the number of rows in the table can be quite large. A limit on the number of rows can be entered as shown. The default is -1, which is no limit.

{{MOS in EDO
|EDO=31
|Generator=1
|Generation Limit=10}}
Generators 1\31 and 30\31
Step visualization MOS (name) Step sizes Step ratio
├┼─────────────────────────────┤ 1L 1s 30, 1 30:1
├┼┼────────────────────────────┤ 1L 2s 29, 1 29:1
├┼┼┼───────────────────────────┤ 1L 3s 28, 1 28:1
├┼┼┼┼──────────────────────────┤ 1L 4s 27, 1 27:1
├┼┼┼┼┼─────────────────────────┤ 1L 5s (antimachinoid) 26, 1 26:1
├┼┼┼┼┼┼────────────────────────┤ 1L 6s (onyx) 25, 1 25:1
├┼┼┼┼┼┼┼───────────────────────┤ 1L 7s (antipine) 24, 1 24:1
├┼┼┼┼┼┼┼┼──────────────────────┤ 1L 8s (antisubneutralic) 23, 1 23:1
├┼┼┼┼┼┼┼┼┼─────────────────────┤ 1L 9s (antisinatonic) 22, 1 22:1
├┼┼┼┼┼┼┼┼┼┼────────────────────┤ 1L 10s 21, 1 21:1

Temperament names

To add a temperament name, add it as shown. Note that how this is displayed is still work-in-progress.

{{MOS in EDO
|EDO=12
|Generator=5
|Periods=2
|Temperament=pajara}}
Generators 5\12 and 1\12
Step visualization MOS (name) Step sizes Step ratio Temperament
├────┼┼────┼┤ 2L 2s 5, 1 5:1 pajara[4]
├───┼┼┼───┼┼┤ 2L 4s (malic) 4, 1 4:1 pajara[6]
├──┼┼┼┼──┼┼┼┤ 2L 6s (subaric) 3, 1 3:1 pajara[8]
├─┼┼┼┼┼─┼┼┼┼┤ 2L 8s (jaric) 2, 1 2:1 pajara[10]
├┼┼┼┼┼┼┼┼┼┼┼┤ 12edo 1, 1 1:1 pajara[12]