Template:MOS scalesig/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
No edit summary
Ganaram inukshuk (talk | contribs)
No edit summary
Line 3: Line 3:
== Parameters ==
== Parameters ==
; <code><nowiki>{{{1}}}</nowiki></code> (required)
; <code><nowiki>{{{1}}}</nowiki></code> (required)
: The scale (in terms of L and s intervals, e.g. <code>5L&nbsp;2s</code>), as an unnamed parameter.
: The scale (in terms of L and s intervals, e.g. <code>5L 2s</code> or <code>4L 5s<3/1></code> for non-octave scales), as an unnamed parameter. Angle brackets are replaced with angle brackets U+27E8 and U+27E9.


; <code><nowiki>{{{long}}}</nowiki></code> (optional)
; <code><nowiki>{{{long}}}</nowiki></code> (optional)
: Whether to write out the equave in its long form, e.g. <code>4L&nbsp;5s&nbsp;(3/1-equivalent)</code> rather than <code>4L&nbsp;5s⟨3/1⟩</code>. Only applies to non-octave MOS scales.
: Whether to write out the equave in its long form, e.g. <code>4L 5s (3/1-equivalent)</code> rather than <code>4L 5s⟨3/1⟩</code>. Only applies to non-octave MOS scales.


; <code><nowiki>{{{link}}}</nowiki></code> (optional)
; <code><nowiki>{{{link}}}</nowiki></code> (optional)
: Whether to link to the scale's wiki page.
: Whether to link to the scale's wiki page, where typing <code><nowiki>{{MOS scalesig|4L 5s <3/1>}}</nowiki></code> is equivalent to typing <code><nowiki>[[4L 5s (3/1-equivalent) | 4L&amp;nbsp;5s⟨3/1⟩]]</nowiki></code>.