Template:Infobox ET/doc: Difference between revisions

(14 intermediate revisions by 3 users not shown)

Line 1:

The '''Infobox ET''' template was built to help presenting basic information about [[equal tuning]]s in a unified form, to make them obvious by glance. Also the formatting of the wiki text itself is easier to read and improve when it is obviously structured by this template.

=== Usage ===

The template should be placed at the beginning of an equal tuning page.

The template automatically fills in the following information (certain entries may be supplied with precomputed information using the keys in the Override column):

{| class="wikitable"

! ~~width~~="10%" | Entry

{| class="wikitable" style="margin-right: 25%;"

! ~~width~~="10%" | Override

|-

! ~~width="80%" |~~ Meaning and ~~Usage Notes~~

! style="width: 10%;" | Entry

! style="width: 10%;" | Override

! Meaning and usage notes

|-

| ET identifier

Line 16:

Line 23:

| Prime factorization

| Prime factorization of the equal temperament (e.g. 12 = 22 × 3), even if prime per se (e.g. 17 (prime)).

| Prime factorization of the equal temperament (e.g. {{nowrap|12 {{=}} 22 × 3}}), even if prime per se (e.g. 17 (prime)).

|-

| Step size

Line 52:

Line 59:

| Consistency

| The limit diamond to which the tuning is [[consistent]]. This template will stop trying to compute this if the value is at least 43. The following generalization is used for arbitrary equaves: for degree ''n'', all ratios of the form <~~math~~>Y^{~~\mathbb~~{Z}} ~~\cdot a/b,~~ a, b ~~\leq~~ n~~</math>~~, are considered; when an increase of ''n'' does not add any new ratios, this degree is skipped.

| The limit diamond to which the tuning is [[consistent]]. This template will stop trying to compute this if the value is at least 43. The following generalization is used for arbitrary equaves: for degree ''n'', all ratios of the form {{nowrap|''Y''ℤ ⋅ {{frac|''a''|''b''}}; ''a'', ''b'' ≤ ''n''}}, are considered; when an increase of ''n'' does not add any new ratios, this degree is skipped.

|-

| Distinct consistency

Line 60:

Line 67:

| Special properties

| Zeta

| If the size is highly composite, an additional entry states the fact. See [[Highly composite equal division]]. If the size is within integer sequences associated with zeta peaks, zeta integrals or zeta gaps, an additional entry states the fact. See [[The Riemann zeta function and tuning]]. ~~To hide zeta~~ information, pass the value of <code>no</code>.

| If the size is highly composite, an additional entry states the fact. See [[Highly composite equal division]]. If the size is within integer sequences associated with zeta peaks, zeta integrals or zeta gaps, an additional entry states the fact. See [[The Riemann zeta function and tuning]]. Zeta information is hidden by default, pass the value of <code>yes</code> to display it (if any zeta category applies). Zeta-related categories are included regardless of the zeta display parameter.

|}

=== ~~Usage examples~~ ===

=== Examples ===

{{{{ROOTPAGENAME}}|12edo|debug=1}}

For a regular ET page:

<pre>

<pre>{{Infobox ET}}</pre>

</pre>

Specifying a specific ET from an unrelated page:

<pre>

<pre>{{Infobox ET|7ed5/4|debug=1}}</pre>

</pre>

Note: <code>debug=1</code> will disable categories.

Line 79:

Line 85:

Supplying precomputed consistency limits when those are too large to be recomputed on each page update:

<pre>

<pre>{{Infobox ET|5407372813edo|Consistency=155|Distinct consistency=155}}</pre>

{{Infobox ET|5407372813edo|Consistency=155|Distinct consistency=155}}

</pre>

=== See also ===

* {{modlink}}

* [[Template: Infobox Interval]]

{{todo

| discuss

| inline=1

| comment=Reach consensus on parameters, see discussion page!

| comment=Reach consensus on parameters (see discussion page)

}}

~~</noinclude>~~

@@ Line 1: / Line 1: @@
-{{dochead}}
+{{Dochead}}{{substitute|no}}{{lua}}
+The '''Infobox ET''' template was built to help presenting basic information about [[equal tuning]]s in a unified form, to make them obvious by glance. Also the formatting of the wiki text itself is easier to read and improve when it is obviously structured by this template.
+=== Usage ===
+The template should be placed at the beginning of an equal tuning page.
 The template automatically fills in the following information (certain entries may be supplied with precomputed information using the keys in the Override column):
-{| class="wikitable"
-! width="10%" | Entry
+{| class="wikitable" style="margin-right: 25%;"
-! width="10%" | Override
+|-
-! width="80%" | Meaning and Usage Notes
+! style="width: 10%;" | Entry
+! style="width: 10%;" | Override
+! Meaning and usage notes
 |-
 | ET identifier
@@ Line 16: / Line 23: @@
 | Prime factorization
 | Prime factorization
-| Prime factorization of the equal temperament (e.g. 12 = 2<sup>2</sup> × 3), even if prime per se (e.g. 17 (prime)).
+| Prime factorization of the equal temperament (e.g. {{nowrap|12 {{=}} 2<sup>2</sup> × 3}}), even if prime per se (e.g. 17 (prime)).
 |-
 | Step size
@@ Line 52: / Line 59: @@
 | Consistency
 | Consistency
-| The limit diamond to which the tuning is [[consistent]]. This template will stop trying to compute this if the value is at least 43. The following generalization is used for arbitrary equaves: for degree ''n'', all ratios of the form <math>Y^{\mathbb{Z}} \cdot a/b, a, b \leq n</math>, are considered; when an increase of ''n'' does not add any new ratios, this degree is skipped.
+| The limit diamond to which the tuning is [[consistent]]. This template will stop trying to compute this if the value is at least 43. The following generalization is used for arbitrary equaves: for degree ''n'', all ratios of the form {{nowrap|''Y''<sup>ℤ</sup> ⋅ {{frac|''a''|''b''}}; ''a'', ''b'' &le; ''n''}}, are considered; when an increase of ''n'' does not add any new ratios, this degree is skipped.
 |-
 | Distinct consistency
@@ Line 60: / Line 67: @@
 | Special properties
 | Zeta
-| If the size is highly composite, an additional entry states the fact. See [[Highly composite equal division]]. If the size is within integer sequences associated with zeta peaks, zeta integrals or zeta gaps, an additional entry states the fact. See [[The Riemann zeta function and tuning]]. To hide zeta information, pass the value of <code>no</code>.
+| If the size is highly composite, an additional entry states the fact. See [[Highly composite equal division]]. If the size is within integer sequences associated with zeta peaks, zeta integrals or zeta gaps, an additional entry states the fact. See [[The Riemann zeta function and tuning]]. Zeta information is hidden by default, pass the value of <code>yes</code> to display it (if any zeta category applies). Zeta-related categories are included regardless of the zeta display parameter.
 |}
-=== Usage examples ===
+=== Examples ===
 {{{{ROOTPAGENAME}}|12edo|debug=1}}
 For a regular ET page:
-<pre>
-{{Infobox ET}}
+<pre>{{Infobox ET}}</pre>
-</pre>
 Specifying a specific ET from an unrelated page:
-<pre>
-{{Infobox ET|7ed5/4|debug=1}}
+<pre>{{Infobox ET|7ed5/4|debug=1}}</pre>
-</pre>
 Note: <code>debug=1</code> will disable categories.
@@ Line 79: / Line 85: @@
 Supplying precomputed consistency limits when those are too large to be recomputed on each page update:
-<pre>
+<pre>{{Infobox ET|5407372813edo|Consistency=155|Distinct consistency=155}}</pre>
-{{Infobox ET|5407372813edo|Consistency=155|Distinct consistency=155}}
-</pre>
 === See also ===
-* {{modlink}}
 * [[Template: Infobox Interval]]
 {{todo
+| discuss
 | inline=1
-| comment=Reach consensus on parameters, see discussion page!
+| comment=Reach consensus on parameters (see discussion page)
 <!-- | cleanup -->
 }}
 <!-- interwiki -->
-</noinclude>