Template:MOS in EDO: Difference between revisions
Simplified args, added (some) documentation |
Added rest of documentation; removed todo |
||
| Line 7: | Line 7: | ||
|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 == | == 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> | ||