Template:MOS in EDO: Difference between revisions

Revision as of 03:37, 17 December 2023

Todo: add documentation

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.

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.

{{MOS in EDO
|EDO=12
|Generator=5
|Periods=}}

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

@@ Line 2: / Line 2: @@
 |EDO={{{EDO|}}}
 |Generator={{{Generator|}}}
-|Number of Periods={{{Number of Periods|}}}
+|Periods={{{Periods|}}}
 |Temperament={{{Temperament|}}}
 |Step Visualization={{{Step Visualization|}}}
@@ Line 8: / Line 8: @@
 }}</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.
-<pre>{{MOS in EDO|EDO=12|Generator=7}}</pre>
+== Parameters ==
-{{MOS in EDO|EDO=12|Generator=7}}
+{| class="wikitable"
+|-
+! Parameters !! Required? !! Description
+|-
+| <pre>EDO</pre> || Yes || The number of divisions in the edo.
+|-
+| <pre>Periods</pre> || No (optional) || The number of periods in the mos. Default is 1.
+|-
+| <pre>Temperament</pre> || No (optional) || The name of any temperaments associated with this mos.
+|-
+| <pre>Generation Limit</pre> || No (optional) || If set, this puts a maximum limit to the number of rows in the resulting table.
+|}
+== Usage ==
+For typical use, enter the edo and generator in edosteps as shown.
+<pre>{{MOS in EDO
+|EDO=12
+|Generator=7}}</pre>
+{{MOS in EDO
+|EDO=12
+|Generator=7}}
+=== 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.
+<pre>{{MOS in EDO
+|EDO=12
+|Generator=5
+|Periods=}}</pre>
+{{MOS in EDO
+|EDO=12
+|Generator=5
+|Periods=2}}
 [[Category:Templates]]
 </noinclude>