Template:Infobox MOS/doc: Difference between revisions

(11 intermediate revisions by 2 users not shown)

Line 1:

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}}

=== 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

|-

| ~~Tuning (optional)~~

| Scale Signature

| 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.

| 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)

Line 13:

Line 16:

|-

| Neutral (''unsupported'')

| The [[neutralization|neutralized]] ~~mos~~ structure.

| The [[neutralization|neutralized]] MOS structure.

|-

| 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 examples ===

{{{{ROOTPAGENAME}}|~~Tuning~~=5L 2s|~~debug~~=1}}

{{{{ROOTPAGENAME}}|Scale Signature=5L 2s|nocat=1}}

For a regular MOS page:

<~~code~~>{{~~((}}~~Infobox MOS~~{{))~~}}</~~code~~>

<pre>{{Infobox MOS}}</pre>

Specifying a specific MOS from an unrelated page:

<~~code~~>{{~~((}}~~Infobox MOS~~{{!}}Tuning{{~~=~~}}tuning{{!}}~~debug{{=}}1~~{{))~~}}</~~code~~>

<pre>{{Infobox MOS|Scale Signature=scalesig|debug=1}}</pre>

'''Note:''' Passing <code>debug{{=}}1</code> will disable categories.

'''Note:''' Passing <code>debug=1</code> will disable categories.

=== See also ===

* {{modlink}}

* [[Template:Infobox ET]]

@@ Line 1: / Line 1: @@
-{{dochead}}
+{{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}}
 === 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
 |-
-| Tuning (optional)
+| Scale Signature
-| 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.
+| 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)
@@ Line 13: / Line 16: @@
 |-
 | Neutral (''unsupported'')
-| The [[neutralization|neutralized]] mos structure.
+| The [[neutralization|neutralized]] MOS structure.
 |-
 | 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 examples ===
-{{{{ROOTPAGENAME}}|Tuning=5L 2s|debug=1}}
+{{{{ROOTPAGENAME}}|Scale Signature=5L 2s|nocat=1}}
 For a regular MOS page:
-<code>{{((}}Infobox MOS{{))}}</code>
+<pre>{{Infobox MOS}}</pre>
 Specifying a specific MOS from an unrelated page:
-<code>{{((}}Infobox MOS{{!}}Tuning{{=}}tuning{{!}}debug{{=}}1{{))}}</code>
+<pre>{{Infobox MOS|Scale Signature=scalesig|debug=1}}</pre>
-'''Note:''' Passing <code>debug{{=}}1</code> will disable categories.
+'''Note:''' Passing <code>debug=1</code> will disable categories.
 === See also ===
-* {{modlink}}
 * [[Template:Infobox ET]]
+{{clear}}