Template:Infobox regtemp/doc: Difference between revisions

(10 intermediate revisions by 3 users not shown)

Line 1:

Infobox for regular ~~temperaments~~. As of now, most information has to be entered manually.

Infobox for [[regular temperament]]s. Support up to rank 4. As of now, most information has to be entered manually.

== Parameters ==

Line 10:

; Comma basis

: Type the simplest list of commas that defines the temperament in the subgroup(s). Format as:

: <code>comma 1, comma 2, … (subgroup 1); <nowiki><br></nowiki>comma 1, comma 2, (subgroup 2), …</code>

: <code>comma 1, comma 2, … (subgroup 1); <nowiki><br></nowiki>comma 1, comma 2, (subgroup 2); …</code>

; Edo join 1

; Edo join 1, 2, 3, 4

: The ~~smallest edo (or~~ equal ~~division of another interval)~~ that reasonably [[support]]s the temperament. ~~Only type the number, not~~ "edo" ~~or any extra text.~~

: The [[equal temperament]]s that reasonably [[support]] the temperament. Despite these parameters being called "edo", they accept [[wart notation]] just fine.

~~; Edo join 2~~

~~: The second smallest edo that reasonably supports the temperament~~.

; Mapping

: The number of generators each element of the subgroup is mapped to; see [[~~reduced~~ mapping]].

: The number of generators each element of the subgroup is mapped to; see [[Reduced mapping]].

; ~~Generator~~

; Generators

: The ~~interval~~ that generates the temperament, in [[ratio]] of [[monzo]] form.

: The list of intervals that generates the temperament, in [[ratio]] of [[monzo]] form.

; ~~Generator~~ tuning

; Generators tuning

: ~~Size~~ of the ~~generator~~ in an optimal tuning, in [[cent]]s.

: Sizes of the generators in an optimal tuning, in [[cent]]s.

; Optimization method

: The method used to calculate the optimal tuning above. Type the acronym, such as CWE or POTE.

; MOS scales

: For rank-2 temperaments, the sequence of [[mos scale]]s induced by the generator.

; Ploidacot

: Derived from '''~~Subgroup~~''', '''Mapping''', and '''~~Generator~~ tuning''', or overriden here.

: For rank-2 temperaments, the [[ploidacot]] signature. Derived from '''Subgroups''', '''Mapping''', and '''Generators tuning''', or overriden here.

; Pergen

: The period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth).

: The period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth), if provided.

; Color name

: ~~The~~ [[color name]] of the ~~comma tempered out~~.

: [[Kite's color notation/Temperament names|Kite's color name]] for the temperament, if provided.

; Odd limit 1, 2, 3, 4

~~{{Todo~~|~~inline=~~1| ~~add documentation |comment = Explain~~ the ~~remaining arguments~~.}}

: Reasonable odd limits to use in the temperament.

; Mistuning 1, 2, 3, 4

: [[Minimax|Minimax errors]] of the odd limits.

; Complexity 1, 2, 3, 4

: Smallest numbers of notes for mos scales to contain the odd limits (i.e. greater than the [[Graham complexity|Graham complexities]] of the odd limits).

=== Boilerplate ===

Line 36:

Line 40:

<pre>

{{Infobox regtemp

| Title =

| ~~Subgroup~~ =

| Subgroups =

| Comma basis =

| Edo join 1 = | Edo join 2 =

| Edo join 1 = | Edo join 2 = | Edo join 3 = | Edo join 4 =

| Mapping =

| ~~Generator~~ =

| Generators =

| ~~Generator~~ tuning =

| Generators tuning =

| Optimization method =

| MOS scales =

Line 50:

Line 55:

| Odd limit 1 = | Mistuning 1 = | Complexity 1 =

| Odd limit 2 = | Mistuning 2 = | Complexity 2 =

| Odd limit 3 = | Mistuning 3 = | Complexity 3 =

| Odd limit 4 = | Mistuning 4 = | Complexity 4 =

}}

</pre>

@@ Line 1: / Line 1: @@
-{{Dochead}}
+{{Dochead}}{{substitute|no}}
-{{Template rating}}
+{{Template rating|rating=ready}}
-Infobox for regular temperaments. As of now, most information has to be entered manually.
+Infobox for [[regular temperament]]s. Support up to rank 4. As of now, most information has to be entered manually.
 == Parameters ==
@@ Line 10: / Line 10: @@
 ; Comma basis
 : Type the simplest list of commas that defines the temperament in the subgroup(s). Format as:
-: <code>comma 1, comma 2, … (subgroup 1); <nowiki><br></nowiki>comma 1, comma 2, (subgroup 2), …</code>
+: <code>comma 1, comma 2, … (subgroup 1); <nowiki><br></nowiki>comma 1, comma 2, (subgroup 2); …</code>
-; Edo join 1
+; Edo join 1, 2, 3, 4
-: The smallest edo (or equal division of another interval) that reasonably [[support]]s the temperament. Only type the number, not "edo" or any extra text.
+: The [[equal temperament]]s that reasonably [[support]] the temperament. Despite these parameters being called "edo", they accept [[wart notation]] just fine.
-; Edo join 2
-: The second smallest edo that reasonably supports the temperament.
 ; Mapping
-: The number of generators each element of the subgroup is mapped to; see [[reduced mapping]].
+: The number of generators each element of the subgroup is mapped to; see [[Reduced mapping]].
-; Generator
+; Generators
-: The interval that generates the temperament, in [[ratio]] of [[monzo]] form.
+: The list of intervals that generates the temperament, in [[ratio]] of [[monzo]] form.
-; Generator tuning
+; Generators tuning
-: Size of the generator in an optimal tuning, in [[cent]]s.
+: Sizes of the generators in an optimal tuning, in [[cent]]s.
 ; Optimization method
 : The method used to calculate the optimal tuning above. Type the acronym, such as CWE or POTE.
+; MOS scales
+: For rank-2 temperaments, the sequence of [[mos scale]]s induced by the generator.
 ; Ploidacot
-: Derived from '''Subgroup''', '''Mapping''', and '''Generator tuning''', or overriden here.
+: For rank-2 temperaments, the [[ploidacot]] signature. Derived from '''Subgroups''', '''Mapping''', and '''Generators tuning''', or overriden here.
 ; Pergen
-: The period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth).
+: The period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth), if provided.
 ; Color name
-: The [[color name]] of the comma tempered out.
+: [[Kite's color notation/Temperament names|Kite's color name]] for the temperament, if provided.
+; Odd limit 1, 2, 3, 4
-{{Todo|inline=1| add documentation |comment = Explain the remaining arguments.}}
+: Reasonable odd limits to use in the temperament.
+; Mistuning 1, 2, 3, 4
+: [[Minimax|Minimax errors]] of the odd limits.
+; Complexity 1, 2, 3, 4
+: Smallest numbers of notes for mos scales to contain the odd limits (i.e. greater than the [[Graham complexity|Graham complexities]] of the odd limits).
 === Boilerplate ===
@@ Line 36: / Line 40: @@
 <pre>
+{{Infobox regtemp
 | Title =
-| Subgroup =
+| Subgroups =
 | Comma basis =
-| Edo join 1 =  | Edo join 2 =
+| Edo join 1 =  | Edo join 2 =  | Edo join 3 =  | Edo join 4 =
 | Mapping =
-| Generator =
+| Generators =
-| Generator tuning =
+| Generators tuning =
 | Optimization method =
 | MOS scales =
@@ Line 50: / Line 55: @@
 | Odd limit 1 =  | Mistuning 1 =  | Complexity 1 =
 | Odd limit 2 =  | Mistuning 2 =  | Complexity 2 =
+| Odd limit 3 =  | Mistuning 3 =  | Complexity 3 =
+| Odd limit 4 =  | Mistuning 4 =  | Complexity 4 =
 }}
 </pre>