Template:Infobox interval/doc: Difference between revisions

(7 intermediate revisions by 5 users not shown)

Line 1:

The '''Infobox Interval''' template was built to help presenting basic information about [[interval]]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 ===

There are three different ways to use this template:

The template should be placed at the beginning of an interval page. There are three different ways to use this template:

* Small ratios: <code><nowiki>{{Infobox Interval}}</nowiki></code> (the ratio is inferred from page name), <code><nowiki>{{Infobox Interval|7/4}}</nowiki></code>, <code><nowiki>{{Infobox Interval|Ratio=7/4}}</nowiki></code>.

** When use this form? In most cases, whenever both numerator and denominator of the ratio are small enough to fit within Lua numbers as integers. You should not encounter any problems with integers up to {{nowrap|232 ~~−~~ 1}}, and you might happen to not encounter any problems when those are 253. With larger numbers, you are almost guaranteed to get inaccurate results.

** When use this form? In most cases, whenever both numerator and denominator of the ratio are small enough to fit within Lua numbers as integers. You should not encounter any problems with integers up to {{nowrap| 232 − 1 }}, and you might happen to not encounter any problems when those are 253. With larger numbers, you are almost guaranteed to get inaccurate results.

* Large ratios: <code><nowiki>{{Infobox Interval|Ket=-2 0 0 1}}</nowiki></code>, <code><nowiki>{{Infobox Interval|Monzo=-2 0 0 1}}</nowiki></code>.

* Large ratios: <code><nowiki>{{Infobox Interval|Ket = -2 0 0 1}}</nowiki></code>, <code><nowiki>{{Infobox Interval|Monzo = -2 0 0 1}}</nowiki></code>.

** In this form, '''Ratio''' (unless you specify it explicitly, in which case it will be printed as is) and most norms are omitted.

** When use this form? Whenever numerator or denominator are too large.

Line 18:

* [[:Category: Unnoticeable commas]], [[:Category: Small commas]], [[:Category: Medium commas]], [[:Category: Large commas]];

* [[:Category: Superparticular ratios]];

* [[:Category: Harmonics]], [[:Category: ~~Octave-reduced~~ harmonics]], [[:Category: ~~Subharmonics~~]], [[:Category: Octave-reduced subharmonics]];

* [[:Category: Harmonics]], [[:Category: Prime harmonics]], [[:Category: Highly composite harmonics]], [[:Category: Octave-reduced harmonics]], [[:Category: Octave-reduced subharmonics]];

* [[:Category: Pages with internal sound examples]];

* [[:Category: Todo:add interval ratio]], [[:Category: Todo:add interval name]], [[:Category: Todo:add color name]], [[:Category: Todo:remove explicit ket notation]], [[:Category: Todo:remove explicit cents]], [[:Category: Todo:initialise interval]], [[:Category: Todo:replace sup and sub with LaTeX]], [[:Category: Todo:remove manual line breaks]].

Line 42:

| Coefficients of the [[monzo]] notation, separated by whitespaces. Derived from '''Ratio''' or specified or omitted for irrational intervals. If you specify one for an irrational interval, [[Template: Monzo]] with the provided argument will be printed.

|-

| [[~~Smonzos and svals|~~Subgroup monzo]]

| [[Subgroup monzo]]

|

| Shown instead of '''Factorization''' and '''Monzo''' when there is a sequence of 4 or more zeros in ket notation. Derived either from '''Ratio''' or '''Monzo''' or omitted for irrational intervals.

Line 54:

| Name(s) of the interval. Pages with missing values go into [[:Category:Todo:add interval name]]. You should not put any <code><nowiki> </nowiki></code> tags between names here; it will be done automatically.

|-

| [[~~Color~~ notation|Color name]]

| [[Kite's color notation|Color name]]

| Color name

| Color name after Kite's [[color notation]] in the form: <code>written form, spoken form</code>. For color names see also [[Gallery of just intervals]]. Pages with missing values go into [[:Category:Todo:add color name]]. Default: omitted.

Line 66:

| Currently implemented: [[superparticular interval|superparticular]] and [[square superparticular]] for small ratios, [[harmonic]]s and [[subharmonic]]s, including reduced ones, whether a ratio is [[octave reduction|reduced]].

|-

| [[Tenney ~~height~~]]

| [[Tenney norm]]

|

| Derived from '''Ratio''' or '''Monzo''' or omitted.

|-

| [[Weil ~~height~~]]

| [[Weil norm]]

|

| Derived from '''Ratio''' or omitted.

|-

| [[Wilson ~~height~~]]

| [[Wilson norm]]

|

| Derived from '''Ratio''', or omitted.

|-

| [[Harmonic entropy]]

|

| Harmonic entropy

| Harmonic entropy approximation (Shannon, <math>\sqrt{nd}</math> weights, <math>200\text{-integer limit} \cap \left\lbrace x \mid \left\Vert x \right\Vert \leq 100 \right\rbrace</math>). Derived from '''Ratio''', '''Monzo''', or '''Cents'''.

| Harmonic entropy approximation (Shannon, <math>\sqrt{nd}</math> weights, <math>200\text{-integer limit} \cap \left\lbrace x \mid \left\Vert x \right\Vert \leq 100 \right\rbrace</math>). Derived from '''Ratio''', '''Monzo''', or '''Cents'''. Harmonic entropy is hidden by default, pass the value of <code>yes</code> to display it.

|-

| [[Comma|Comma size]]

@@ Line 1: / Line 1: @@
-{{dochead}}{{lua}}
+{{Dochead}}{{substitute|no}}
 The '''Infobox Interval''' template was built to help presenting basic information about [[interval]]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 ===
-There are three different ways to use this template:
+The template should be placed at the beginning of an interval page. There are three different ways to use this template:
 * Small ratios: <code><nowiki>{{Infobox Interval}}</nowiki></code> (the ratio is inferred from page name), <code><nowiki>{{Infobox Interval|7/4}}</nowiki></code>, <code><nowiki>{{Infobox Interval|Ratio=7/4}}</nowiki></code>.
-** When use this form? In most cases, whenever both numerator and denominator of the ratio are small enough to fit within Lua numbers as integers. You should not encounter any problems with integers up to {{nowrap|2<sup>32</sup> &minus; 1}}, and you might happen to not encounter any problems when those are 2<sup>53</sup>. With larger numbers, you are almost guaranteed to get inaccurate results.
+** When use this form? In most cases, whenever both numerator and denominator of the ratio are small enough to fit within Lua numbers as integers. You should not encounter any problems with integers up to {{nowrap| 2<sup>32</sup> − 1 }}, and you might happen to not encounter any problems when those are 2<sup>53</sup>. With larger numbers, you are almost guaranteed to get inaccurate results.
-* Large ratios: <code><nowiki>{{Infobox Interval|Ket=-2 0 0 1}}</nowiki></code>, <code><nowiki>{{Infobox Interval|Monzo=-2 0 0 1}}</nowiki></code>.
+* Large ratios: <code><nowiki>{{Infobox Interval|Ket = -2 0 0 1}}</nowiki></code>, <code><nowiki>{{Infobox Interval|Monzo = -2 0 0 1}}</nowiki></code>.
 ** In this form, '''Ratio''' (unless you specify it explicitly, in which case it will be printed as is) and most norms are omitted.
 ** When use this form? Whenever numerator or denominator are too large.
@@ Line 18: / Line 18: @@
 * [[:Category: Unnoticeable commas]], [[:Category: Small commas]], [[:Category: Medium commas]], [[:Category: Large commas]];
 * [[:Category: Superparticular ratios]];
-* [[:Category: Harmonics]], [[:Category: Octave-reduced harmonics]], [[:Category: Subharmonics]], [[:Category: Octave-reduced subharmonics]];
+* [[:Category: Harmonics]], [[:Category: Prime harmonics]], [[:Category: Highly composite harmonics]], [[:Category: Octave-reduced harmonics]], [[:Category: Octave-reduced subharmonics]];
 * [[:Category: Pages with internal sound examples]];
 * [[:Category: Todo:add interval ratio]], [[:Category: Todo:add interval name]], [[:Category: Todo:add color name]], [[:Category: Todo:remove explicit ket notation]], [[:Category: Todo:remove explicit cents]], [[:Category: Todo:initialise interval]], [[:Category: Todo:replace sup and sub with LaTeX]], [[:Category: Todo:remove manual line breaks]].
@@ Line 42: / Line 42: @@
 | Coefficients of the [[monzo]] notation, separated by whitespaces. Derived from '''Ratio''' or specified or omitted for irrational intervals. If you specify one for an irrational interval, [[Template: Monzo]] with the provided argument will be printed.
 |-
-| [[Smonzos and svals|Subgroup monzo]]
+| [[Subgroup monzo]]
 |
 | Shown instead of '''Factorization''' and '''Monzo''' when there is a sequence of 4 or more zeros in ket notation. Derived either from '''Ratio''' or '''Monzo''' or omitted for irrational intervals.
@@ Line 54: / Line 54: @@
 | Name(s) of the interval. Pages with missing values go into [[:Category:Todo:add interval name]]. You should not put any <code><nowiki><br></nowiki></code> tags between names here; it will be done automatically.
 |-
-| [[Color notation|Color name]]
+| [[Kite's color notation|Color name]]
 | Color name
 | Color name after Kite's [[color notation]] in the form: <code>written form, spoken form</code>. For color names see also [[Gallery of just intervals]]. Pages with missing values go into [[:Category:Todo:add color name]]. Default: omitted.
@@ Line 66: / Line 66: @@
 | Currently implemented: [[superparticular interval|superparticular]] and [[square superparticular]] for small ratios, [[harmonic]]s and [[subharmonic]]s, including reduced ones, whether a ratio is [[octave reduction|reduced]].
 |-
-| [[Tenney height]]
+| [[Tenney norm]]
 |
 | Derived from '''Ratio''' or '''Monzo''' or omitted.
 |-
-| [[Weil height]]
+| [[Weil norm]]
 |
 | Derived from '''Ratio''' or omitted.
 |-
-| [[Wilson height]]
+| [[Wilson norm]]
 |
 | Derived from '''Ratio''', or omitted.
 |-
 | [[Harmonic entropy]]
-|
+| Harmonic entropy
-| Harmonic entropy approximation (Shannon, <math>\sqrt{nd}</math> weights, <math>200\text{-integer limit} \cap \left\lbrace x \mid \left\Vert x \right\Vert \leq 100 \right\rbrace</math>). Derived from '''Ratio''', '''Monzo''', or '''Cents'''.
+| Harmonic entropy approximation (Shannon, <math>\sqrt{nd}</math> weights, <math>200\text{-integer limit} \cap \left\lbrace x \mid \left\Vert x \right\Vert \leq 100 \right\rbrace</math>). Derived from '''Ratio''', '''Monzo''', or '''Cents'''. Harmonic entropy is hidden by default, pass the value of <code>yes</code> to display it.
 |-
 | [[Comma|Comma size]]