Template:Step vis: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
Updated doc; template now supports size-0 steps
ArrowHead294 (talk | contribs)
mNo edit summary
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<includeonly>{{#invoke:Step_vis|step_vis_frame
<includeonly>{{#if: {{{1|}}}|{{#invoke: Step_vis | step_vis
|Step Pattern={{{1|}}}
| Step Pattern={{{1}}}
}}</includeonly><noinclude>
| debug={{lc: {{{debug|}}}}}
This template is used to visualize the step pattern of a scale given as a sequence of whole-number step sizes.
}}|}}</includeonly><noinclude>
== Usage ==
{{documentation}}


Step patterns are entered as shown below. The first parameter should contain the step pattern, with step sizes separated by spaces.
[[Category:Functionality templates]]
 
<pre>{{Step vis|5 5 5 3 5 5 3}}</pre>
{{Step vis|5 5 5 3 5 5 3}}
 
<pre>{{Step vis|1=5 5 5 3 5 5 3}}</pre>
{{Step vis|1=5 5 5 3 5 5 3}}
 
Step patterns are drawn using the ASCII box drawing symbols ├, ┤, ─, and ┼. Step sizes of 0 are depicted using the symbol ╫.
 
<pre>{{Step vis|5 5 5 0 5 5 0}}</pre>
{{Step vis|5 5 5 0 5 5 0}}
</noinclude>
</noinclude>

Latest revision as of 15:53, 30 January 2026

Template documentation[view] [edit] [history] [purge]
This template is implemented by the Lua module Module:Step vis. See its module page for Lua-based template implementation.
This template invokes the following functions: step_vis from Step vis.
This template should not be substituted.

This template is used to visualize the step pattern of a scale given as a sequence of whole-number step sizes.

Usage

Step patterns are entered as shown below. The first parameter should contain the step pattern, with step sizes separated by spaces.

For example, you can use this

{{Step vis|4 1 4 1 4 1 4 1 4 1 4 1 4}}

to illustrate the 7L 6s scale in 34edo:

├───┼┼───┼┼───┼┼───┼┼───┼┼───┼┼───┤

Step patterns are drawn using the Unicode box-drawing symbols ├ (U+251C), ┤ (U+2524), ─ (U+2500), and ┼ (U+253C).

Regarding step sizes of 0

Step sizes of 0 are depicted using the symbol ╫ (U+256B), ╢ (U+2562), or ╟ (U+255F), depending on the location.

{{Step vis|5 2 5 0 4 5 0 5 3 1 4 0 5}}

├────┼─┼────╫───┼────╫────┼──┼┼───╫────┤

{{Step vis|0 0 5 2 5 0 0 0 4 5 0 5 3 0 0 1 4 0 2 3 5 0 0 0}}

╟────┼─┼────╫───┼────╫────┼──╫┼───╫─┼──┼────╢