Template:Primes in edo/doc: Difference between revisions

Inthar (talk | contribs)
mNo edit summary
Xenwolf (talk | contribs)
Usage: update prec description, add simple usage
Line 1: Line 1:
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
=== Usage ===
=== Usage ===
==== Simple ====
Normally, it's sufficient to place one line in the article, and set the EDO number accordingly:
<syntaxhighlight lang="text">
{{primes in edo|<EDO number>}}
</syntaxhighlight>
==== 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:


<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
{{primes in edo
{{primes in edo
| edo = <EDO of interest, default is 12>
| edo = <EDO number>
| columns = <column count, default is 8>
| columns = <column count>
| start = <start column, default is 1>
| start = <start column>
| prec = <decimals of abs error, default is 1>
| prec = <decimals of abs error>
| title = <your title>
| title = <your title>
}}
}}
</syntaxhighlight>
</syntaxhighlight>
This template takes up to 5 arguments:


; edo: (this parameter can also be given without the parameter name)
; edo: (this parameter can also be given without the parameter name)
; columns: number 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
; prec: precision of absolute error (digits after the decimal point), default is 1
; prec: precision of absolute error (digits after the decimal point), default is estimated by EDO magnitude
; title: default is Approximations of prime intervals in ''edo'' EDO
; title: default is ''Approximations of prime intervals in ''&lt;edo&gt;'' EDO''


=== Examples ===
=== Examples ===