Help:CPDL Templates

From ChoralWiki
Jump to: navigation, 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. Click on the template names for more details. Text in examples in italics indicates where you should enter a variable, ie. a value which is different depending on the situation.

See also: Category of frequently used templates.

General purpose templates

These templates are found on many different pages.

{{Legend}} A ubiquitous template used on composer and works pages to describe common icons and symbols for obtaining CPDL editions.
{{Broken}} A template used to mark broken links to PDF, MIDI or any other types of files.
{{PermBroken}} A template used to mark permanently broken links to PDF, MIDI or any other types of files.
{{Merge}} A template for marking 2 or more pages to be merged. If necessary, discussion should take place on the article talk page.
{{Split}} A template for marking a page to be split into 2 or more separate pages. If necessary, discussion should take place on the article talk page.
{{Delnow}} A template used to mark a page for immediate deletion.
{{Delreq}} A template used to propose a page for deletion. Discussion should take place on the article talk page.


Composer templates

These templates are usually found on composer pages.

{{NoWorks}} A template to state that there are currently no editions of any works by the composer on CPDL. It should be added to a composer page below {{Legend}} but only for composers whose works are in the public domain.
{{WikipediaLink}} A template to provide a link from a composer page to the article on Wikipedia.
{{WikipediaLink2}} A template to provide a link from a composer page to the article on Wikipedia when all or the majority of the biography on the CPDL page has been copied verbatim from Wikipedia.
{{AffiliateLink}}

{{AffiliateLink2}}

Templates which provide a link to CPDL's affiliate, Sheet Music Plus Use AffiliateLink2 if the composer's works are out of Copyright; use AffiliateLink if only some of the composer's works are out of Copyright.
{{CompCopyrightWarning}} A template to warn users that some or all of the composer's works hosted on or linked from CPDL may not be public domain worldwide.


Music files templates

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

{{Editor|name|date}}
{{Editor|2|name1|name2|date}}
{{Editor|3|name1|name2|name3|date}}
{{Editor|edtype=Contributor|name|date}}
A template which adds a link to the page of the editor (or editors) 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. In the last form, "edtype=Contributor" changes the word "Editor" to "Contributor".
{{ScoreInfo|page size|# pages|kBytes}} 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 edition, 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 have pages, eg. Personal, Religious or ChoralWiki:Public Domain.
{{CopyCC|copyright type}} A variation on {{Copy}} used to add a link to the Creative Commons copyright description for the edition. For example, the template {{CopyCC|Attribution 3.0 Unported}} returns the text Copyright: Creative Commons Attribution 3.0 Unported, which link to the Creative Commons copyright page and scrolls down to the "Attribution 3.0 Unported" anchor. If the specific license is not listed, simply edit the page and add it in the same way as the others.
{{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.
{{KbdVer}} A template used only under the "edition notes" section of a score entry to state that the edition "Includes a keyboard version of the original accompaniment" and add the page to Category:Keyboard version.
{{KbdRed}} A template used only under the "edition notes" section of a score entry to state that the edition "Includes a keyboard reduction of the a cappella choral score" and add the page to Category:Keyboard reduction.
{{FinaleReader}} A template used under the "edition notes" section of a score entry to point users to the Downloadable tools page where they may download Finale Reader, software which will view and print Finale files.
{{NWC}} A template used under the "edition notes" section of a score entry to point users to the Downloadable tools page where they may download NoteWorthy Composer Viewer, software which will view and print NoteWorthy Composer files.

Works templates

These templates are usually found on score pages.

{{Editions|n}} 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 subsequently been partially lost. This is usually placed directly after the Title: and Composer: entries, or alternately at the top of the page.
{{IncompleteEdition}} A template used for an edition that is missing sections.
{{MisattributedWork}}
{{MisattributedWork|comments}}
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 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 Pages awaiting cleanup category.
{{Composer|composer name}} A template used to format the name of the composer, and to generate a category entry (e.g. William Byrd compositions). Currently it is required in order for a work to be included in the online Score catalog.
{{Lyricist|lyricist name}} A template used to format the name of the lyricist, and to generate a category entry (e.g. William Shakespeare settings). This is obviously more useful for lyricists with a large body of work represented on CPDL, but the template should be used even if there is a limited representation.
{{Genre|Sacred|Motets}} A template used to format the entry for the genre of the vocal work. The first field is expected to be either "Sacred" or "Secular"; the second to fourth fields can be any of the various subgenres available. The page is also automatically added to the proper categories. In this example, the categories for such a work will be Sacred music and Motets.
{{Language|language}}
{{Language|2|language1|language2}}
A template used to format the entry for the language of the vocal work, to generate a link to the appropriate category entry (e.g. Italian texts) and to add a category to the score page . Multiple languages are catered for by inserting the number (2 or 3) as the first parameter.
{{Instruments|description}} This template scans the description text for names of instruments (or for a cappella) and automatically categorizes the page under the corresponding categories.
{{CopyrightWarning}} A template to warn users that the work listed on the score page may not be public domain worldwide.

Voicing templates

There are several templates which may be combined to describe the vocal forces called for by a particular work. See also voicing.

{{Voicing|1|T|Unison Tenor}} 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: 1v, 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 T, but the displayed text, Voicing: Unison Tenor is more helpful for reading.
{{MultiVoicing}} This enhanced version of Voicing is intended for works with multiple or complex voicings. Please refer to the template's documentation for the proper syntax.
{{Vcat|voicing}} Vcat simultaneously displays a link to a Voice category (e.g., SATB) and categorizes the page under that category. More importantly, it calculates the number of parts involved and categorizes the work under one of the N-part choral music categories. This information is useful when searching for works with a specific number of parts regardless of voicing. Both templates Voicing and MultiVoicing use Vcat internally, but it can also be used independently or as a complement to Voicing.

Accompaniment templates

These templates are usually found on the "Instruments" line of score pages. See also {{instruments}}, and some other recent additions at Category:Accompaniment templates.

{{acap}} For an a cappella work.
{{BsCont}} For a work with bass continuo accompaniment.
{{BrassAcc}} For a work with brass accompaniment.
{{FluteAcc}} For a work with flute accompaniment.
{{GtrAcc}} For a work with guitar accompaniment.
{{HarpAcc}} For a work with harp accompaniment.
{{HpsichdAcc}} For a work with harpsichord accompaniment.
{{JazzAcc}} For a work with jazz band accompaniment.
{{KbdAcc}} For a work with keyboard accompaniment.
{{KbdRed}} For reductions of a cappella works (See discussion)
{{KbdVer}} For reductions of orchestra accompaniments.
{{LuteAcc}} For a work with lute accompaniment.
{{MxEnsAcc}} For a work with mixed ensemble accompaniment.
{{OrchAcc}} For a work with orchestra accompaniment.
{{OrgAcc}} For a work with organ accompaniment.
{{PercAcc}} For a work with percussion accompaniment.
{{PnoAcc}} For a work with piano accompaniment.
{{StrAcc}} For a work with string ensemble accompaniment.
{{ViolAcc}} For a work with viol consort accompaniment.
{{WindAcc}} For a work with wind ensemble accompaniment.

Image templates

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

{{pdf}} Icon_pdf.gif Portable Document Format (PDF) files.
{{mid}} Icon_snd.gif MIDI sound files.
{{net}} Network.png A link to an external webpage which has links to files.
{{mp3}} Icon_mp3.gif MP3 files.
{{ly}} Icon_ly.gif LilyPond files.
{{Capx}} Logo_capella-software_kurz_2011_16x16.png Capella files.
{{mp4}} Icon_vid2.gif MP4 videos.
{{extpdf}} Icon_pdf_globe.gif A direct link to a PDF hosted on an external site.
{{extmid}} Icon_snd_globe.gif A direct link to a MIDI hosted on an external site.
{{extmp3}} Icon_mp3_globe.gif A direct link to an MP3 hosted on an external site.
{{extly}} Icon_ly_ext.png A direct link to a LilyPond file hosted on an external site.

Text & translation templates

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

{{Text|language}}
{{Text|2|language1|language2}}
{{Text|3|language1|language2|language3}}
A template to use when the text for a work is available on a given page. Macaronic text can also be represented with this template, as shown in the other examples. Using this template automatically causes the page to be listed under the Category:Texts and under the specific Language texts category. If more than one language is informed, it is also included in Category:Macaronic texts.
{{Translation|language}} A template to use when the translation for a work is available on a given page (use the above template for the original text). Using this template automatically causes the page to be listed under the Category:Translations and under the specific Language translations category. 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}}
{{MassText|Requiem}}
A specialized example of LinkText, only for use with score pages of masses, or mass movements. Requiem masses usually have a different set of mass movements, and the extra parameter Requiem should be used to denote these.
{{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. It adds the page to Category:Text requests.
{{NoTranslation|language}} This template is used to request a translation (e.g. English or any other language) which has not yet been provided. It adds the page to Category:Translation requests.

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|SATB|SATB divisi}} A template for adding a page to a given category using the first variable (in this case, Category:SATB) and to create a link to that category, using the second variable for the displayed text (in this case, SATB divisi).
{{Pcat|Mass|es}} A template for creating a link to a given category, using the first variable (that should be the category name in singular form) for the displayed text, and to add the page to that category using both variables concatenated (singular category name plus plural suffix: Mass+es: Category:Masses). This is due to the fact that a page being categorized to a term such as [[Mass]] should actually refer to the category [[:Category:Masses]]; however it is grammatically incorrect to categorise a single item by the plural, so this template would link to the plural category Masses, but display the singular item Mass.
{{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).
{{NoMelody}} A template which should be present on all hymn tune pages which have not yet had their melody added with the LilyPond extension. The template adds the page to Category:LilyPond requests and should be removed when the melody is added.
{{CompCatTxt}} A template which should be added to all compositions by composer subcategories to provide the generic descriptive text.
{{WksLangTxt}} A template which should be added to all works by language subcategories to provide the generic descriptive text.
{{VoicingCatTxt}} A template which is applied to some voicing subcategories to provide the generic descriptive text.


This page is part of the CPDL Help system.
View main help index