Template:CompCatTxt: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
(tweak)
(tweaks and revise documentation to reflect parameter changes)
Line 1: Line 1:
This is category provides a {{switch|{{{complete}}}|case: yes=complete|case: no=partial|default=partial}} list of the works on CPDL by {{{1|<composer given name(s)>}}} {{{2|<composer surname>}}}, sorted alphabetically by title of the works pages. For the composer page itself{{switch|{{{sort|none}}}
This category provides a {{switch|{{{complete}}}|case: yes=complete|case: no=partial|default=partial}} list of the works on CPDL by {{{1|<composer given name(s)>}}} {{{2|<composer surname>}}}, sorted alphabetically by title of the works pages. For the composer page itself{{switch|{{{sort|none}}}
|case: none=,
|case: none=,
|default=, with works sorted by {{{sort}}},}} [[{{{1}}} {{{2}}}|click here]].
|default=, with works sorted by {{{sort}}},}} [[{{{1}}} {{{2}}}|click here]].
Line 7: Line 7:
<center><big>'''Documentation'''</big></center>
<center><big>'''Documentation'''</big></center>


This template is for adding the generic descriptive information for [[:Category:Compositions by composer|compositions by composer categories]]. There are four parameters: the first two are required and the is optional.
This template is for adding the generic descriptive information for [[:Category:Compositions by composer|compositions by composer categories]]. There are four parameters: the first two are required and the other two are optional.


'''Syntax with the first two parameters only:'''
'''Syntax eample, with the first two parameters only:'''
: <tt><nowiki>{{CompCatTxt|John|Dowland}}</nowiki></tt>
<pre>{{CompCatTxt|John|Ireland}}</pre>
which inserts
which inserts
: <tt><nowiki>This is category lists the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, [[John Dowland|click here]].</nowiki></tt>
: <tt><nowiki>This category provides a partial list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, [[John Ireland|click here]].</nowiki></tt>
into a file, appearing as
into a file, appearing as


:This is category lists the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, <font color=blue>click here</font>.
:This category provides a partial list of the works on CPDL by John Ireland, sorted alphabetically by title of the works pages. For the composer page itself, <font color=blue>click here</font>.


'''Syntax examples, with additional parameters: sort=<sortmethod>, complete=yes/no (default=no)'''
<pre>{{CompCatTxt|John|Dowland|sort=publication}}</pre>
which inserts
: <tt><nowiki>This category provides a partial list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, [[John Dowland|click here]].</nowiki></tt>
into a file, appearing as
:This category provides a partial list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, <font color=blue>click here</font>.


'''Syntax with all parameters:'''
<pre>{{CompCatTxt|John|Dowland|sort=publication|complete=yes}}</pre>
: <tt><nowiki>{{CompCatTxt|John|Dowland|publication}}</nowiki></tt>
which inserts
which inserts
: <tt><nowiki>This is category lists the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, [[John Dowland|click here.</nowiki></tt>
: <tt><nowiki>This category provides a complete list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, [[John Dowland|click here]].</nowiki></tt>
into a file, appearing as
into a file, appearing as


:This is category lists the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, <font color=blue>click here</font>.
:This category provides a complete list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, <font color=blue>click here</font>.
 
<pre>{{CompCatTxt|John|Ireland|complete=yes}}</pre>
which inserts
: <tt><nowiki>This category provides a complete list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, [[John Ireland|click here]].</nowiki></tt>
into a file, appearing as


:This category provides a complete list of the works on CPDL by John Ireland, sorted alphabetically by title of the works pages. For the composer page itself, <font color=blue>click here</font>.
1
'''To summarize:'''  Omitting sort=<sortmethod> leaves out the phrase "with works sorted by <sortmethod>," - and either omitting complete=yes or setting complete=no makes the description start "This category provides a partial list..." = while setting complete=yes makes the description start "This category provide a complete list..."
</div>
</div>
</noinclude>
</noinclude>

Revision as of 12:37, 12 September 2008

This category provides a partial list of the works on CPDL by <composer given name(s)> <composer surname>, sorted alphabetically by title of the works pages. For the composer page itself, [[{{{1}}} {{{2}}}|click here]].



Documentation

This template is for adding the generic descriptive information for compositions by composer categories. There are four parameters: the first two are required and the other two are optional.

Syntax eample, with the first two parameters only:

{{CompCatTxt|John|Ireland}}

which inserts

This category provides a partial list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, [[John Ireland|click here]].

into a file, appearing as

This category provides a partial list of the works on CPDL by John Ireland, sorted alphabetically by title of the works pages. For the composer page itself, click here.

Syntax examples, with additional parameters: sort=<sortmethod>, complete=yes/no (default=no)

{{CompCatTxt|John|Dowland|sort=publication}}

which inserts

This category provides a partial list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, [[John Dowland|click here]].

into a file, appearing as

This category provides a partial list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, click here.
{{CompCatTxt|John|Dowland|sort=publication|complete=yes}}

which inserts

This category provides a complete list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, [[John Dowland|click here]].

into a file, appearing as

This category provides a complete list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, with works sorted by publication, click here.
{{CompCatTxt|John|Ireland|complete=yes}}

which inserts

This category provides a complete list of the works on CPDL by John Dowland, sorted alphabetically by title of the works pages. For the composer page itself, [[John Ireland|click here]].

into a file, appearing as

This category provides a complete list of the works on CPDL by John Ireland, sorted alphabetically by title of the works pages. For the composer page itself, click here.

1 To summarize: Omitting sort=<sortmethod> leaves out the phrase "with works sorted by <sortmethod>," - and either omitting complete=yes or setting complete=no makes the description start "This category provides a partial list..." = while setting complete=yes makes the description start "This category provide a complete list..."