Help:CPDL Templates

From ChoralWiki
Revision as of 00:21, 25 September 2007 by Pml (talk | contribs) (+ Image templates)
Jump to navigation Jump to search

This is a shorthand reference to the most useful templates that exist on CPDL; for exact syntax and usage, there may be a discussion page associated with the particular template.

General purpose templates

These templates are found on many different pages.

{{Legend}} A ubiqitous template used on composer and works pages to describe common icons and symbols for obtaining CPDL editions.

Composer templates

These templates are usually found on composer pages.

Works templates

These templates are usually found on score pages.

{{2editions}} A series of templates used to mark works that have more than one edition. This is not for counting the number of files, but only the number of separate editions on a given page. Similarly named templates exist for works with 3, 4, and more editions available.
{{UnfinishedWork}} A template used for a work that a composer did not complete, or has been partially lost subsequently.
{{IncompleteEdition}} A template used for an edition that is missing sections.
{{MisattributedWork}} A template used for a work which has been attributed to a composer incorrectly. This is an aid for users who may not know the correct composer. This template adds the work in question to the Category:Misattributed compositions category.
{{Cleanup|errors}} A template used on a page that has broken formatting, or incorrect or missing information. A short description of the problems with the page may be entered after the vertical bar. This template adds the work in question to the Category:Pages awaiting cleanup category.
{{BrahmsScores}} A template used for further categorizing a composer's works (in this case, Brahms, other composer templates may be created in the future). Most comonly used when one wishes to organize compositions in two different ways (i.e. alphabetically and by opus/catalog number).

Music files templates

These templates are usually found on score pages under the music files heading.

{{Editor|name|date}} A template which adds a link to the page of the editor who has added a score, and likewise the date the score was added to CPDL. This is usually placed on the line directly after the CDPL # entry which provides links to the score itself.
{{ScoreInfo|Page size|# of pages|File size}} A template used to format the information about a score: the size of paper used, the number of pages, and download size. This usually follows straight after the Editor template above; e.g., {{ScoreInfo|A4|2|20}} returns the text Score information: A4, 2 pages, 20 kbytes
{{Copy|copyright type}} A template used to add a link to the copyright description for the vocal work, this usually follows directly after the ScoreInfo template above. For example, the template {{Copy|CPDL}} returns the text Copyright: CPDL, which link to the CPDL copyright page; several other types of copyright are linked (e.g. Personal).
{{Edition}} A simple template used to format the text Edition notes: on a new line.
{{ScoreError|errors}} A template used for adding a note to a particular edition, describing a musical error in the score. A short discussion of the error(s) may be added after the vertical bar; a large number of errors should be reported separately in the linked discussion page. This template adds the work in question to the Category:Sheet music errors category.

Image templates

Self explanatory templates for generating icons for PDF, MIDI files, and the like.

{{Pdf}} Icon_pdf.gif Portable Document Format files.
{{Mid}} Icon_snd.gif MIDI sound files.
{{Net}} Network.png Files located on websites externally of the CPDL site.

General information templates

These templates are usually found on score pages under the general information heading.

{{UnfinishedWork}} A template used for a work that a composer did not complete. This is usually placed directly after the Title: and Composer: entries, or alternately at the top of the page.
{{Composer|William Byrd}} A template used to format the name of the composer, and to generate a category entry (in this case, it adds the work to the category William Byrd compositions). This is obviously more useful for composers with a large body of work represented on CPDL; there is little point assigning a category for composers with a handful of works.
{{Voicing|1|T|Tenor solo}} A template used to format the entry for the voicing of the vocal work. The first field generates the start of the line, Number of voices: 1vv, and the second and third fields generate a link to the appropriate category entry, and the text to be displayed. The page is also automatically added to the category. In this case, the correct category for such a work is Category:T, but the displayed text, Voicing: Tenor solo is more helpful for reading.
{{Language|Italian}} A template used to format the entry for the language of the vocal work, and to generate a link to the appropriate category entry (in this case, it creates a link to the category Italian texts). Multiple languages are catered for by inserting the number (2 or 3) as the first parameter, e.g. {{Language|2|French|German}}.

Text/translation templates

These templates may be on score pages, or on text pages.

{{Text|Latin}} A template to use when the text for a work is available on a given page. The variable Latin can be replaced with any language. Using this template automatically causes the page to be listed under the Category:Texts-translations category.
{{Translation|English}} A template to use when the translation for a work is available on a given page (use the above template for the original text). The variable English can be replaced with any language. If a work is set in the original language and a translated language, use the {{Text|Language}} template.
{{LinkText|Ave Maria}} A template that is used when a text and/or translation for a work exists on a different page. This is commonly used when several works have the same text. The variable Ave Maria should be replaced by the title of the page with the actual text/translation.
{{MassText}} A specialized example of LinkText, only for use with score pages of masses, or mass movements.
{{NoText}} This template appears often on score pages, and is for a work which does not have the text available in an easily copied format.
{{NoTranslation|English}} This template is used to request a translation (e.g. English or any other language) which does not exist yet.

Other miscellaneous templates

{{CatAZ}} A template for adding an alphabetical link list (from A to Z) to facilitate jumping to the appropriate letter in a long list; this is very useful for categories with very large numbers of items.
{{Cat|Motets|Motet}} A template for adding a page to a given category using the first variable (in this case, Category:Motets) and to create a link to that category, using the second variable for the displayed text. This is due to the fact that unlike some Wiki implementations, more often a Wiki link to a term such as [[Motet]] should actually refer to the category, [[:Category:Motets]]; however it is grammatically incorrect to categorise a single item by the plural, so this template would link to the plural category Motets, but display the singular item Motet.
{{Disambig}} A template for disambiguation pages (e.g. to avoid confusion when composers or works have the same name). The template adds the page to Category:Disambiguation.
{{Psalm table|x–1|x|x+1}} A template which adds a table of links to all 150 chapters of the book of Psalms, and includes special links, to the current psalm (x), and usually the immediate preceding (x–1) and following psalms (x+1).