Template:Infobox regtemp/doc: Difference between revisions

Line 1:

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

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

== Parameters ==

=== Title ===

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

=== Subgroups ===

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

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

=== Generator ===

The interval that generates the temperament.

=== Mapping ===

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

=== Pergen ===

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

=== Color name ===

This is the color name of the comma tempered out.

=== Edo join 1 ===

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

=== Edo join 2 ===

The second smallest edo that reasonably supports the temperament.

=== Optimization method ===

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

@@ Line 1: / Line 1: @@
 {{dochead}}{{lua}}
-Infobox for regular temperaments. Most information has to be entered manually, though this is a first draft of such an infobox.{{clear}}
+Infobox for regular temperaments. Most information has to be entered manually, though this is a first draft of such an infobox.
-{{Todo|inline=1| add documentation }}
+== Parameters ==
+=== Title ===
+The name of the temperament goes here, and it appears as the title of the infobox.
+=== Subgroups ===
+Written here is the subgroup(s) that the temperament acts on; often a full prime limit.
+=== 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>
+=== Generator ===
+The interval that generates the temperament.
+=== Mapping ===
+The number of generators each element of the subgroup is mapped to; see [[reduced mapping]].
+=== Pergen ===
+This is the period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth).
+=== Color name ===
+This is the color name of the comma tempered out.
+=== Edo join 1 ===
+The smallest edo(or equal division of another interval) that reasonably supports the temperament. Only type the number, not "edo" or any extra text.
+=== Edo join 2 ===
+The second smallest edo that reasonably supports the temperament.
+=== Optimization method ===
+The method used to calculate the optimal tuning. Type all capital letters, such as CWE or POTE.
+{{clear}}
+{{Todo|inline=1| complete and rectify documentation }}