Template:Infobox regtemp/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
Overthink (talk | contribs)
autopatrolled
2,773 edits
m fixed todo box to include in category
m Cleanup
Line 1: Line 1:
{{dochead}}
{{Dochead}}
{{template rating}}
{{Template rating}}
Infobox for regular temperaments. Most information has to be entered manually, though this is a first draft of such an infobox.
Infobox for regular temperaments. 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 ===
; Mapping
The interval that generates the temperament.
: The number of generators each element of the subgroup is mapped to; see [[reduced mapping]].
=== Mapping ===
; Generator
The number of generators each element of the subgroup is mapped to; see [[reduced mapping]].
: The interval that generates the temperament, in [[ratio]] of [[monzo]] form.
=== Pergen ===
; Optimization method
This is the period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth).
: The method used to calculate the optimal tuning. Type the acronym, such as CWE or POTE.
=== Color name ===
; Pergen
This is the color name of the comma tempered out.
: The period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth).
=== Edo join 1 ===
; Color name
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 [[color name]] of the comma tempered out.
=== Edo join 2 ===
; Edo join 1
The second smallest edo that reasonably supports the temperament.
: 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.
=== Optimization method ===
; Edo join 2
The method used to calculate the optimal tuning. Type all capital letters, such as CWE or POTE.
: The second smallest edo that reasonably supports the temperament.


{{clear}}
{{Clear}}
{{Todo|inline=1|add documentation }}
{{Todo|inline=1| add documentation }}

Revision as of 15:40, 21 November 2025

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. 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), …
Mapping
The number of generators each element of the subgroup is mapped to; see reduced mapping.
Generator
The interval that generates the temperament, in ratio of monzo form.
Optimization method
The method used to calculate the optimal tuning. Type the acronym, such as CWE or POTE.
Pergen
The period and the generator as fractions of simple intervals (most often the octave and a possibly compounded fifth or fourth).
Color name
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.
Todo: add documentation
Retrieved from "https://en.xen.wiki/index.php?title=Template:Infobox_regtemp/doc&oldid=217432"