Template:MOS scalesig/doc: Difference between revisions

(5 intermediate revisions by 2 users not shown)

Line 1:

This template takes a MOS's scale signature and formats it with non-breaking spaces, with an option to link to its Wiki page.

== Parameters ==

=== Parameters ===

; <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 style="white-space: nowrap;"><nowiki>4L 5s<3/1></nowiki></code> for non-octave scales), as an unnamed parameter. Less-than and greater-than signs are replaced with angle brackets (U+27E8 and U+27E9).

; <code><nowiki>{{{long}}}</nowiki></code> (optional)

: 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.

: Whether to write out the equave in its long form, e.g. <code style="white-space: nowrap;">4L 5s (3/1-equivalent)</code> rather than <code style="white-space: nowrap;">4L 5s⟨3/1⟩</code>. Only applies to non-octave MOS scales.

; <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 <code style="white-space: nowrap;"><nowiki>{{MOS scalesig|4L 5s <3/1>}}</nowiki></code> is equivalent to <code style="white-space: nowrap;"><nowiki>[[4L 5s (3/1-equivalent) | 4L&nbsp;5s⟨3/1⟩]]</nowiki></code>.

@@ Line 1: / Line 1: @@
+{{dochead}}{{substitute|both}}{{clear}}{{lua}}
 This template takes a MOS's scale signature and formats it with non-breaking spaces, with an option to link to its Wiki page.
-== Parameters ==
+=== Parameters ===
 ; <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 style="white-space: nowrap;"><nowiki>4L 5s<3/1></nowiki></code> for non-octave scales), as an unnamed parameter. Less-than and greater-than signs are replaced with angle brackets (U+27E8 and U+27E9).
 ; <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 style="white-space: nowrap;">4L 5s (3/1-equivalent)</code> rather than <code style="white-space: nowrap;">4L 5s⟨3/1⟩</code>. Only applies to non-octave MOS scales.
 ; <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 <code style="white-space: nowrap;"><nowiki>{{MOS scalesig|4L&nbsp;5s&nbsp;<3/1>}}</nowiki></code> is equivalent to <code style="white-space: nowrap;"><nowiki>[[4L 5s (3/1-equivalent) | 4L&amp;nbsp;5s⟨3/1⟩]]</nowiki></code>.