Help:Score submission guide: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
{{DisplayBox|bgcolor=#ddffdd|text=<font color="red">'''WARNING'''</font>. '''This page is a draft - work in progress.'''}}
{{DisplayBox|bgcolor=#ddffdd|text=<font color="red">'''WARNING'''</font>. '''This page is a draft - work in progress.'''}}
<div style="float:right; margin: 0em 0em 0em 1em">__TOC__</div>
==Quick start==
::''To see more details, see [[Help:Score submission guide/Detailed description]]''


===A. Before connecting to CPDL===
===Choose a link:===
* ''[[Help:Score submission guide/Quick start|Quick start]]'' – Summary instructions for new or inexperienced users.
* ''[[Help:Score submission guide/Detailed description|Detailed descriptions]]'' – Automated add-score process in detail.
* ''[[Help:Score submission guide/Traditional method|Traditional method]]'' – For those who wish to add their own wiki code to composer pages.
* ''[[Help:Score submission guide/File and page titles|File name and page titles]]'' – Suggestions for file names, limits on characters, etc.


# In your music transcription software, edit your score the way you want it.
===Introduction and explanation===
# Save it using a short, unique file name.
# Save PDF, MID, and MXL files of your score.


===B. Add work to CPDL===
A key element of the automated process is the automation of composer pages, that are automatically updated whenever a new work is added. This automation is based on a specific function, named ''SortWorks'', which automatically lists all works by a certain composer according to certain criteria (e.g., by creating separate lists for sacred vs. secular music). Please note that not all composer pages have been automated using the ''SortWorks'' function: some composer pages are still maintained manually, so, whenever a new work by that composer is added, the title of the new work and the link to the relevant work page have to be added manually, by doing copy-and-paste of some wiki code, as it was necessary before the automated process was introduced. You can recognize the automated composer pages by the presence of the <nowiki>{{SortWorks}}</nowiki> function in the wiki code of the page. See [[Help:Automating the work list on composer pages]] for details about the automation of composer pages and about the use of the ''SortWorks'' function.


# Log in to CPDL.
If you added a new work and the composer page is already automated, the new work title should be automatically displayed on the page. It is possible that the work title is erroneously displayed twice, both in the main list and in the list under "Other works not listed above" at the bottom. It's a side effect ot the wiki cache, because not enough time has elapsed for the cache to refresh. You can force a cache refresh by clicking on <tt>Edit</tt> followed by <tt>Save changes</tt>, or by adding <tt><nowiki>?action=purge</nowiki></tt> to the URL of the page. You may have to do this twice to obtain that the cache is completely refreshed.
# Search for composer in search bar; also search in [[:Category:Composers]]. Look also for alternate spellings of composer's name.
# Open a few works by the composer, to get ideas about how to format a work page.
# If composer is found, migrate to composer page, and look for your work. If your work is found, migrate to work page, and click on "Add new edition" tab. If work is not found, click on "Add new work" on composer page.
# If composer is not found, migrate to any composer page, click on "Add new work".
# Complete the AddWork form. Required items in '''bold'''.
## '''Title of work'''. Use a short title that is distinguishable from others. Avoid special characters.
## Name of composer. First_name Last_name; don't change it unless you are adding a new composer (composer not found in search above). If more than one, leave blank.
## Name of lyricist. Choose name from [[:Category:Lyricists]]. If more than one, leave blank.
## '''Name of editor/contributor'''. Your real name.
## '''Email of editor/contributor'''. Your e-mail address in full.
## Publish my e-mail address. Leave unchecked.
## '''Genre'''. Select "Sacred" or "Secular".
## Subgenre. Select from dropdown menu; leave blank if unsure or unknown.
## '''Number of voices'''. Integer number from 1 to 26.
## '''Voicing'''. String of letters using only S, A, T, or B. Punctuate with "." to separate choirs.  
## Year of first publication. Integer number; can. begin with "ca. " or "post " as needed.
## '''Language'''. Choose one from dropdown menu; if more than one, leave field blank.
## Composer's time period. Leave as is; automatically populated.
## Orchestration. Choose from dropdown menu; choose "A cappella" if unaccompanied.
## Notes about musical composition.
## '''Sheet music format'''. Leave it "PDF".
## '''Sheet music location'''. Leave blank, click "Upload file now", migrate to PDF file on your computer; close tab when finished.
## Size of PDF file. Automatically populated.
## Number of pages. Automatically populated.
## Midi file (give URL, or name file). Leave blank, click "Upload file now", migrate to MID file on your computer; close tab when finished.
## MP3 file (give URL, or name of file). Leave blank.
## Music notation file (give URL, or name or file). Leave blank, click "Upload file now", migrate to MXL file on your computer; close tab when finished.
## Music notation program (only list if you are making the notation file available). Automatically populated.
## Notes about edition.
## '''Copyright type'''. Choose one from dropdown menu. Choose "CPDL" if not sure.
## External web links. Leave for later.
## '''Your email address'''. Give your email address again.
## Do not automatically add wiki code. Leave unchecked.
# When you click "submit", wait … you will return to composer page.


===C. Edit work page===
If you added a new work and the composer page is not automated, you have to manually copy-and-paste the wiki code fragment that links to the new work page. You'll have received the wiki code fragment via email. You have to use the wiki code fragment under "Composer entry (this entry appears on the composer page, please copy/paste the line below, under List of works)", and you have to copy-and-paste it to the correct location on the page, depending on the composer page structure.


# On composer page, click your new work, and edit it.
Composer pages newly created will lack much relevant information (birth and death dates, biography, etc.). You are invited to edit the page, adding any missing data.
# Items that may need editing:
## Add your own transcription file to the list of files.
## If more than one composer or lyricist, change <tt><nowiki>{{Composer|}}</nowiki></tt> to <tt><nowiki>{{Composer|2|<name1>|<name2>}}</nowiki></tt>.
## Add Edition notes or Description.
## Add text; either link to a text page: <tt><nowiki>{{LinkText|<pagename>}}</nowiki></tt> or Type in text: <tt><nowiki>{{Text|<language>|<Text>}}</nowiki></tt>
## If title of work starts with an article adjective, put at the bottom: <tt><nowiki>{{DEFAULTSORT:{{WorkSorter}}}}</nowiki></tt>
# Click "Show preview". Change items that need editing before saving changes.
# If composer is new, there will be a link next to the composer's name; click it and go to the next section.


===D. Edit composer page===
If your files are already stored on external servers, we recommend that you upload them to CPDL anyway, in order to avoid eventual broken links. But if you prefer not to, then please enter the relevant links (full URL beginning with ''http://'') and the applicable details (file type, size, page size, number of pages, etc.) because the system cannot automatically detect such information on externally stored files.


# Open composer page. Make sure your work is included; if the page has been automated, you should see your work in its place.
If you are more familiar with the traditional process and you don't want the work page and/or the composer page to be updated automatically, please select the checkbox "Do not automatically add wiki code to the pages, I will do it manually" at the bottom of the form. You will receive by email the wiki code fragments that would have been normally sent to you if you followed the traditional process. You will have to manually copy-and-paste the wiki code fragments on the work page, and also on the composer page if the composer page is not automated already.
# If composer is new:
## Fill in birth and death dates.
## Write (or copy) short biography.
## Add publications, if known.
## At bottom of page, edit birth, death, era, and nationality information.
# Click "Show preview".  Change items that need editing before saving changes.


When all required fields are complete, click on the "Add works data" button at the bottom of the form. The composer page, newly created or amended, according to the work/edition added, will be shown to you  after a few seconds. If you selected the checkbox "Do not automatically add wiki code to the pages, I will do it manually" you will be also returned to the composer page, so that you can amend it using the wiki code fragments sent to you via email. The email with the wiki fragments will be sent to you in all cases, also if you did not select the checkbox "Do not automatically add wiki code to the pages, I will do it manually", for your records.


<!--
Contributors who are not familiar with editing wiki pages may stop at this point. All users who are familiar with editing wiki pages are encouraged to perform the next steps also for the contributions of other users.
==Adding new edition information==
During the process to add a new work or to add a new edition to an existing work, a form, named "Add work form", is presented to you. Below is a list of the elements of the page with explanatory information:
<br>
{|border="1" cellpadding="5" cellspacing="0"
|-
| '''Description'''
| '''Explanation'''
| '''Required?'''
|-
| Title of work
| The work title. Capitalize only the first letter and any proper nouns, eg. "The Lord Christ comes quickly". Include the opus number in this box in the following format: <tt>Work_title,_Op._n,_No._n</tt> or <tt>Work_title,_Op._n</tt> (where the underscores are spaces and "n" is a number). This field is automatically filled if you are adding a new edition of an existing work.
| Required
|-
| Name of composer (First_name Last_name)
| Use the '''exact''' name that appears on the composer page, with the same amount of spaces, also including any special character(s). This field is automatically filled unless you are entering the first work/edition for a new composer, where you will have to delete the pre-defined value and enter the name of the new composer.
| Required
|-
| Name of lyricist (First_name Last_name)
| The name of the lyricist.
| Optional, but strongly recommended
|-
| Name of editor/contributor (First_name Last_name)
| The name of the editor/contributor for the edition being submitted (that does not necessarily corresponds with the name of the person who is submitting the edition).
| Required
|-
| Email of editor/contributor
| Please include the email address of the editor/contributor to use if we have any questions about the edition submitted.
| Required
|-
| Publish my email address (if it's not already listed) on my Editor Page and, if applicable, my Composer Page
| Check this box if the email address of the editor/contributor can be published on the editor/contributor page.
| Optional
|-
| Genre
| Select "Sacred" or "Secular" from the drop down list. This may be automatically filled by the system when adding a new edition of an existing work.
| Optional, but strongly recommended
|-
| Subgenre
| Select from the drop down list. If the subgenre of the score isn't there, select the one closest to it - there will be an opportunity to change it later. This may be automatically filled by the system when adding a new edition of an existing work.
| Optional, but strongly recommended
|-
| Number of voices (i.e. 4)
| Type the number of voices (for an SATB choir, this would be 4). This may be automatically filled by the system when adding a new edition of an existing work.
| Optional, but strongly recommended
|-
| Voicing (i.e. SATB)
| Type the voicing. Use the abbreviations "S", "A", "T", "B" for Soprano, Alto, Tenor and Bass. For Baritone, use "B" and for Treble, use "S". In the case of more than one choir, use a period to separate them, eg. "SATB.SATB". This may be automatically filled by the system when adding a new edition of an existing work.
| Optional, but strongly recommended
|-
| Year of first publication
| Enter this information if you know it. This may be automatically filled by the system when adding a new edition of an existing work.
| Optional, but strongly recommended
|-
| Language
| Select the language of the work's lyrics from the drop down menu.
| Optional, but strongly recommended
|-
| Composer's time period
| Select from the drop down list. This may be automatically filled by the system based on known composer information. For a new composer, you may have to delete the pre-defined value and enter the actual time period of the new composer.
| Optional, but strongly recommended
|-
| Orchestration
| List the instruments in the work (other than voices). Type "none, a cappella" if there aren't any.
| Optional, but strongly recommended
|-
| Notes about musical composition
| Type here specific notes about the original work.
| Optional
|-
| Sheet music format (default is 'PDF')
| Pick the format of the primary image score file from the drop down list. This field is automatically filled if you upload the file to the server (see next) and the system is able to automatically recognize the file format.
| Required
|-
| Sheet music location (give URL, or name of file)
| Click on the "Upload now" button to upload the sheet music file to the server. The file location will be automatically filled in by the system. If you want to link a file stored on an external server, enter the URL of the file (you must include the full URL including "http://").
| Required
|-
| Page size (select one)
| If you uploaded the sheet music file to server, the system will try to detect the page size and automatically fill this field. If the automatic detection fails, or if you linked a file stored on an external server, select the page size from the drop down list.
| Optional
|-
| Number of pages
| If you uploaded the sheet music file to server, the system will try to detect the number of pages and automatically fill this field. If the automatic detection fails, or if you linked a file stored on an external server, enter the number of pages in the box.
| Optional
|-
| Size of PDF file (in kbytes)
| If you uploaded the sheet music file to server, the system will try to detect the file size and automatically fill this field. If the automatic detection fails, or if you linked a file stored on an external server, enter the file size in the box.
| Optional
|-
| Midi file (give URL, or name file)
| Click on the "Upload now" button to upload the midi file to the server. The file location will be automatically filled in by the system. If you want to link a file stored on an external server, enter the URL of the file (you must include the full URL including "http://").
| Optional
|-
| MP3 file (give URL, or name of file)
| Click on the "Upload now" button to upload the mp3 file to the server. The file location will be automatically filled in by the system. If you want to link a file stored on an external server, enter the URL of the file (you must include the full URL including "http://").
| Optional
|-
| Music notation file (give URL, or name or file)
| Click on the "Upload now" button to upload the music notation file to the server. The file location will be automatically filled in by the system. If you want to link a file stored on an external server, enter the URL of the file (you must include the full URL including "http://").
| Optional
|-
| Interchange (.mxl) or notation software formats (only list if you are making the file available)
| If you uploaded the Interchange or music notation file to server, the system will try to detect the file format and automatically fill this field. If the automatic detection fails, or if you linked a file stored on an external server, choose the file format from the drop down list.
| Optional
|-
| Notes about edition
| Enter specifics about your edition of the work, eg. transposition or arrangement details.
| Optional
|-
| Copyright type (see links below for license details)
| Select "CPDL" to licence your edition under the [[ChoralWiki:CPDL|CPDL licence]], or select one of the Creative Commons licenses, or select "Personal" to specify your own copyright conditions (the should be described in detail on the editor/contributor personal page). The "Public domain" selection should be only used for editions made by others, typically many years ago, where the copyright terms on that specific edition are expired.
| Required
|-
| External web links
| Enter appropriate links for the work in question, if you know of any.
| Optional
|-
| Your email address
| Enter your email address (i.e., the email address of the person that is submitting the edition, which does not necessarily corresponds to the email address of the editor/contributor) where we should direct questions about this upload. It will not be included in the page code and will remain private.
| Required
|-
| Do not automatically add wiki code to the pages, I will do it manually
| Check this box only in the case you don't want that the system automatically adds information about the new work/edition in the wiki pages. See next about details about the process to manually add those information.
| Optional
|}
<br>Now, if the form is complete, click on the button marked "Add works data" at the bottom of the page to submit the form.
'''Please do not submit the form more than once for the same edition unless you have been advised to do so by an admin.''' This is important because a unique CPDL number is generated each time the form is submitted and this number becomes obsolete if the form is run a second time for the same edition. If you forgot to include some information in the form the first time you submitted it, you may edit the work page that the system has automatically created or updated, or email "addscore (at) cpdl.org" with the details, so that the add score team may help you fixing any issues.


==Adding the wiki code for a new edition==
If you selected the checkbox "Do not automatically add wiki code to the pages, I will do it manually", the work page is not automatically created or updated, therefore you will have to manually create or update it using the wiki code fragment that you'll have received via email. It's the wiki code fragment shown under "Works entry (this should appear on the works page,copy all material below except for the last line of text)".
'''This section only applies if you selected the checkbox "Do not automatically add wiki code to the pages, I will do it manually".'''


:1. An email is automatically sent to your email address (as previously entered in the "Add work form"). Copy the single line of code after "Composer entry (this entry appears on the composer page, please copy/paste the line below, under 'List of works')" in the email. Pay attention to select the whole line of text if it is very long.
:2. Check if the title of the work is present already on the composer page. Most composer pages are automated, so new work titles show up automatically. In this case, this step can be omitted. If the title is not present already, paste the line previously copied into the composer page. Most composer pages are simply a list of links to works in alphabetical order but some are organised by genre and a small minority are organised by opus or the appropriate catalogue number. It should be obvious where your new work listing should be placed but if you are unsure, email "addscore (at) cpdl.org" providing the rekevant information.
This guide now splits into two parts depending on the situation of your work on CPDL. If your edition is the first edition of the work to be submitted to CPDL, you will need to make a new works page - follow the left hand column, "a". If your new edition is not the first edition of the work to be submitted to CPDL, then there will already be an entry on the composer page - follow the right hand column, "b".
<center>'''Adding the works entry code'''</center>
{|border="0" cellpadding="10" cellspacing="0"
|-valign="top"
|width="45%"|3a. If you pasted the wiki code into the composer page, the work title will be displayed on the composer page as a red link, because the corresponding work page does not exist yet. Now, make a new work page for your work, by clicking on the newly made red link on the composer page. When the new page appears, go back to the email you received and select all of the code after "Works entry (this should appear on the works page, copy all material below except for the last line of text)". Now paste the code into the new page. Press the "Show preview" button to see what your page will look like, fix any typos and click "Show preview" again until you are happy with the new work page. Now type an appropriate edit summary and click "Save page" to save the new work page on the CPDL Wiki.
|width="55%"|3b. Add your edition information to an existing works page. To do this, click on the link on the composer page corresponding to the work page you want to add your edition to. When the works page comes up, click on the "edit" tab at the top of the page. At the top of the page will be the following code: "<tt><nowiki>==Music files== {{Legend}}</nowiki></tt>". Below this, leave an empty line then copy and paste the edition information only from the code produced by the add work form. The edition information is the code which begins "<tt><nowiki>*{{NewWork|yyyy-mm-dd}} '''CPDL</nowiki></tt>..." and ends <tt><nowiki>:'''Edition notes:'''</nowiki></tt>. Click "Show preview" to see what your page will look like, fix any typos, click "Show preview" again until you are happy with the work page you are modifying. Then type an appropriate edit summary in the box then click "Save page" to save your modified work page on the CPDL Wiki.
|}
:4. Return to the composer page. Test the new link from the composer page by clicking on it. You will see your new works page or your new edition on an old works page.
:5. If your work page is new, check the categories at bottom of page for broken links. Broken links on a wiki appear as red rather than blue. There will be one category link that is and should be broken. This category will be in the format yyyy-mm-dd, today's date. If there are any other category links or other links which are broken, please try to fix them if you believe that you have made a typing error. If you believe that the spelling is correct, however, edit the page and at the top type the following: "<tt><nowiki>{{Cleanup|</nowiki>''reason''}}</tt>" where <tt>''reason''</tt> is "link to category not yet created" or "link to page not yet created". Save the page with the "Summary" box containing the following text: "Page needs cleanup".
:6. Try each link for the files that you have added, such as PDF, MIDI and notation file to ensure that they point to the appropriate file. If any of the links are broken, try to fix it but if you can't, email "addscore (at) cpdl.org" with the details, so that the add score team may help you fixing any issues.
==Help if you can't complete these instructions==
Please email "addscore (at) cpdl.org" or post a message to the forums.
==What to include in your edition==
For information about what to include in your edition and tips on improving readability of your score, see [[Help:The_perfect_edition|this page]].
-->
{{help}}
{{help}}
[[Category:CPDL how-to]]
[[Category:CPDL how-to]]

Revision as of 16:12, 10 July 2020


WARNING. This page is a draft - work in progress.

Choose a link:

Introduction and explanation

A key element of the automated process is the automation of composer pages, that are automatically updated whenever a new work is added. This automation is based on a specific function, named SortWorks, which automatically lists all works by a certain composer according to certain criteria (e.g., by creating separate lists for sacred vs. secular music). Please note that not all composer pages have been automated using the SortWorks function: some composer pages are still maintained manually, so, whenever a new work by that composer is added, the title of the new work and the link to the relevant work page have to be added manually, by doing copy-and-paste of some wiki code, as it was necessary before the automated process was introduced. You can recognize the automated composer pages by the presence of the {{SortWorks}} function in the wiki code of the page. See Help:Automating the work list on composer pages for details about the automation of composer pages and about the use of the SortWorks function.

If you added a new work and the composer page is already automated, the new work title should be automatically displayed on the page. It is possible that the work title is erroneously displayed twice, both in the main list and in the list under "Other works not listed above" at the bottom. It's a side effect ot the wiki cache, because not enough time has elapsed for the cache to refresh. You can force a cache refresh by clicking on Edit followed by Save changes, or by adding ?action=purge to the URL of the page. You may have to do this twice to obtain that the cache is completely refreshed.

If you added a new work and the composer page is not automated, you have to manually copy-and-paste the wiki code fragment that links to the new work page. You'll have received the wiki code fragment via email. You have to use the wiki code fragment under "Composer entry (this entry appears on the composer page, please copy/paste the line below, under List of works)", and you have to copy-and-paste it to the correct location on the page, depending on the composer page structure.

Composer pages newly created will lack much relevant information (birth and death dates, biography, etc.). You are invited to edit the page, adding any missing data.

If your files are already stored on external servers, we recommend that you upload them to CPDL anyway, in order to avoid eventual broken links. But if you prefer not to, then please enter the relevant links (full URL beginning with http://) and the applicable details (file type, size, page size, number of pages, etc.) because the system cannot automatically detect such information on externally stored files.

If you are more familiar with the traditional process and you don't want the work page and/or the composer page to be updated automatically, please select the checkbox "Do not automatically add wiki code to the pages, I will do it manually" at the bottom of the form. You will receive by email the wiki code fragments that would have been normally sent to you if you followed the traditional process. You will have to manually copy-and-paste the wiki code fragments on the work page, and also on the composer page if the composer page is not automated already.

When all required fields are complete, click on the "Add works data" button at the bottom of the form. The composer page, newly created or amended, according to the work/edition added, will be shown to you after a few seconds. If you selected the checkbox "Do not automatically add wiki code to the pages, I will do it manually" you will be also returned to the composer page, so that you can amend it using the wiki code fragments sent to you via email. The email with the wiki fragments will be sent to you in all cases, also if you did not select the checkbox "Do not automatically add wiki code to the pages, I will do it manually", for your records.

Contributors who are not familiar with editing wiki pages may stop at this point. All users who are familiar with editing wiki pages are encouraged to perform the next steps also for the contributions of other users.

If you selected the checkbox "Do not automatically add wiki code to the pages, I will do it manually", the work page is not automatically created or updated, therefore you will have to manually create or update it using the wiki code fragment that you'll have received via email. It's the wiki code fragment shown under "Works entry (this should appear on the works page,copy all material below except for the last line of text)".

This page is part of the CPDL Help system.
View main help index
Retrieved from "https://www.cpdl.org/wiki/index.php?title=Help:Score_submission_guide&oldid=1153042"