Template:Infobox ET/doc: Difference between revisions

(6 intermediate revisions by 2 users not shown)

Line 1:

The ~~template~~ '''Infobox ET''' 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.

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):

Line 56:

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''<sup>ℤ</sup> ⋅ {{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 64:

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

Line 85:

Line 88:

=== See also ===

* {{modlink}}

* [[Template: Infobox Interval]]

* [[Template:Infobox Interval]]

{{todo

@@ Line 1: / Line 1: @@
-{{dochead}}
+{{Dochead}}{{substitute|no}}{{lua}}
-The template '''Infobox ET''' 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.
+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):
@@ Line 56: / 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 64: / 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}}
@@ Line 85: / Line 88: @@
 === See also ===
-* {{modlink}}
+* [[Template: Infobox Interval]]
-* [[Template:Infobox Interval]]
 {{todo