Template:Infobox MOS/doc: Difference between revisions

← Older edit

VisualWikitext

@@ Line 1: / Line 1: @@
+{{dochead}}{{substitute|no}}{{lua}}
+The '''Infobox MOS''' template was built to help presenting basic information about [[MOS]] patterns (such as [[5L 2s]]) in a unified form, to make them obvious by glance.{{clear}}
-The templates supports the following parameters:
+=== Parameters ===
+The template supports the following parameters:
-{| class="wikitable"
+{| class="wikitable" style="margin-right: 25%;"
-! width="15%" | Parameter
+|-
-! width="85%" | Meaning, usage notes
+! Parameter
+! Meaning and usage notes
 |-
-| Name (optional)
+| Scale Signature
-| The [[TAMNAMS]] name
+| The MOS pattern; if a division of a non-octave JI ratio m/n, the tuning should be written in the form "aL bs (m/n-equivalent)" or "<nowiki>aL bs<m/n></nowiki>". If this parameter is left blank, the template will attempt to parse the page title as a mos pattern.
 |-
 | Other names (optional)
 | Other common names
 |-
-| Periods (''deprecated'')
+| Neutral (''unsupported'')
-| Number of periods per equave
+| The [[neutralization|neutralized]] MOS structure.
-|-
-| nLargeSteps (''deprecated'')
-| Number of large steps
-|-
-| nSmallSteps (''deprecated'')
-| Number of small steps
-|-
-| Equave (''deprecated'')
-| The equivalence interval
-|-
-| Equalized
-| [[Chroma-positive]] generator of the mos pattern for the equalized (s = L) equal tuning, in steps of ed(Equave)
-|-
-| Collapsed
-| [[Chroma-positive]] generator of the mos pattern for the collapsed (s = 0) equal tuning, in steps of ed(Equave)
-|-
-| Pattern
-| Step pattern of the brightest mode of the mos in L's and s's.
-|-
-| Neutral (''deprecated'')
-| The [[neutralization|neutralized]] mos structure.
 |-
-| Neutral range (''deprecated'')
+| Neutral range (''unsupported'')
-| The generator range for the neutralized mos structure, assuming the neutralized mos was obtained from the current mos pattern.
+| The generator range for the neutralized MOS structure, assuming the neutralized mos was obtained from the current mos pattern.
 |}
-Usage example for [[5L 3s]]:
+=== Usage examples ===
-<code><nowiki>
+{{{{ROOTPAGENAME}}|Scale Signature=5L 2s|nocat=1}}
- {{Infobox MOS
+For a regular MOS page:
- | Pattern = LLsLLsLs
- | Equalized = 3
+<pre>{{Infobox MOS}}</pre>
- | Collapsed = 2
- }}
+Specifying a specific MOS from an unrelated page:
-</nowiki></code>
-{{Infobox MOS
+<pre>{{Infobox MOS|Scale Signature=scalesig|debug=1}}</pre>
-| Tuning = 5L 3s
-| Equalized = 3
+'''Note:''' Passing <code>debug=1</code> will disable categories.
-| Collapsed = 2
-}}
+=== See also ===
-{{Infobox MOS
+* [[Template:Infobox ET]]
-| Tuning = 4L 2s (fifth-equivalent)
+{{clear}}
-| Pattern = LLsLLs
-| Equalized = 2
-| Collapsed = 1
-}}