Template:Q-odd-limit intervals/doc: Difference between revisions

(17 intermediate revisions by 2 users not shown)

Line 1:

~~<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>~~

This template generates a table for ~~JI approximation qualities in an~~ [[edo]].

This template generates a table with the approximations of intervals for a given [[edo]] and [[odd limit]].

=== Usage ===

Use one unnamed argument for the edo number.

Use a second unnamed argument for the [[odd limit]]. The default is 15, since [[low-complexity just intonation]] typically involves just the first 16 harmonics of the harmonic series. Currently, this template stores prime numbers up to 31 and supports odd limits up to 35.

Use a second unnamed argument for the [[odd limit]]. The default is 15, since [[low-complexity just intonation]] typically involves just the first 16 harmonics of the harmonic series. Currently, this template stores prime numbers up to 61 and supports odd limits up to 65.

The title is ~~by default~~ "[Limit]-odd-limit intervals by patent val mapping"~~. You~~ can enter ~~your~~ custom title by <code>title = [your title]</code>.

Pass <code>header=none</code> to get rid of the description.

To list only direct approximations, pass <code>apx=direct</code>. To list only val-based approximations, pass <code>apx=val</code>, and the header will be suffixed with <code>(approximated with val)</code>. Otherwise, both approximations will be provided.

If <code>apx</code> is set to <code>direct</code>, the header will be suffixed with <code>(approximated directly)</code>. If <code>apx</code> is set to <code>val</code>, the header will be suffixed with <code>(approximated with val)</code>. Pass <code>tag=none</code> to remove this.

A note can be added below the header by passing <code>note=</code> followed by the text to be displayed.

The title is "[Limit]-odd-limit intervals by patent val mapping", but you can enter a custom title by <code>title = [your title]</code>.

=== Examples ===

You type

; You type

<~~syntaxhighlight lang="text"~~>

<pre>{{Q-odd-limit intervals|19}}</pre>

</~~syntaxhighlight~~>

You get

; You get

{{~~Q-odd-limit intervals~~|19}}~~<noinclude>[[Category:Template documentation]]</noinclude>~~

{{{{ROOTPAGENAME}}|19}}

@@ Line 1: / Line 1: @@
-<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
+{{dochead}}
-This template generates a table for JI approximation qualities in an [[edo]].
+This template generates a table with the approximations of intervals for a given [[edo]] and [[odd limit]].
 === Usage ===
 Use one unnamed argument for the edo number.
-Use a second unnamed argument for the [[odd limit]]. The default is 15, since [[low-complexity just intonation]] typically involves just the first 16 harmonics of the harmonic series. Currently, this template stores prime numbers up to 31 and supports odd limits up to 35.
+Use a second unnamed argument for the [[odd limit]]. The default is 15, since [[low-complexity just intonation]] typically involves just the first 16 harmonics of the harmonic series. Currently, this template stores prime numbers up to 61 and supports odd limits up to 65.
-The title is by default "[Limit]-odd-limit intervals by patent val mapping". You can enter your custom title by <code>title = [your title]</code>.
+Pass <code>header=none</code> to get rid of the description.
+To list only direct approximations, pass <code>apx=direct</code>. To list only val-based approximations, pass <code>apx=val</code>, and the header will be suffixed with <code>(approximated with val)</code>. Otherwise, both approximations will be provided.
+If <code>apx</code> is set to <code>direct</code>, the header will be suffixed with <code>(approximated directly)</code>. If <code>apx</code> is set to <code>val</code>, the header will be suffixed with <code>(approximated with val)</code>. Pass <code>tag=none</code> to remove this.
+A note can be added below the header by passing <code>note=</code> followed by the text to be displayed.
+The title is "[Limit]-odd-limit intervals by patent val mapping", but you can enter a custom title by <code>title = [your title]</code>.
 === Examples ===
-You type
+; You type
-<syntaxhighlight lang="text">
+<pre>{{Q-odd-limit intervals|19}}</pre>
-{{Q-odd-limit intervals|19}}
-</syntaxhighlight>
-You get
+; You get
-{{Q-odd-limit intervals|19}}<noinclude>[[Category:Template documentation]]</noinclude>
+{{{{ROOTPAGENAME}}|19}}