Template:MOS tuning spectrum/doc: Difference between revisions

@@ Line 1: / Line 1: @@
-{{dochead}}{{lua}}{{clear}}
+{{dochead}}
-{{todo|inline=1| Documentation }}
+This template displays the tuning spectrum of a given [[MOS scale]], showing various step ratios from 1:1 (equalised) to 1:0 (collapsed).
+=== Parameters ===
+; <code>Scale Signature</code>
+: The scale (in terms of long and short intervals, e.g. [[5L&nbsp;2s]]).
+; <code>Depth</code>
+: The depth of the resulting scale tree. Default depth is 5.
+; <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.
+; <code>L/s</code>
+: A comment for the step ratio L/s, written as <code>L/s</code>. Ratios not found within the search 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.
+{{Todo|inline=1| add documentation }}