Template:MOS intervals/doc: Difference between revisions

(11 intermediate revisions by 2 users not shown)

Line 1:

== Parameters ==

This template creates a table of a [[MOS scale]]'s intervals and their relative qualities.

=== Parameters ===

The following parameters are supported:

{| class="wikitable"

|-

! Parameter !! Required? !! Description

! Parameter

! Required?

! Description

|-

| <pre>Scale Signature</pre> || Yes (optional on mos pages) || The mos's scale signature in the form "xL ys", or for non-octave mosses, <nowiki>"xL ys<p/q>"</nowiki>, "xL ys⟨p/q⟩", or "xL ys (p/q-equivalent)". If left blank and used on a mos page, then the page's title will be used.

|-

| <pre>MOS Prefix</pre> || No (optional) || The prefix for the mos, if it has one. The scale's TAMNAMS prefix will be used if left blank; otherwise, it will default to "mos".

|-

| <pre>MOS Abbrev</pre> || No (optional) || The abbreviation for the mos, if it has one. The scale's TAMNAMS abbreviation will be used if left blank; otherwise, it will default to "m".

|-

| <pre>Interval Notation</pre> || Deprecated || The scheme for naming intervals. Options include TAMNAMS mosstep naming and ordinal naming (EG, the unison is either called the 0-mosstep or 1st).

|-

~~| <pre>MOS Prefix</pre>|| No (optional) || The TAMNAMS prefix for the mos, if it has one. The default is "mos".~~

|}

Line 22:

Line 29:

==== Changing the mos prefix ====

==== Changing the mos prefix and abbreviation ====

By default, the mos prefix is "mos". The prefix for the mos can be changed as shown below.

<pre>{{MOS intervals|Scale Signature=2L 5s|MOS Prefix=pel}}</pre>

<pre>{{MOS intervals|Scale Signature=2L 5s|MOS Prefix=pel|MOS Abbrev=pel}}</pre>

{{MOS intervals|Scale Signature=2L 5s|MOS Prefix=pel|MOS Abbrev=pel}}

=== See also ===

* [[~~Module~~:MOS ~~intervals~~]] ~~–~~ The ~~corresponding Lua module~~ that ~~implements the functionality~~.

* [[Template:MOS degrees]] – The template that shows a MOS's cent values for a step ratio.

* [[Template:MOS interval HE]] – A similar template for displaying each interval's [[harmonic entropy]].

@@ Line 1: / Line 1: @@
-{{dochead}}
+{{dochead}}{{lua}}
-== Parameters ==
+This template creates a table of a [[MOS scale]]'s intervals and their relative qualities.
+=== Parameters ===
+The following parameters are supported:
 {| class="wikitable"
 |-
-! Parameter !! Required? !! Description
+! Parameter
+! Required?
+! Description
 |-
 | <pre>Scale Signature</pre> || Yes (optional on mos pages) || The mos's scale signature in the form "xL ys", or for non-octave mosses, <nowiki>"xL ys<p/q>"</nowiki>, "xL ys⟨p/q⟩", or "xL ys (p/q-equivalent)". If left blank and used on a mos page, then the page's title will be used.
+|-
+| <pre>MOS Prefix</pre> || No (optional) || The prefix for the mos, if it has one. The scale's TAMNAMS prefix will be used if left blank; otherwise, it will default to "mos".
+|-
+| <pre>MOS Abbrev</pre> || No (optional) || The abbreviation for the mos, if it has one. The scale's TAMNAMS abbreviation will be used if left blank; otherwise, it will default to "m".
 |-
 | <pre>Interval Notation</pre> || Deprecated || The scheme for naming intervals. Options include TAMNAMS mosstep naming and ordinal naming (EG, the unison is either called the 0-mosstep or 1st).
-|-
-| <pre>MOS Prefix</pre>|| No (optional) || The TAMNAMS prefix for the mos, if it has one. The default is "mos".
 |}
@@ Line 22: / Line 29: @@
 {{MOS intervals|Scale Signature=5L 2s}}
-==== Changing the mos prefix ====
+==== Changing the mos prefix and abbreviation ====
 By default, the mos prefix is "mos". The prefix for the mos can be changed as shown below.
-<pre>{{MOS intervals|Scale Signature=2L 5s|MOS Prefix=pel}}</pre>
+<pre>{{MOS intervals|Scale Signature=2L 5s|MOS Prefix=pel|MOS Abbrev=pel}}</pre>
-{{MOS intervals|Scale Signature=2L 5s|MOS Prefix=pel}}
+{{MOS intervals|Scale Signature=2L 5s|MOS Prefix=pel|MOS Abbrev=pel}}
 === See also ===
-* [[Module:MOS intervals]] &ndash; The corresponding Lua module that implements the functionality.
+* [[Template:MOS degrees]] – The template that shows a MOS's cent values for a step ratio.
+* [[Template:MOS interval HE]] – A similar template for displaying each interval's [[harmonic entropy]].