Template:Ups and downs sharpness/doc: Difference between revisions
Jump to navigation
Jump to search
Tristanbay (talk | contribs) Update to document extra paramenters |
Tristanbay (talk | contribs) Added known issue with template/module |
||
| Line 4: | Line 4: | ||
It takes 3 parameters: | It takes 3 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''': Turns the template output into Wikitext. | ||
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}} | {{{{ROOTPAGENAME}}}} | ||
Revision as of 23:43, 13 October 2025
- This template is implemented by the Lua module Module:Ups and downs sharpness.
- This template invokes the following functions: ud_sharpness from Ups and downs sharpness.
| This template should not be substituted. |
| This template has been deprecated. Its replacements are Template:Dochead and Template:Module introspection. |
| This template uses Lua: |
This template creates a table that displays the combinations of symbols for different amounts of steps from a natural note for a given edo in Kite's ups and downs notation.
It takes 3 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).
- 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.
Known issues: SZ accidentals don't display for sharp-2 edos
Examples
{{Ups and downs sharpness}}
{{{{ROOTPAGENAME}}}}
{{Ups and downs sharpness|41}}
{{Ups and downs sharpness|72|true}}
{{Ups and downs sharpness|311|true}}