Template:Step vis/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
Make documentation page
 
ArrowHead294 (talk | contribs)
m Don't need the "1=", replacing with second example
Line 3: Line 3:
Step patterns are entered as shown below. The first parameter should contain the step pattern, with step sizes separated by spaces.
Step patterns are entered as shown below. The first parameter should contain the step pattern, with step sizes separated by spaces.


<pre>{{Step vis|5 5 5 3 5 5 3}}</pre>
<pre>{{Step vis|5 5 3 5 5 5 3}}</pre>
{{Step vis|5 5 5 3 5 5 3}}
{{Step vis|5 5 3 5 5 5 3}}


<pre>{{Step vis|1=5 5 5 3 5 5 3}}</pre>
<pre>{{Step vis|4 1 4 1 4 1 4 1 4}}</pre>
{{Step vis|1=5 5 5 3 5 5 3}}
{{Step vis|4 1 4 1 4 1 4 1 4}}


Step patterns are drawn using the {{w|Box-drawing character|Unicode box-drawing symbols}} ├ (<code>U+251C</code>), ┤ (<code>U+2524</code>), ─ (<code>U+2500</code>), and ┼ (<code>U+253C</code>).
Step patterns are drawn using the {{w|Box-drawing character|Unicode box-drawing symbols}} ├ (<code>U+251C</code>), ┤ (<code>U+2524</code>), ─ (<code>U+2500</code>), and ┼ (<code>U+253C</code>).

Revision as of 13:32, 3 October 2024

This template is implemented by the Lua module Module:Step vis.
This template invokes the following functions: step_vis from Step vis.

Usage

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

{{Step vis|5 5 3 5 5 5 3}}

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

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

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

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 5 5 0 5 5 0}}

├────┼────┼────╫────┼────╢

Scales with consecutive size-0 steps may not display properly.

{{Step vis|0 0 5 5 5 0 0 5 5 0 0}}

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