Template:MOS tuning spectrum/doc - Revision history

Overthink: + default depth note

2025-10-31T15:56:06Z

+ default depth note

← Older revision		Revision as of 15:56, 31 October 2025
Line 7:		Line 7:

	; <code>Depth</code>		; <code>Depth</code>
	: The depth of the resulting scale tree.		: The depth of the resulting scale tree. Default depth is 5.

	; <code>Int Limit</code>		; <code>Int Limit</code>

2025-10-31T06:34:23Z

← Older revision		Revision as of 06:34, 31 October 2025
Line 1:		Line 1:
	{{dochead~~}}{{lua~~}}		{{dochead}}
	This template displays the tuning spectrum of a given [[MOS scale]], showing various step ratios from 1:1 (equalised) to 1:0 (collapsed).		This template displays the tuning spectrum of a given [[MOS scale]], showing various step ratios from 1:1 (equalised) to 1:0 (collapsed).

2025-10-05T03:32:42Z

wording

← Older revision		Revision as of 03:32, 5 October 2025
Line 13:		Line 13:

	; <code>L/s</code>		; <code>L/s</code>
	: A comment for the step ratio L/s ~~step ratio~~, written as <code>~~{{!}} ~~L/s~~ = ~~</code>. ~~Note that comments for step ratios "outside"~~ the depth or int limit are currently not displayed.		: 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>		; <code>Initial Ratios</code>

2025-10-05T02:53:16Z

move todo to bottom

← Older revision		Revision as of 02:53, 5 October 2025
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; 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; 1/0</code>, are found.


			{{Todo\|inline=1\| add documentation }}

2025-10-05T02:52:58Z

params for (unusual) use-cases, for completeness

← Older revision		Revision as of 02:52, 5 October 2025
Line 9:		Line 9:
	: The depth of the resulting scale tree.		: The depth of the resulting scale tree.

	; <code>~~X/Y~~</code>		; <code>Int Limit</code>
	: ~~Pass in a L/s step ratio as~~ <code>~~{{!}} X/Y = ~~</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 }}		{{Todo\|inline=1\| add documentation }}

			; <code>L/s</code>
			: A comment for the step ratio L/s step ratio, written as <code>{{!}} L/s = </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; 1/0</code>, are found.

2025-06-23T00:06:00Z

← Older revision		Revision as of 00:06, 23 June 2025
Line 10:		Line 10:

	; <code>X/Y</code>		; <code>X/Y</code>
	: Pass in a L/s step ratio as <code>{{!}} X/Y = </code> to add a comment for the scale with the step ratio of X/Y. Comments for step ~~ratio~~ "outside" the depth of the scale tree are currently not displayed.		: Pass in a L/s step ratio as <code>{{!}} X/Y = </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.
	{{Todo\|inline=1\| add documentation }}		{{Todo\|inline=1\| add documentation }}

2025-06-23T00:05:44Z

← Older revision		Revision as of 00:05, 23 June 2025
Line 10:		Line 10:

	; <code>X/Y</code>		; <code>X/Y</code>
	: Pass in a L/s step ratio as <code>{{!}} X/Y = </code> to add a comment for the scale with the step ratio of X/Y.		: Pass in a L/s step ratio as <code>{{!}} X/Y = </code> to add a comment for the scale with the step ratio of X/Y. Comments for step ratio "outside" the depth of the scale tree are currently not displayed.
	{{Todo\|inline=1\| add documentation }}		{{Todo\|inline=1\| add documentation }}

2025-05-19T13:32:55Z

Update documentation

← Older revision		Revision as of 13:32, 19 May 2025
Line 1:		Line 1:
	{{dochead}}{{lua}}{{~~clear~~}}		{{dochead}}{{lua}}
			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 2s]]).

			; <code>Depth</code>
			: The depth of the resulting scale tree.

			; <code>X/Y</code>
			: Pass in a L/s step ratio as <code>{{!}} X/Y = </code> to add a comment for the scale with the step ratio of X/Y.
	{{Todo\|inline=1\| add documentation }}		{{Todo\|inline=1\| add documentation }}

2025-04-28T15:00:19Z

Text replacement - "{{todo|inline=1| Documentation }}" to "{{Todo|inline=1| add documentation }}"

← Older revision		Revision as of 15:00, 28 April 2025
Line 1:		Line 1:
	{{dochead}}{{lua}}{{clear}}		{{dochead}}{{lua}}{{clear}}
	{{~~todo~~\|inline=1\| ~~Documentation~~ }}		{{Todo\|inline=1\| add documentation }}

2025-02-28T03:47:49Z