Template:Ups and downs sharpness/doc: Difference between revisions

Tristanbay (talk | contribs)
Update to document extra paramenters
Ganaram inukshuk (talk | contribs)
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{dochead}}{{substitute|no}}{{lua}}
{{dochead}}{{substitute|no}}
This template creates a table that displays the combinations of symbols for different amounts of steps from a natural note for a given [[EDO|edo]] in [[Kite's ups and downs notation]].
This template creates a table that displays the combinations of symbols for different amounts of steps from a natural note for a given [[EDO|edo]] in [[Kite's ups and downs notation]].


It takes 3 parameters:
=== Parameters ===
* '''edo''': Selects the edo to notate (if left blank, it will be in whatever edo the page is for, or 24edo if it is not an edo page).
* '''edo''': Selects the edo to notate (if left blank, it will be in whatever edo the page is for, or 24edo if it is not an edo page).
* '''sz''': Controls whether or not the table uses Stein-Zimmerman accidentals for even-sharpness edos (true/false).
* '''sz''': Controls whether or not the table uses Stein–Zimmerman accidentals for even-sharpness edos (true/false, defaults to false).
* '''debug''': Turns the template output into Wikitext.
* '''debug''': Displays the Wikitext to be rendered.
 
Known issues: SZ accidentals don't display for sharp-2 edos


=== Examples ===
=== Examples ===
<pre>{{Ups and downs sharpness}}</pre>
<pre>{{Ups and downs sharpness}}</pre>
{{ {{ROOTPAGENAME}} }}
{{ {{ROOTPAGENAMEE}} }}
 
 
<pre>{{Ups and downs sharpness|sz=true}}</pre>
{{ {{ROOTPAGENAME}}|sz=true}}




<pre>{{Ups and downs sharpness|41}}</pre>
<pre>{{Ups and downs sharpness|41}}</pre>
{{{{ROOTPAGENAME}}|41}}
{{{{ROOTPAGENAMEE}}|41}}




<pre>{{Ups and downs sharpness|72|true}}</pre>
<pre>{{Ups and downs sharpness|72|true}}</pre>
{{{{ROOTPAGENAME}}|72|true}}
{{{{ROOTPAGENAMEE}}|72|true}}




<pre>{{Ups and downs sharpness|311|true}}</pre>
<pre>{{Ups and downs sharpness|311|true}}</pre>
{{{{ROOTPAGENAME}}|311|true}}
{{{{ROOTPAGENAMEE}}|311|true}}