Template:Infobox regtemp/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Overthink (talk | contribs)
Update
Line 1: Line 1:
{{Dochead}}
{{Dochead}}
{{Template rating}}
{{Template rating}}
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 ==
== Parameters ==
Line 10: Line 10:
; 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>
; Edo join 1
; Edo join 1, 2, 3, 4
: The smallest [[equal temperament]] that reasonably [[support]]s the temperament. Despite this being called "edo", it accepts [[wart notation]] just fine.
: 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 equal temperament that reasonably supports the temperament.
; 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]].
; Generator
; Generator
: 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
; Generator 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
; Optimization method
: The method used to calculate the optimal tuning above. Type the acronym, such as CWE or POTE.
: 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
; Ploidacot
: Derived from '''Subgroup''', '''Mapping''', and '''Generator tuning''', or overriden here.  
: For rank-2 temperaments, the [[ploidacot]] signature. Derived from '''Subgroup''', '''Mapping''', and '''Generator tuning''', or overriden here.  
; Pergen
; 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
; 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
{{Todo|inline=1| add documentation |comment = Explain the remaining arguments.}}
: Reasonable odd limits to use in the temperament.
; Mistuning 1, 2
: [[Minimax error]]s of the odd limits.  
; Complexity 1, 2
: [[Graham complexity|Graham complexities]] of the odd limits.  


=== Boilerplate ===
=== Boilerplate ===
Line 40: Line 44:
| Subgroups =  
| Subgroups =  
| Comma basis =  
| Comma basis =  
| Edo join 1 =  | Edo join 2 =  
| Edo join 1 =  | Edo join 2 =  | Edo join 3 =  | Edo join 4 =  
| Mapping =  
| Mapping =  
| Generator =  
| Generator =  

Revision as of 13:39, 8 February 2026

This template is implemented by the Lua module Module:Infobox regtemp.
This template invokes the following functions: infobox_RT from Infobox regtemp.
This documentation is for a draft template. It is incomplete and may not be in active development. If possible, editors are encouraged to help with its development. In the meantime, editors should avoid using this template across the Xenharmonic Wiki, except for testing.

Infobox for regular temperaments. Support up to rank 4. As of now, most information has to be entered manually.

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:
comma 1, comma 2, … (subgroup 1); <br>comma 1, comma 2, (subgroup 2); …
Edo join 1, 2, 3, 4
The equal temperaments that reasonably support the temperament. Despite these parameters being called "edo", they accept wart notation just fine.
Mapping
The number of generators each element of the subgroup is mapped to; see Reduced mapping.
Generator
The list of intervals that generates the temperament, in ratio of monzo form.
Generator tuning
Sizes of the generators in an optimal tuning, in cents.
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 scales induced by the generator.
Ploidacot
For rank-2 temperaments, the ploidacot signature. Derived from Subgroup, Mapping, and Generator 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 name for the temperament, if provided.
Odd limit 1, 2
Reasonable odd limits to use in the temperament.
Mistuning 1, 2
Minimax errors of the odd limits.
Complexity 1, 2
Graham complexities of the odd limits.

Boilerplate

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

{{Infobox Regtemp
| Title = 
| Subgroups = 
| Comma basis = 
| Edo join 1 =  | Edo join 2 =  | Edo join 3 =  | Edo join 4 = 
| Mapping = 
| Generator = 
| Generator tuning = 
| Optimization method = 
| MOS scales = 
| Ploidacot = 
| Pergen = 
| Color name = 
| Odd limit 1 =  | Mistuning 1 =  | Complexity 1 = 
| Odd limit 2 =  | Mistuning 2 =  | Complexity 2 = 
}}