Template:Infobox regtemp/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
Overthink (talk | contribs)
autopatrolled
2,790 edits
m fixed todo box to include in category
Xenllium (talk | contribs)
autopatrolled, emailconfirmed
5,025 edits
No edit summary
Tags: Mobile edit Mobile web edit
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{dochead}}
{{Dochead}}{{substitute|no}}
{{template rating}}
{{Template rating|rating=ready}}
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 ==
== 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|add 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>

Latest revision as of 08:16, 4 May 2026

This template is implemented by the Lua module Module:Infobox regtemp.
This template invokes the following functions: infobox_RT from Infobox regtemp.
This template should not be substituted.
This documentation is for a ready template. This message indicates that a template is ready for use, or has recently been repaired. This message may be removed once this template has been used on several pages or once it is verified to work as intended.

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.
Generators
The list of intervals that generates the temperament, in ratio of monzo form.
Generators 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 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 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 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 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 = 
| 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 = 
}}
Retrieved from "https://en.xen.wiki/index.php?title=Template:Infobox_regtemp/doc&oldid=229616"