Xenharmonic Wiki

Template:Primes in edo/doc: Difference between revisions

← Older edit
VisualWikitext
Xenwolf (talk | contribs)
autopatrolled, Bureaucrats, confirmaccount-notify, Interface administrators, Sysops
8,705 edits
→Examples: expanded and explained
ArrowHead294 (talk | contribs)
14,512 edits
mNo edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
{{dochead}}
=== Usage ===
=== Usage ===
==== Simple ====
Normally, it's sufficient to place one line in the article, and set the EDO number accordingly:


<syntaxhighlight lang="text">
<pre>
{{primes in edo|<EDO number>}}
</pre>
 
==== Advanced ====
Under certain circumstances, the values for precision (<code>prec</code>) or column count (<code>columns</code>) don't fit in the given context. The template takes up to 5 arguments:
 
<pre>
{{primes in edo
{{primes in edo
| edo=<EDO of interest, default is 12>
| edo = <EDO number>
| columns=<coulumn count, default is 8>
| columns = <column count>
| start=<start column, default is 1>
| start = <start column>
| title=<your title>
| prec = <decimals of abs error>
| title = <your title>
}}
}}
</syntaxhighlight>
</pre>
 
This template takes up to 4 arguments:


; edo: (this parameter can also be given without the parameter name)
; edo: (this parameter can also be given without the parameter name)
; columns: amount of primes to include the default (8) means 2,3,5,7,11,13,17,19
; columns: number of primes to include, the default (8) means 2, 3, 5, 7, 11, 13, 17, 19
; start: default is 1 (which means the prime 2), set to 2 to skip the octave
; start: default is 1 (which means the prime 2), set to 2 to skip the octave
; title: default is Approsimations of primary intervals in ''edo'' EDO
; prec: precision of absolute error (digits after the decimal point), default is estimated by EDO magnitude
; title: default is ''Approximations of prime intervals in ''&lt;edo&gt;'' EDO''


=== Examples ===
=== Examples ===
Although the template does also work without any arguments, one argument should be seen as mandatory: the EDO number.
Although the template does also work without any arguments, one argument should be seen as mandatory: the EDO number.


==== Basic ====
==== Basic ====
In most cases it will be sufficient to input just the EDO and nothing else.
In most cases it will be sufficient to input just the EDO and nothing else.


<syntaxhighlight lang="text">
<pre>
{{primes in edo|17}}
{{primes in edo|17}}
</syntaxhighlight>
</pre>
{{primes in edo|17}}
{{primes in edo|17}}


==== Advanced ====
==== Advanced ====
Sometimes you want to see more or skip some lower columns and have to adjust the title
Sometimes you want to see more or skip some lower columns and have to adjust the title


<syntaxhighlight lang="text">
<pre>
{{primes in edo|19|columns=11|start=2|title=Primes in [[19edo]]}}
{{primes in edo|19|columns=11|start=2|title=Primes in [[19edo]]}}
</syntaxhighlight>
</pre>
{{primes in edo|19|columns=11|start=2|title=Primes in [[19edo]]}}
{{primes in edo|19|columns=11|start=2|title=Primes in [[19edo]]}}
For large EDOs ([[318edo]] in this example) the absolute error gets very small, so stick to the fixed format, we have to add digits after the decimal point. The default precision gets calculated automatically, but if we want to increase it further, we can set <code>prec</code> to a higher value.
<pre>
{{primes in edo|318|columns=9|start=2}}
{{primes in edo|318|columns=9|start=2|prec=4|title=Same with prec=4}}
</pre>
{{primes in edo|318|columns=9|start=2}}
{{primes in edo|318|columns=9|start=2|prec=4|title=Same with prec=4}}
<noinclude>[[Category:Template documentation]]</noinclude>
Retrieved from "https://en.xen.wiki/w/Template:Primes_in_edo/doc"