Module:MOS scalesig/doc: Difference between revisions

@@ Line 1: / Line 1: @@
 {{documentation|
-{{dochead}}
+{{dochead}}{{lua|Arguments|MOS|utils|Yesno}}
-This module format a string into a mos scale signature, with non-breaking spaces.
+<p>This module formats a string into a mos scale signature, with non-breaking spaces. Scale signatures can optionally be formatted as a link to the scale's wiki page.</p>
-=== Options ===
+To include this module in other modules, use <syntaxhighlight inline lang="lua">local mos_scalesig = require("Module:MOS scalesig")._mos_scalesig</syntaxhighlight>.{{clear}}
-; <code>is_long</code>
-: Whether to use "xL&nbsp;ys&lt;p/q&gt;" or "xL&nbsp;ys&nbsp;(p/q-equivalent)". Only applies for nonoctave mosses, as a scalesig without an equave is assumed to be 2/1-equivalent.
-; <code>is_link</code>
-: Whether the scalesig is a link to its wiki page.
 }}