Template:MOS scalesig/doc: Difference between revisions

Revision as of 19:22, 6 March 2025

This template is implemented by the Lua module Module:MOS scalesig.

This template invokes the following functions: mos_scalesig from MOS scalesig.

This template has been deprecated. Its replacements are Template:Dochead and Template:Module introspection.

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. Angle brackets 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 typing {{MOS scalesig|4L 5s <3/1>}} is equivalent to typing [[4L 5s (3/1-equivalent) | 4L 5s⟨3/1⟩]].

@@ Line 1: / Line 1: @@
+{{dochead}}{{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 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.