Template:Infobox interval/doc: Difference between revisions

(14 intermediate revisions by 2 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 ~~when those are~~ <~~math~~>~~\leq 2^{~~32}</~~math~~>, and you might happen to not encounter any problems when those are <~~math~~>~~\leq 2^{~~53}</~~math~~>. 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>.

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

Line 16:

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

Line 25:

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

|-

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

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

Line 29:

Line 32:

| Ratio

| 1, Ratio

| Frequency [[ratio]] of the interval. Specified explicitly, derived from page name or omitted. For irrational intervals, a LaTeX expression describing the interval (without <nowiki><math></nowiki>).

| Frequency [[ratio]] of the interval. Specified explicitly, derived from page name or omitted. For irrational intervals, a LaTeX expression describing the interval (without <code><nowiki><math></nowiki></code>).

|-

| Factorization

Line 49:

Line 52:

| Name

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

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

|-

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

| [[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.

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

|-

| [[Functional Just System|FJS name]]

Line 61:

Line 64:

| Special properties

|

| 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]].

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

Line 76:

Line 79:

|-

| [[Harmonic entropy]]

|

| Harmonic entropy

| Harmonic entropy approximation (Shannon, <math>\sqrt{~~n\cdot d~~}</math> weights, <math>200\text{-integer limit}\cap\{x\mid\left|\~~left|~~x\right|\~~right|~~\leq 100\}</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 138:

Line 141:

=== See also ===

* {{modlink}}

* [[Template: Infobox ET]]

* [[Template:Infobox ET]]

* [[xen-calc]] – The according page of that tool gets linked automatically for rational intervals.

* [[xen-calc]] – ~~the~~ according page of that tool gets linked automatically for rational intervals

[[de:Vorlage:Infobox Intervall]]

@@ Line 1: / Line 1: @@
-{{dochead}}
+{{Dochead}}{{lua}}
+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 when those are <math>\leq 2^{32}</math>, and you might happen to not encounter any problems when those are <math>\leq 2^{53}</math>. 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> &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.
 * 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.
@@ Line 16: / 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 23: / Line 25: @@
 {| class="wikitable" style="margin-right: 25%;"
+|-
 ! style="width: 10%;" | Entry
 ! style="width: 10%;" | Parameter
@@ Line 29: / Line 32: @@
 | Ratio
 | 1, Ratio
-| Frequency [[ratio]] of the interval. Specified explicitly, derived from page name or omitted. For irrational intervals, a LaTeX expression describing the interval (without <nowiki><math></nowiki>).
+| Frequency [[ratio]] of the interval. Specified explicitly, derived from page name or omitted. For irrational intervals, a LaTeX expression describing the interval (without <code><nowiki><math></nowiki></code>).
 |-
 | Factorization
@@ Line 49: / Line 52: @@
 | Name
 | Name
-| Name(s) of the interval. Pages with missing values go into [[:Category:Todo:add interval name]]. You should not put any <nowiki><br/></nowiki> tags between names here; it will be done automatically.
+| 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.
 |-
-| [[Kite's color notation|Color name]]
+| [[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.
+| 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.
 |-
 | [[Functional Just System|FJS name]]
@@ Line 61: / Line 64: @@
 | Special properties
 |
-| 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]].
+| 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]]
@@ Line 76: / Line 79: @@
 |-
 | [[Harmonic entropy]]
-|
+| Harmonic entropy
-| Harmonic entropy approximation (Shannon, <math>\sqrt{n\cdot d}</math> weights, <math>200\text{-integer limit}\cap\{x\mid\left|\left|x\right|\right|\leq 100\}</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 138: / Line 141: @@
 === See also ===
-* {{modlink}}
+* [[Template: Infobox ET]]
-* [[Template:Infobox ET]]
+* [[xen-calc]] – The according page of that tool gets linked automatically for rational intervals.
-* [[xen-calc]] – the according page of that tool gets linked automatically for rational intervals
 <!-- interwiki -->
 [[de:Vorlage:Infobox Intervall]]