Template:MOS in EDO: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
Added rest of documentation; removed todo
ArrowHead294 (talk | contribs)
No edit summary
Line 1: Line 1:
<includeonly>{{#invoke:MOS_in_EDO|mos_in_edo_frame
<includeonly>{{#invoke:MOS in EDO|mos_in_edo_frame
|EDO={{{EDO|}}}
| EDO={{{EDO|}}}
|Generator={{{Generator|}}}
| Generator={{{Generator|}}}
|Periods={{{Periods|}}}
| Periods={{{Periods|}}}
|Temperament={{{Temperament|}}}
| Temperament={{{Temperament|}}}
|Step Visualization={{{Step Visualization|}}}
| Step Visualization={{{Step Visualization|}}}
|Generation Limit={{{Generation Limit|}}}
| Generation Limit={{{Generation Limit|}}}
}}</includeonly><noinclude>
}}</includeonly><noinclude>
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 ==
 
{| class="wikitable"
{{doc}}
|-
! 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.
|-
| <pre>Step Visualization</pre> || No || Unused.
|}
== 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. The default value is 1 period.
<pre>{{MOS in EDO
|EDO=12
|Generator=5
|Periods=2}}</pre>
{{MOS in EDO
|EDO=12
|Generator=5
|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]]
</noinclude>
</noinclude>

Revision as of 18:23, 20 May 2024

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

Template:Doc