Template:Scale link/doc: Difference between revisions

(8 intermediate revisions by one other user not shown)

Line 1:

~~For example~~, ~~instead of having~~ to type~~, for example,~~ <code>[<nowiki />[4L 5s (3/1-equivalent)|4L 5s]]</code>, you can type <code>{<nowiki />{scale link|4L 5s|~~3/1~~}}</code>.

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]]</nowiki></code> or <code><nowiki>[[4L&nbsp;5s]]</nowiki></code>.

=== Parameters ===

; <code><nowiki>{{{1}}}</nowiki></code> (required)

: The scale (in terms of L and s intervals), as the first unnamed parameter

: The scale (in terms of L and s intervals, e.g. <code>5L 2s</code>), as the first unnamed parameter. Spaces will be replaced with a non-breaking space (<code>&nbsp;</code>).

; <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.

@@ Line 1: / Line 1: @@
 {{dochead}}
-For example, instead of having to type, for example, <code>[<nowiki />[4L 5s (3/1-equivalent)|4L 5s]]</code>, you can type <code>{<nowiki />{scale link|4L 5s|3/1}}</code>.
+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&nbsp;5s]] scale, just type <code><nowiki>[[4L&nbsp;5s]]</nowiki></code> or <code><nowiki>[[4L&amp;nbsp;5s]]</nowiki></code>.
+{{shortcut|sl}}
 === Parameters ===
 ; <code><nowiki>{{{1}}}</nowiki></code> (required)
-: The scale (in terms of L and s intervals), as the first unnamed parameter
+: The scale (in terms of L and s intervals, e.g. <code>5L&nbsp;2s</code>), as the first unnamed parameter. Spaces will be replaced with a non-breaking space (<code>&amp;nbsp;</code>).
 ; <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.