Difference between revisions of "Template:Drum corps show summary/doc"

From blackwiki
Jump to navigation Jump to search
imported>Gamma Metroid
(→‎Parameter descriptions: added note about historic classes)
imported>Gamma Metroid
(added documentation for state parameter, minor additions)
Line 6: Line 6:
 
<pre>{{Drum corps show summary
 
<pre>{{Drum corps show summary
 
|noheader    =
 
|noheader    =
 +
|state      =
 
|corps name  =
 
|corps name  =
  
Line 43: Line 44:
 
== Parameter list ==
 
== Parameter list ==
 
{{Drum corps show summary
 
{{Drum corps show summary
 +
|state      = uncollapsed
 
|corps name  = {{{corps name}}}
 
|corps name  = {{{corps name}}}
  
Line 67: Line 69:
 
:; ''noheader''
 
:; ''noheader''
 
:: This template only allows for ten years of show summaries. To add more, see [[#Additional years|below]].
 
:: This template only allows for ten years of show summaries. To add more, see [[#Additional years|below]].
 +
:; ''state''
 +
:: By default, the template will be collapsed when transcluded into an article. This can be overridden by setting this parameter to <code>uncollapsed</code>. In most cases, the show summary takes up sufficient space to warrant it being collapsed by default, but very short summaries may not need to be.
 
:; ''corps name''
 
:; ''corps name''
 
:: It is recommended to use a short version of the name rather than a longer version. For example, use "The Cavaliers" and not "The Cavaliers Drum and Bugle Corps".
 
:: It is recommended to use a short version of the name rather than a longer version. For example, use "The Cavaliers" and not "The Cavaliers Drum and Bugle Corps".
Line 80: Line 84:
 
* Selection 1 by Composer 1
 
* Selection 1 by Composer 1
 
* Selection 2 by Composer 2
 
* Selection 2 by Composer 2
 +
* Selection 3 by Composer 3
 
</pre>
 
</pre>
 
::which yields:
 
::which yields:
 
{{Drum corps show summary
 
{{Drum corps show summary
 +
|state = uncollapsed
 
|corps name = Example Regiment
 
|corps name = Example Regiment
  
Line 91: Line 97:
 
* Selection 1 by Composer 1
 
* Selection 1 by Composer 1
 
* Selection 2 by Composer 2
 
* Selection 2 by Composer 2
 +
* Selection 3 by Composer 3
 
}}
 
}}
:: Even when there is only one selection used in the show, using this format prevents unnecessary line breaks in the repertoire. The list '''will''' allow line breaks within items.
+
:: Even when there is only one selection used in the show, using this format prevents unnecessary line breaks in the repertoire. The list '''will''' allow line breaks within items due to a limitation of the hlist class.
 
:; ''source<sub>n</sub>''
 
:; ''source<sub>n</sub>''
 
:; ''composer<sub>n</sub>''
 
:; ''composer<sub>n</sub>''
Line 122: Line 129:
 
::yields:
 
::yields:
 
{{Drum corps show summary
 
{{Drum corps show summary
 +
|state      = uncollapsed
 
|corps name  = Blue Example
 
|corps name  = Blue Example
  
Line 154: Line 162:
 
yields:
 
yields:
 
{{Drum corps show summary
 
{{Drum corps show summary
 +
|state      = uncollapsed
 
|corps name  = Blue Example
 
|corps name  = Blue Example
  

Revision as of 01:46, 24 March 2014

Usage

Please remove all parameters that are left blank.

{{Drum corps show summary
|noheader    =
|state       =
|corps name  =

|year1       =
|class1      =
|altclass1   =
|title1      =
|rep1        =
|score1      =
|altscore1   =
|place1      =
|altplace1   =

|year2       =
|class2      =
|altclass2   =
|title2      =
|rep2        =
|score2      =
|altscore2   =
|place2      =
|altplace2   =

...

|year10      =
|class10     =
|altclass10  =
|title10     =
|rep10       =
|score10     =
|altscore10  =
|place10     =
|altplace10  =
}}

Parameter list

{{{corps name}}} Show Summary
Year Class Title Repertoire Score Placement
{{{year1}}} {{{class1}}} {{{title1}}}

{{{rep1}}}

{{{score1}}} {{{place1}}}

Below are the most commonly used parameters. See below for a full list.

corps name – the name of the corps, e.g. "The Cadets". Leaving this parameter blank will use the name of the page.
yearnthe year of the show
classnthe class the corps competed in during that year
titlenthe title of the show
repnthe repertoire of the show
scorenthe score of the show at finals
placenthe placement of the show at finals

Parameter descriptions

Effectively, all of the parameters of this template are optional, and leaving them all blank will result in only the column headings being rendered. Rows are added based on whether the year parameter has a value, so the row will not display if all parameters except the year are filled out.

noheader
This template only allows for ten years of show summaries. To add more, see below.
state
By default, the template will be collapsed when transcluded into an article. This can be overridden by setting this parameter to uncollapsed. In most cases, the show summary takes up sufficient space to warrant it being collapsed by default, but very short summaries may not need to be.
corps name
It is recommended to use a short version of the name rather than a longer version. For example, use "The Cavaliers" and not "The Cavaliers Drum and Bugle Corps".
yearn
The year of the show. If this parameter has no value assigned, the row will not display.
classn
Be sure to use the class that the corps competed in during that year. For a score and placement received in another class (for example, an Open class corps competing at World prelims) use altclassn, altscoren, and altplacen. For all historic classes, add (historic) to it, which is displayed by the following code: ([[Drum Corps International#Historic classes and divisions|historic]]).
titlen
The title is always bolded, so there is no need to bold the value assigned to this parameter.
repn
The table uses the hlist class, so the repertoire is best displayed in this form:
* Selection 1 by Composer 1
* Selection 2 by Composer 2
* Selection 3 by Composer 3
which yields:
Example Regiment Show Summary
Year Class Title Repertoire Score Placement
1989 Open (historic) Example Title
  • Selection 1 by Composer 1
  • Selection 2 by Composer 2
  • Selection 3 by Composer 3

Even when there is only one selection used in the show, using this format prevents unnecessary line breaks in the repertoire. The list will allow line breaks within items due to a limitation of the hlist class.
sourcen
composern
If all selections in a show come from one source, use these parameters. Assigning a value only to composer will result in a new line below the repertoire consisting of "All selections by composer". Assigning a value to both composer and source will result in a new line consisting of "All selections from source by composer". Assigning a value only to source will display no result.
scoren
The score of the show at the finals performance of that year. Defaults to —.
placen
The placement of the show at the finals performance of that year. Entering a value of "1st" will automatically bold the placement. Defaults to —.
altclassn
altscoren
altplacen
Use these parameters when a corps competes in more than one class in one year. Example:
{{Drum corps show summary
|corps name  = Blue Example

|year1       = 2007
|class1      = Open
|title1      = Example Title
|rep1        = 
* Example Repertoire
|altclass1   = World
|score1      = 96.45
|altscore1   = 83.05
|place1      = 2nd
|altplace1   = 23rd
}}
yields:
Blue Example Show Summary
Year Class Title Repertoire Score Placement
2007 Open Example Title

Example Repertoire

96.45 Template:Won
World 83.05 23rd

Additional years

To display more than 10 years of show summaries, simply nest another instance of this template at the end of the first one with the noheader parameter set to true. The parameter will have no effect with any other value. Do not add an extra line break after the last parameter in the "outside" instance of the template. The final place (or altplace, if necessary) parameter in the "outside" instance of the template must be set in this case, or the rows will display improperly. If there is no value to enter, set it to the default value (—). Example:

{{Drum corps show summary
|corps name  = Blue Example

|year1       = 2005
|class1      = Open
|place1      = —
{{Drum corps show summary
|noheader    = true

|year1       = 2006
|class1      = World
}}
}}

yields:

Blue Example Show Summary
Year Class Title Repertoire Score Placement
2005 Open

No information

2006 World

No information