Template:MOS tuning spectrum/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
params for (unusual) use-cases, for completeness
Ganaram inukshuk (talk | contribs)
m move todo to bottom
Line 11: Line 11:
; <code>Int Limit</code>
; <code>Int Limit</code>
: Changes search behavior to find ratios whose numerator or denominator do not exceed the int limit. If used, <code>Depth</code> is ignored.
: 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>
; <code>L/s</code>
Line 18: Line 17:
; <code>Initial Ratios</code>
; <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.
: 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.
{{Todo|inline=1| add documentation }}

Revision as of 02:53, 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 displays the tuning spectrum of a given MOS scale, showing various step ratios from 1:1 (equalised) to 1:0 (collapsed).

Parameters

Scale Signature
The scale (in terms of long and short intervals, e.g. 5L 2s).
Depth
The depth of the resulting scale tree.
Int Limit
Changes search behavior to find ratios whose numerator or denominator do not exceed the int limit. If used, Depth is ignored.
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.


Todo: add documentation