Template:MultiPubList

From ChoralWiki
Jump to navigation Jump to search
Documentation

THIS TEMPLATE calls template {{MPList}}; the description below includes both.

This template is for use on a Music publication page. This template requires the use of the template {{Pub}} on all work pages belonging to this publication.

This template produces a table listing all the works that have links to the publication within the template {{Pub}} on their work pages. This table will be automatically updated, so users do not have to manually add works.

Syntax: {{MultiPubList|<code1>,<code2>,…,<coden>|YYYY}}

where <codei> is one of the codes below (comma-delimited, in any order), and YYYY is the year that the publication was first issued (shown on the publication page as the first parameter within template {{PubDatePlace}} (REQUIRED).
Code Output
seq Sequence no. in publication
pg Page number(s) in publication
com Composer
arr Arranger
lyr Lyricist
gen Genre
subg Subgenre
subg2 Subgenre 2
yr Year of (earliest) publication
lan Language
first First Line
instr Instruments
met Meter
vo Number of voices
voices Voices
Sample template calls Columns produced
{{MultiPubList|com,arr,gen,subg,vo,voices}} Title | Composer | Arranger | Genre | Subgenre | No. Voices | Voices
{{MultiPubList|seq,com,gen,subg,vo,voices}} Sequence | Title | Composer | Arranger | Genre | Sungrnere | No. Voices | Voices
{{MultiPubList|com,arr,subg,vo,met}} Title | Composer | Arranger | Subgenre | No. Voices | Meter
{{MultiPubList|first,gen,subg,arr,vo}} Title | First Line | Subgenre | Arranger | No. Voices

Columns in the table depend on what the first code (<code1>) is:

<code1> Columns (* = sorted column)
seq* No. ¦ Title ¦ <code2> ¦ <code3> ¦ …
(other) Title* ¦ <code1> ¦ <code2> ¦ …

Sorting. If seq is is the first code (<code1>), sequence number appears as the first column in the table, and the table is sorted (numerically) on sequence number. If no= is specified on work pages as anything but an number, the table will sort alphabetically by sequence; please use another system for expressing sequence. Sequence systems that sort correctly:

  • 1, 2, 3, 4, 5, 6, 7, 8, 9.01, 9.02, 9.03, 9.04, 9.05, 9.06, 9.07, 9.08, 9.09, 9.10, 10, 11 – Decimal numbers have always the same number of decimal digits
  • A01, A02, A03, B10, B11, B12, B13 – all values have the same number of characters

On the other hand, the following sequence systems will not sort correctly:

  • 1, 2, 3, 4, 5, 6-7, 8, 9-10, 11, 12, 13, 14 – will sort 1, 11, 12, 13, 14, 2, 3, 4, 5, 6-7, 8, 9-10 – alphabetically
  • A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A20 – will sort A1, A10, A11, A12, A13, A14, A2, A20, A3, A4, A5, A6. A7, A8, A9

Please do not click the sort arrows for the sequence column; this will cause the column to sort alphabetically (1,10,100,101,102,11,12,13,14,15,16,17,18,19,2,20,21,…); refresh the page to get the native sort back. If the first code is something other than seq then the first column is the work title, in which case the table is sorted by work Title, using sort keys as specified in {{DEFAULTSORT:{{NameSorter}}}} on the work pages.

Guidelines for title of a Music publication page can be found here.

The second parameter is required; enter the year of publication. This must be a four-digit year. Pad years before 1000 with zeroes, as "0870" or "0033". If the code yr is used in the MultiPubList template, then the second parameter of the {{Pub|1}} template must have a four-digit value on all work pages belonging to the publications.

IF THERE ARE MULTIPLE BOOKS IN THE SAME PUBLICATION, such as Editions, Volumes, Parts, etc.: Please use the Template {{Volumes}} – see the description of that template for more details. In that case, a command such as {{MultiPubList|yr,com,lyr,gen,subg,vo}} (notice no second parameter) will yield several tables, one for each book specified in the {{Volumes}} command.

(Version 17b – 2020-11-22)