Template:MOS in EDO/doc: Difference between revisions
ArrowHead294 (talk | contribs) Documentation page |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{dochead}} | {{dochead}}{{lua}} | ||
== Parameters == | This template displays all MOS scales in a given EDO with a particular generator and number of periods per octave. | ||
=== Parameters === | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Parameters !! Required? !! Description | ! Parameters !! Required? !! Description | ||
|- | |- | ||
| < | | <code>EDO</code> || Yes || The number of divisions in the edo. | ||
|- | |- | ||
| < | | <code>Periods</code> || No (optional) || The number of periods in the mos. Default is 1. | ||
|- | |- | ||
| < | | <code>Temperament</code> || No (optional) || The name of any temperaments associated with this mos. | ||
|- | |- | ||
| < | | <code>Generation Limit</code> || No (optional) || If set, this puts a maximum limit to the number of rows in the resulting table. | ||
|- | |- | ||
| < | | <code>Step Visualization</code> || No || Unused. | ||
|} | |} | ||
== Usage == | |||
=== Usage === | |||
For typical use, enter the edo and generator in edosteps as shown. | For typical use, enter the edo and generator in edosteps as shown. | ||
<pre>{{MOS in EDO | <pre>{{MOS in EDO | ||
| Line 21: | Line 24: | ||
| Generator=7 | | Generator=7 | ||
}}</pre> | }}</pre> | ||
{{ | {{{{ROOTPAGENAME}} | ||
| EDO=12 | | EDO=12 | ||
| 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. The default value is 1 period. | 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 | ||
| Line 32: | Line 36: | ||
| Periods=2 | | Periods=2 | ||
}}</pre> | }}</pre> | ||
{{ | {{{{ROOTPAGENAME}} | ||
| EDO=12 | | EDO=12 | ||
| Generator=5 | | Generator=5 | ||
| Periods=2 | | Periods=2 | ||
}} | }} | ||
=== Limiting the number of rows === | |||
==== 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. | 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 | <pre>{{MOS in EDO | ||
| Line 44: | Line 49: | ||
| Generation Limit=10 | | Generation Limit=10 | ||
}}</pre> | }}</pre> | ||
{{ | {{{{ROOTPAGENAME}} | ||
| EDO=31 | | EDO=31 | ||
| Generator=1 | | Generator=1 | ||
| Generation Limit=10 | | Generation Limit=10 | ||
}} | }} | ||
=== Temperament names === | |||
==== Temperament names ==== | |||
To add a temperament name, add it as shown. Note that how this is displayed is still work-in-progress. | To add a temperament name, add it as shown. Note that how this is displayed is still work-in-progress. | ||
<pre>{{MOS in EDO | <pre>{{MOS in EDO | ||
| Line 57: | Line 63: | ||
| Temperament=pajara | | Temperament=pajara | ||
}}</pre> | }}</pre> | ||
{{ | {{{{ROOTPAGENAME}} | ||
| EDO=12 | | EDO=12 | ||
| Generator=5 | | Generator=5 | ||
| Line 63: | Line 69: | ||
| Temperament=pajara | | Temperament=pajara | ||
}} | }} | ||