Template:Voicing: Difference between revisions
Jump to navigation
Jump to search
Documentation
(Thank you Chuck! Expanded last example; corrected next-to-last example) |
(Explanation of format of parameters) |
||
Line 14: | Line 14: | ||
|'''Voicing:''' {{cat|Unknown voicing|{{{3|Unknown}}} }} }}{{#if:{{{add|}}} | , {{{add}}} }}<br></includeonly><noinclude>{{prot-temp}} | |'''Voicing:''' {{cat|Unknown voicing|{{{3|Unknown}}} }} }}{{#if:{{{add|}}} | , {{{add}}} }}<br></includeonly><noinclude>{{prot-temp}} | ||
{{Doc|1= | {{Doc|1= | ||
<big>This template</big> is intended for use in a work page, to display the number of voices and the voicing of the <u>original</u> work. It has two required parameters and two optional parameters. | |||
<u>Parameters</u> | |||
:'''1. Number of voices'''. An integer number (42 or less) or combination of integer numbers with possible punctuation; the letters <tt>vv</tt> will be displayed to the end of what you enter. | |||
:::This parameter is not standardized: but it is recommended to use one integer (e.g., <tt>8</tt> ''or'' <tt>16</tt>), and explain further in following parameters. | |||
:'''2. Identification of parts'''. A string of letters <u>only</u> the letters <tt>B T A S</tt>, with no spaces. It is possible to use one of two punctuation marks within the string: period (.) or comma (,). | |||
::*Periods indicate multiple choirs (e.g., <tt>SSATB.SSATB.SSATB</tt> – three five-voice choirs), which will display as written; in this case, the total number of letters should be the number in the first parameter (15 in the example). | |||
::*Commas indicate optional voicing (e.g., <tt>SAT,SAB,SST</tt>), which will display with <tt>or</tt> between; the number of letters delimited by commas should be the same, which is the number in the first parameter (3 in this example). | |||
:'''3. Optional substitute text'''. Plain text that will display for the category specified in the second parameter. Cannot include a link or a template. | |||
:::Please do not use special characters (such as '''<tt><big><nowiki> & # $ / \ | [ ] </nowiki></big></tt>'''). | |||
:'''<tt>add{{=}}</tt>'''. Text that will display after the voicing. It could include links or templates. Please do not use special characters. | |||
'''Syntax with required <font color="orange">first</font> and <font color="green">second</font> parameters:''' | '''Syntax with required <font color="orange">first</font> and <font color="green">second</font> parameters:''' | ||
Line 41: | Line 52: | ||
===See also=== | ===See also=== | ||
* [[Template:MultiVoicing]] | * [[Template:MultiVoicing]] | ||
* [[Help:Voicing]] | |||
}} | }} | ||
[[Category:Templates]]</noinclude> | [[Category:Templates]]</noinclude> |
Revision as of 18:01, 5 July 2021
This high-risk template has been protected from editing to prevent vandalism. Please use the talk page to ask an administrator about making an edit to change this template. |
This template is intended for use in a work page, to display the number of voices and the voicing of the original work. It has two required parameters and two optional parameters.
Parameters
- 1. Number of voices. An integer number (42 or less) or combination of integer numbers with possible punctuation; the letters vv will be displayed to the end of what you enter.
- This parameter is not standardized: but it is recommended to use one integer (e.g., 8 or 16), and explain further in following parameters.
- 2. Identification of parts. A string of letters only the letters B T A S, with no spaces. It is possible to use one of two punctuation marks within the string: period (.) or comma (,).
- Periods indicate multiple choirs (e.g., SSATB.SSATB.SSATB – three five-voice choirs), which will display as written; in this case, the total number of letters should be the number in the first parameter (15 in the example).
- Commas indicate optional voicing (e.g., SAT,SAB,SST), which will display with or between; the number of letters delimited by commas should be the same, which is the number in the first parameter (3 in this example).
- 3. Optional substitute text. Plain text that will display for the category specified in the second parameter. Cannot include a link or a template.
- Please do not use special characters (such as & # $ / \ | [ ] ).
- add=. Text that will display after the voicing. It could include links or templates. Please do not use special characters.
Syntax with required first and second parameters:
- {{Voicing|5|SSATB}}
- which produces the text
- Number of voices: 5vv Voicing: SSATB
- and inserts the page in category:SSATB
- {{Voicing|3|ATB,SSA,STB}}
- which produces the text
- and inserts the page in category:ATB, category:SSA and category:STB
Syntax with required parameters and optional third parameter
- The third parameter is plain text (no templates or links) which will be the display for the category linked to the second parameter
- {{Voicing|4|SATB|SATB divisi}}
- which produces the text
- Number of voices: 4vv Voicing: SATB divisi
- and inserts the page in category:SATB
Optional 'add' parameter
- Use add=<any text> to append any text (which may include links or templates such as {{Vcat}}); this parameter will display at the end of the voicing specification; e.g.
- {{Voicing|5|SATBB|SATBarB|add=with optional S {{pcat|descant|s}} }}