Template:Acap

From ChoralWiki
Revision as of 12:27, 4 April 2008 by CHGiffen (talk | contribs) (add documentation on optional second parameter 2=<sort key>)
Jump to navigation Jump to search

Instruments: 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, with the option to specify a sort key (differing from the default) for the listing in Category:a cappella.

Syntax, without any paramter:

{{acap}}

which inserts

'''Instruments:''' [[:Category:a cappella|''a cappella'']].<br>[[Category:a_cappella|{{PAGENAME}}]]

into a file, appearing as

Instruments: a cappella. (followed by a linebreak)

Syntax, with an extra information parameter:

{{acap|<value>}}

which inserts

'''Instruments:''' [[:Category:a cappella|''a cappella'']]<value><br>[[Category:a_cappella|{{PAGENAME}}]]

into a file, appearing as

Instruments: a cappella<value> (followed by a linebreak)

For example,

{{acap|, or optional kazoo.}}

produces

Instruments: a cappella, or optional kazoo. (followed by a linebreak)

Syntax with a sort key parameter (and no extra information parameter):

{{acap|2=<sort key>}}

which inserts

'''Instruments:''' [[:Category:a cappella|''a cappella'']].<br>[[Category:a_cappella|<sort key>]]

into a file.

Syntax with both parameters:

{{acap|<value>|<sort key}}

which inserts

'''Instruments:''' [[:Category:a cappella|''a cappella'']]<value><br>[[Category:a_cappella|<sort key>]]

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 Acap sort key).

As examples,

{{acap|2=Haven, The (Charles Villiers Stanford))}}<br>

on the page The Haven (Charles Villiers Stanford) produces

Instruments: a cappella. (followed by a linebreak)

with the page sorted under "H" rather than under "T". Or,

{{acap|, with optional {{PnoAcc|piano}} accompaniment.|Haven, The (Charles Villiers Stanford))}}<br>

on the page The Haven (Charles Villiers Stanford) produces

Instruments: a cappella, with optional piano accompaniment. (followed by a linebreak)

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.