Template:Interval edo approximation/doc: Difference between revisions

Pailiaq (talk | contribs)
mNo edit summary
Pailiaq (talk | contribs)
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
=== Basic syntax ===
=== Basic syntax ===
<pre>
<pre>
{{Interval edo approximation|3/2}}
{{Interval edo approximation|interval = 3/2 | interval_name = 3/2}}
</pre>
</pre>
if the name of the page is the interval you are trying to create a table of, use  
if the name of the page is the interval you are trying to create a table of, it will by default use the pagename as the interval.
<pre>
<pre>
{{Interval edo approximation|{{PAGENAME}}}}
{{Interval edo approximation|{{PAGENAME}}}}
</pre>
=== With named parameter ===
<pre>
{{Interval edo approximation|interval=5/4}}
</pre>
</pre>


=== With custom parameters ===
=== With custom parameters ===
<pre>
<pre>
{{Interval edo approximation|interval=7/6|tolerance=10|min_edo=12|max_edo=72}}
{{Interval edo approximation|interval=7/6|tolerance=10|min_edo=12|max_edo=72 | interval_name = Septimal Minor third}}
</pre>
</pre>


=== Parameters ===
=== Parameters ===
; <code>interval</code> (or first unnamed parameter)
; <code>interval</code>  
: the just interval ratio (required). Format: "numerator/denominator" (e.g., "3/2", "5/4", "7/6")
: the just interval ratio (required). Format: "numerator/denominator" (e.g., "3/2", "5/4", "7/6")
; <code>tolerance</code>
; <code>tolerance</code>
Line 31: Line 26:
; <code>max_edo</code>
; <code>max_edo</code>
: maximum edo to check (optional, default: 60)
: maximum edo to check (optional, default: 60)
; <code>interval_name</code>
: the name of the interval you would like to label it. best case for when approximating irrational numbers; e.g. acoustic phi would be approximated with a large fracton. where interval = 1618/1000 | interval_name = ϕ


=== Examples ===
=== Examples ===
; Perfect fifth (3/2)
; Perfect fifth (3/2)
{{Interval edo approximation|3/2}}
{{Interval edo approximation|interval = 3/2 | interval_name = 3/2}}


; Major third (5/4) with custom tolerance (20%)
; Major third (5/4) with custom tolerance (20%)
{{Interval edo approximation|5/4|tolerance=20}}
{{Interval edo approximation|interval = 5/4|tolerance=20|interval_name = 5/4}}


; Septimal minor third (7/6) with extended range (up to 150edo)
; Septimal minor third (7/6) with extended range (up to 150edo)
{{Interval edo approximation|7/6|min_edo=5|max_edo=150}}
{{Interval edo approximation|interval = 7/6|min_edo=5|max_edo=150|interval_name =7/6}}