Difference between revisions of "Template:Acap"

From ChoralWiki
Jump to navigation Jump to search
m (Protected "Template:Acap": system template [edit=sysop:move=sysop])
(removed obsolete sortkey)
Line 1: Line 1:
[[:Category:a cappella|''a cappella'']]
+
[[:Category:A cappella|''a cappella'']]
<includeonly>[[Category:a_cappella]]</includeonly><noinclude>[[Category:Templates|{{PAGENAME}}]]<br>
+
<includeonly>[[Category:A cappella]]</includeonly><noinclude>[[Category:Templates|{{PAGENAME}}]]<br>
 
<div><div style="margin: 0; margin-right: 30px; margin-left: 30px; border: 1px solid #1188ff; padding: 1em 1em 1em 1em; background-color:#ddffdd">
 
<div><div style="margin: 0; margin-right: 30px; margin-left: 30px; border: 1px solid #1188ff; padding: 1em 1em 1em 1em; background-color:#ddffdd">
 
<center><big>'''Documentation'''</big></center>
 
<center><big>'''Documentation'''</big></center>
  
 
This template is for specifying a work as being '''''a cappella''''', or possibly  
 
This template is for specifying a work as being '''''a cappella''''', or possibly  
'''''a cappella'' with extra information'''. In every instance, page is categorized in [[:Category:a cappella]], with the option to specify a sort key (differing from the default) for the listing in [[:Category:a cappella]].
+
'''''a cappella'' with extra information'''. In every instance, page is categorized in [[:Category:A cappella]].
  
 
'''Note:''' this template supercedes [[Template:a cappella]] because it operates in the same way as other accompaniment templates (ie. it doesn't include the "Instruments:" designator before "a cappella").
 
'''Note:''' this template supercedes [[Template:a cappella]] because it operates in the same way as other accompaniment templates (ie. it doesn't include the "Instruments:" designator before "a cappella").
  
'''Syntax, without any parameters:'''
+
;Syntax, without any parameters:
: <tt><nowiki>{{acap}}</nowiki></tt>
+
* <tt><nowiki>{{acap}}</nowiki></tt>
which inserts
+
:which inserts
: <tt><nowiki>[[:Category:a cappella|''a cappella'']][[Category:a_cappella|{{PAGENAME}}]]</nowiki></tt>
+
:: <tt><nowiki>[[:Category:A cappella|''a cappella'']][[Category:A cappella]]</nowiki></tt>
into a file, appearing as
+
:into a file, appearing as
 +
::<font color=blue>''a cappella''</font>
  
<font color=blue>''a cappella''</font>
+
;Syntax, with an extra information parameter:
 +
* <tt><nowiki>{{acap|<value>}}</nowiki></tt>
 +
:which inserts
 +
:: <tt><nowiki>[[:Category:A cappella|''a cappella'']]<value>[[Category:A cappella]]</nowiki></tt>
 +
:into a file, appearing as
 +
:: <font color=blue>''a cappella''</font><value>
  
'''Syntax, with an extra information parameter:'''
+
;Examples:
: <tt><nowiki>{{acap|<value>}}</nowiki></tt>
+
* <tt><nowiki>{{acap|, or optional kazoo}}</nowiki></tt>
which inserts
+
:produces
: <tt><nowiki>[[:Category:a cappella|''a cappella'']]<value>[[Category:a_cappella|{{PAGENAME}}]]</nowiki></tt>
+
:: <font color=blue>''a cappella''</font>, or optional kazoo
into a file, appearing as
 
  
<font color=blue>''a cappella''</font><value>
+
* <tt><nowiki>{{acap|, with optional {{PnoAcc|piano}} accompaniment.}}<br></nowiki></tt>
 
+
:produces
For example,
+
:: <font color=blue>''a cappella''</font>, with optional <font color=blue>piano</font> accompaniment
: <tt><nowiki>{{acap|, or optional kazoo}}</nowiki></tt>
+
:Note that in this last example the [[Template:PnoAcc]] gets expanded properly.
produces
 
 
 
<font color=blue>''a cappella''</font>, or optional kazoo
 
 
 
'''Syntax with a sort key parameter (and no extra information parameter):'''
 
: <tt><nowiki>{{acap|9=<sort key>}}</nowiki></tt>
 
which inserts
 
: <tt><nowiki>[[:Category:a cappella|''a cappella'']][[Category:a_cappella|<sort key>]]</nowiki></tt>
 
into a file.
 
 
 
'''Syntax with both parameters:'''
 
: <tt><nowiki>{{acap|<value>|9=<sort key}}</nowiki></tt>
 
which inserts
 
: <tt><nowiki>[[:Category:a cappella|''a cappella'']]<value>[[Category:a_cappella|<sort key>]]</nowiki></tt>
 
into a file.
 
 
 
In both of these latter two instances, the page is sorted in [[:Category:a cappella]] with <sort key> as the the sort key (instead of the default <nowiki>{{PAGENAME}}</nowiki> sort key).
 
 
 
As examples,
 
: <tt><nowiki>{{acap|9=Haven, The (Charles Villiers Stanford))}}<br></nowiki></tt>
 
on the page [[The Haven (Charles Villiers Stanford)]] produces
 
 
 
<font color=blue>''a cappella''</font>
 
 
 
with the page sorted under "H" rather than under "T".  Or,
 
: <tt><nowiki>{{acap|, with optional {{PnoAcc|piano}} accompaniment.|9=Haven, The (Charles Villiers Stanford))}}<br></nowiki></tt>
 
on the page [[The Haven (Charles Villiers Stanford)]] produces
 
 
 
<font color=blue>''a cappella''</font>, with optional <font color=blue>piano</font> accompaniment
 
 
 
Again, the page is sorted in [[:Category:a cappella]] under "H" rather than under "T". 
 
 
 
'''Note:''' In this last example the [[Template:PnoAcc]] gets expanded properly.
 
  
 
</div>
 
</div>
 
</noinclude>
 
</noinclude>

Revision as of 13:28, 15 December 2008

a cappella

Documentation

This template is for specifying a work as being a cappella, or possibly a cappella with extra information. In every instance, page is categorized in Category:A cappella.

Note: this template supercedes Template:a cappella because it operates in the same way as other accompaniment templates (ie. it doesn't include the "Instruments:" designator before "a cappella").

Syntax, without any parameters
  • {{acap}}
which inserts
[[:Category:A cappella|''a cappella'']][[Category:A cappella]]
into a file, appearing as
a cappella
Syntax, with an extra information parameter
  • {{acap|<value>}}
which inserts
[[:Category:A cappella|''a cappella'']]<value>[[Category:A cappella]]
into a file, appearing as
a cappella<value>
Examples
  • {{acap|, or optional kazoo}}
produces
a cappella, or optional kazoo
  • {{acap|, with optional {{PnoAcc|piano}} accompaniment.}}<br>
produces
a cappella, with optional piano accompaniment
Note that in this last example the Template:PnoAcc gets expanded properly.