Template:Scale link/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
mNo edit summary
Note the supposed interval format and the default value
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{dochead}}
{{dochead}}
When linking non-octave scales (such as [[3/1|tritave]]-equivalent scales), one often has to type the scale twice (e.g. <code>[[<nowiki />4L 5s (3/1-equivalent)|4L 5s]]</code>). This template is intended to simplify this by only requiring the scale once, so you can type (for example) <code>{{<nowiki />scale link|4L 5s|3/1}}</code> or <code>{{<nowiki />sl|4L 5s|3/1}}</code> instead.
When linking non-octave scales (such as [[3/1|tritave]]-equivalent scales), one often has to type the scale twice (e.g. <code><nowiki>[[</nowiki>[[4L 5s (3/1-equivalent)]]|4L 5s<nowiki>]]</nowiki></code>). This template is intended to simplify this by only requiring the scale once, so you can type (for example) <code><nowiki>{{scale link|4L 5s}}</nowiki></code> or <code><nowiki>{{sl|4L 5s}}</nowiki></code> instead.


To link to, for example, the octave-repeating [[4L 5s]] scale, just type <code>[[<nowiki />4L 5s]]</code> or <code>[[<nowiki />4L&amp;nbsp;5s]]</code>.
To link to, for example, the octave-repeating [[4L&nbsp;5s]] scale, just type <code><nowiki>[[4L&nbsp;5s]]</nowiki></code> or <code><nowiki>[[4L&amp;nbsp;5s]]</nowiki></code>.
 
{{shortcut|sl}}


=== Parameters ===
=== Parameters ===
Line 9: Line 11:


; <code><nowiki>{{{2}}}</nowiki></code> (optional)
; <code><nowiki>{{{2}}}</nowiki></code> (optional)
: The equave (if the scale is a non-octave scale), as the second unnamed parameter.
: The equave in frequency ratio (if the equave is neither the octave nor the tritave), as the second unnamed parameter. Default is 3/1.

Latest revision as of 17:41, 10 February 2025

When linking non-octave scales (such as tritave-equivalent scales), one often has to type the scale twice (e.g. [[4L 5s (3/1-equivalent)|4L 5s]]). This template is intended to simplify this by only requiring the scale once, so you can type (for example) {{scale link|4L 5s}} or {{sl|4L 5s}} instead.

To link to, for example, the octave-repeating 4L 5s scale, just type [[4L 5s]] or [[4L&nbsp;5s]].

Note: You can use {{sl}} as a shortcut.

Parameters

{{{1}}} (required)
The scale (in terms of L and s intervals, e.g. 5L 2s), as the first unnamed parameter. Spaces will be replaced with a non-breaking space (&nbsp;).
{{{2}}} (optional)
The equave in frequency ratio (if the equave is neither the octave nor the tritave), as the second unnamed parameter. Default is 3/1.