Template:Primes in edo/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
Xenwolf (talk | contribs)
autopatrolled, Bureaucrats, confirmaccount-notify, Interface administrators, Sysops
8,705 edits
→Usage: update prec description, add simple usage
ArrowHead294 (talk | contribs)
14,512 edits
mNo edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
{{dochead}}
=== Usage ===
=== Usage ===
==== Simple ====
==== Simple ====
Normally, it's sufficient to place one line in the article, and set the EDO number accordingly:
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>}}
{{primes in edo|<EDO number>}}
</syntaxhighlight>
</pre>


==== Advanced ====
==== 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:
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">
<pre>
{{primes in edo
{{primes in edo
| edo = <EDO number>
| edo = <EDO number>
Line 22: Line 19:
| title = <your title>
| title = <your title>
}}
}}
</syntaxhighlight>
</pre>


; edo: (this parameter can also be given without the parameter name)
; edo: (this parameter can also be given without the parameter name)
Line 31: Line 28:


=== 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. This can be achieved by setting the parameter <code>prec</code> to a value higher than 1 (which is the default); compare the following two tables:
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.


<syntaxhighlight lang="text">
<pre>
{{primes in edo|318|columns=9|start=2}}
{{primes in edo|318|columns=9|start=2}}
{{primes in edo|318|columns=9|start=2|prec=2|title=Same with prec=2}}
{{primes in edo|318|columns=9|start=2|prec=4|title=Same with prec=4}}
</syntaxhighlight>
</pre>
{{primes in edo|318|columns=9|start=2}}
{{primes in edo|318|columns=9|start=2}}
{{primes in edo|318|columns=9|start=2|prec=2|title=Same with prec=2}}
{{primes in edo|318|columns=9|start=2|prec=4|title=Same with prec=4}}
 
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 11:03, 28 September 2024

Usage

Simple

Normally, it's sufficient to place one line in the article, and set the EDO number accordingly: 

{{primes in edo|<EDO number>}}

Advanced

Under certain circumstances, the values for precision (prec) or column count (columns) don't fit in the given context. The template takes up to 5 arguments: 

{{primes in edo
| edo = <EDO number>
| columns = <column count>
| start = <start column>
| prec = <decimals of abs error>
| title = <your title>
}}
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
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 estimated by EDO magnitude
title
default is Approximations of prime intervals in <edo> EDO

Examples

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

Basic

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

{{primes in edo|17}}

Script error: No such module "primes_in_edo".

Advanced

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

{{primes in edo|19|columns=11|start=2|title=Primes in [[19edo]]}}

Script error: No such module "primes_in_edo".

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 prec to a higher value. 

{{primes in edo|318|columns=9|start=2}}
{{primes in edo|318|columns=9|start=2|prec=4|title=Same with prec=4}}

Script error: No such module "primes_in_edo". Script error: No such module "primes_in_edo".

Retrieved from "https://en.xen.wiki/index.php?title=Template:Primes_in_edo/doc&oldid=156811"