Template:MOS tuning spectrum/doc: Difference between revisions

Revision as of 02:52, 5 October 2025

This template is implemented by the Lua module Module:MOS tuning spectrum.

This template invokes the following functions: mos_tuning_spectrum from MOS tuning spectrum.

This template has been deprecated. Its replacements are Template:Dochead and Template:Module introspection.

This template uses Lua:

This template displays the tuning spectrum of a given MOS scale, showing various step ratios from 1:1 (equalised) to 1:0 (collapsed).

Scale Signature: The scale (in terms of long and short intervals, e.g. 5L 2s).

Int Limit: Changes search behavior to find ratios whose numerator or denominator do not exceed the int limit. If used, Depth is ignored.

Todo: add documentation

L/s: A comment for the step ratio L/s step ratio, written as | L/s = . Note that comments for step ratios "outside" the depth or int limit are currently not displayed.

Initial Ratios: A list of ratios from which mediants are successively found. Ratios are denoted as L/s, and individual ratios are separated using semicolons. Ratios entered this way are automatically sorted in ascending order. If not used, mediants between 1:1 and 1:0, or 1/1; 1/0, are found.

@@ Line 9: / Line 9: @@
 : The depth of the resulting scale tree.
-; <code>X/Y</code>
+; <code>Int Limit</code>
-: Pass in a L/s step ratio as <code>{{!}}&nbsp;X/Y&nbsp;=&nbsp;</code> to add a comment for the scale with the step ratio of X/Y. Comments for step ratios "outside" the depth of the scale tree are currently not displayed.
+: Changes search behavior to find ratios whose numerator or denominator do not exceed the int limit. If used, <code>Depth</code> is ignored.
 {{Todo|inline=1| add documentation }}
+; <code>L/s</code>
+: A comment for the step ratio L/s step ratio, written as <code>{{!}}&nbsp;L/s&nbsp;=&nbsp;</code>. Note that comments for step ratios "outside" the depth or int limit are currently not displayed.
+; <code>Initial Ratios</code>
+: A list of ratios from which mediants are successively found. Ratios are denoted as <code>L/s</code>, and individual ratios are separated using semicolons. Ratios entered this way are automatically sorted in ascending order. If not used, mediants between 1:1 and 1:0, or <code>1/1;&nbsp;1/0</code>, are found.