Template:MOS scalesig/doc: Difference between revisions

Latest revision as of 18:07, 19 May 2025

This template may be substituted.

This template uses 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.

{{{1}}} (required): The scale (in terms of L and s intervals, e.g. 5L 2s or 4L 5s<3/1> for non-octave scales), as an unnamed parameter. Less-than and greater-than signs are replaced with angle brackets (U+27E8 and U+27E9).

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

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

@@ 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. 4L&nbsp;5s&nbsp;(3/1-equivalent) rather than 4L&nbsp;5s⟨3/1⟩. 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>.