Template:Infobox regtemp/doc: Difference between revisions

(16 intermediate revisions by 4 users not shown)

Line 1:

Infobox for regular ~~temperaments~~. ~~Most~~ information has to be entered manually~~, though this is a first draft of such an infobox~~.

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

== Parameters ==

~~===~~ Title ~~===~~

; Title

The name of the temperament goes here, and it appears as the title of the infobox.

: The name of the temperament goes here, and it appears as the title of the infobox.

~~===~~ Subgroups ~~===~~

; Subgroups

Written here is the subgroup(s) that the temperament acts on; often a full prime limit.

: Written here is the [[just intonation subgroup|subgroup(s)]] that the temperament acts on; often a full prime limit.

~~===~~ Comma basis ~~===~~

; Comma basis

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

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

~~=== Generator ===~~

; Edo join 1, 2, 3, 4

The ~~interval~~ that ~~generates~~ the temperament.

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

~~===~~ Mapping ~~===~~

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

~~===~~ Pergen ~~===~~

; Generators

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

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

~~===~~ Color name ~~===~~

; Generators tuning

~~This is the~~ color name of the ~~comma tempered out~~.

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

~~=== Edo join~~ 1 ~~===~~

; Optimization method

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

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

~~=== Edo join~~ 2 ~~===~~

; MOS scales

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

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

=== ~~Optimization method~~ ===

; Ploidacot

~~The method used~~ to ~~calculate the optimal tuning. Type all capital letters, such as CWE or POTE.~~

: 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), if provided.

; Color name

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

; Odd limit 1, 2, 3, 4

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

Empty template for copy & paste to avoid copying wrong values from existing temperament pages:

{{~~clear}}~~

<pre>

~~{{Todo~~|~~inline~~=1| ~~complete and rectify documentation~~ }}

{{Infobox regtemp

| Title =

| Subgroups =

| Comma basis =

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

| Mapping =

| Generators =

| Generators tuning =

| Optimization method =

| MOS scales =

| Ploidacot =

| Pergen =

| Color name =

| 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}}{{lua}}
+{{Dochead}}{{substitute|no}}
-Infobox for regular temperaments. Most information has to be entered manually, though this is a first draft of such an infobox.
+{{Template rating|rating=ready}}
+Infobox for [[regular temperament]]s. Support up to rank 4. As of now, most information has to be entered manually.
 == Parameters ==
-=== Title ===
+; Title
-The name of the temperament goes here, and it appears as the title of the infobox.
+: The name of the temperament goes here, and it appears as the title of the infobox.
-=== Subgroups ===
+; Subgroups
-Written here is the subgroup(s) that the temperament acts on; often a full prime limit.
+: Written here is the [[just intonation subgroup|subgroup(s)]] that the temperament acts on; often a full prime limit.
-=== Comma basis ===
+; Comma basis
-Type the simplest list of commas that defines the temperament in the subgroup(s). Format as:
+: 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>
-=== Generator ===
+; Edo join 1, 2, 3, 4
-The interval that generates the temperament.
+: The [[equal temperament]]s that reasonably [[support]] the temperament. Despite these parameters being called "edo", they accept [[wart notation]] just fine.
-=== Mapping ===
+; 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]].
-=== Pergen ===
+; Generators
-This is the period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth).
+: The list of intervals that generates the temperament, in [[ratio]] of [[monzo]] form.
-=== Color name ===
+; Generators tuning
-This is the color name of the comma tempered out.
+: Sizes of the generators in an optimal tuning, in [[cent]]s.
-=== Edo join 1 ===
+; Optimization method
-The smallest edo(or equal division of another interval) that reasonably supports the temperament. Only type the number, not "edo" or any extra text.
+: The method used to calculate the optimal tuning above. Type the acronym, such as CWE or POTE.
-=== Edo join 2 ===
+; MOS scales
-The second smallest edo that reasonably supports the temperament.
+: For rank-2 temperaments, the sequence of [[mos scale]]s induced by the generator.
-=== Optimization method ===
+; Ploidacot
-The method used to calculate the optimal tuning. Type all capital letters, such as CWE or POTE.
+: 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), if provided.
+; Color name
+: [[Kite's color notation/Temperament names|Kite's color name]] for the temperament, if provided.
+; Odd limit 1, 2, 3, 4
+: 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 ===
+Empty template for copy & paste to avoid copying wrong values from existing temperament pages:
-{{clear}}
+<pre>
-{{Todo|inline=1| complete and rectify documentation }}
+{{Infobox regtemp
+| Title =
+| Subgroups =
+| Comma basis =
+| Edo join 1 =  | Edo join 2 =  | Edo join 3 =  | Edo join 4 =
+| Mapping =
+| Generators =
+| Generators tuning =
+| Optimization method =
+| MOS scales =
+| Ploidacot =
+| Pergen =
+| Color name =
+| 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>