Template:Acap: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
(update documentation)
(remove periods in documentation)
Line 7: Line 7:
'''''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]], with the option to specify a sort key (differing from the default) for the listing 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:" describer 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 paramter:'''
'''Syntax, without any paramter:'''
: <tt><nowiki>{{acap}}</nowiki></tt>
: <tt><nowiki>{{acap}}</nowiki></tt>
which inserts
which inserts
: <tt><nowiki>[[:Category:a cappella|''a cappella'']].<br>[[Category:a_cappella|{{PAGENAME}}]]</nowiki></tt>
: <tt><nowiki>[[:Category:a cappella|''a cappella'']]<br>[[Category:a_cappella|{{PAGENAME}}]]</nowiki></tt>
into a file, appearing as
into a file, appearing as


<font color=blue>''a cappella''</font>.
<font color=blue>''a cappella''</font>
(followed by a linebreak)
(followed by a linebreak)


Line 28: Line 28:


For example,
For example,
: <tt><nowiki>{{acap|, or optional kazoo.}}</nowiki></tt>
: <tt><nowiki>{{acap|, or optional kazoo}}</nowiki></tt>
produces
produces


<font color=blue>''a cappella''</font>, or optional kazoo.
<font color=blue>''a cappella''</font>, or optional kazoo
(followed by a linebreak)
(followed by a linebreak)


Line 37: Line 37:
: <tt><nowiki>{{acap|9=<sort key>}}</nowiki></tt>
: <tt><nowiki>{{acap|9=<sort key>}}</nowiki></tt>
which inserts
which inserts
: <tt><nowiki>[[:Category:a cappella|''a cappella'']].<br>[[Category:a_cappella|<sort key>]]</nowiki></tt>
: <tt><nowiki>[[:Category:a cappella|''a cappella'']]<br>[[Category:a_cappella|<sort key>]]</nowiki></tt>
into a file.
into a file.



Revision as of 07:01, 14 June 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, with the option to specify a sort key (differing from the default) for the listing 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 paramter:

{{acap}}

which inserts

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

into a file, appearing as

a cappella (followed by a linebreak)

Syntax, with an extra information parameter:

{{acap|<value>}}

which inserts

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

into a file, appearing as

a cappella<value> (followed by a linebreak)

For example,

{{acap|, or optional kazoo}}

produces

a cappella, or optional kazoo (followed by a linebreak)

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

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

which inserts

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

into a file.

Syntax with both parameters:

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

which inserts

[[: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 {{PAGENAME}} sort key).

As examples,

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

on the page The Haven (Charles Villiers Stanford) produces

a cappella. (followed by a linebreak)

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

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

on the page The Haven (Charles Villiers Stanford) produces

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.