Help:Score submission guide: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
(Partial edit)
(more...)
Line 11: Line 11:
|-
|-
| Title of work
| 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.
| 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
| Required
|-
|-
Line 31: Line 31:
|-
|-
| Publish my email address (if it's not already listed) on my Editor Page and, if applicable, my Composer Page
| 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/contributot page.
| Check this box if the email address of the editor/contributor can be published on the editor/contributor page.
| Optional
| Optional
|-
|-
| Genre
| Genre
| Select "Sacred" or "Secular" from the drop down list.
| 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
| Optional, but strongly recommended
|-
|-
| Subgenre
| 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.
| 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
| Optional, but strongly recommended
|-
|-
| Number of voices (i.e. 4)
| Number of voices (i.e. 4)
| Type the number of voices (for an SATB choir, this would be 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
| Optional, but strongly recommended
|-
|-
| Voicing (i.e. SATB)
| 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"
| 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
| Optional, but strongly recommended
|-
|-
| Year of first publication
| Year of first publication
| Enter this information if you know it.
| 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
| Optional, but strongly recommended
|-
|-
Line 59: Line 59:
|-
|-
| Composer's time period
| Composer's time period
| Select from the drop down list.
| 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
| Optional, but strongly recommended
|-
|-
Line 111: Line 111:
|-
|-
| Copyright type (see links below for license details)
| 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 specific copyright conditions (the should be specified 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.
| 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
| Required
|-
|-
Line 126: Line 126:
| Optional
| Optional
|}
|}
<br>
<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.
<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.
'''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.
Line 135: Line 133:


: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.
: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. 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.
: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".
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 composer entry code'''</center>
{|border="0" cellpadding="10" cellspacing="0"
|-valign="top"
|width="45%"|3a. Paste the code that you copied in the previous step into a new line at the appropriate place on the composer page, then, type an appropriate edit summary in the box at the bottom of the page and click "Save page".
|width="55%"|3b. Move the cursor to the end of the score entry which already exists. Below is an example of the code:<br><tt><nowiki>*''[[Alegres mudanzas (Francisco Valls)|Alegres mudanzas]]''</nowiki> &amp;nbsp; <span style="color: red">( <nowiki>[{{filepath:Valls-Alegres mudanzas.pdf}} {{pdf}}] [{{filepath:Valls-Alegres mudanzas.mid}} {{mid}}] [{{filepath:Valls-Alegres mudanzas.sib}} Sibelius 2]</nowiki> )</span></tt><br>
Now delete the code which is coloured red in the example above. Next, type the following text: "{{tl|editions|n}}" where n is the number of editions that will be available on the score page including yours. In the example above, the resultant code would be:<br><tt><nowiki>*''[[Alegres mudanzas (Francisco Valls)|Alegres mudanzas]]'' &amp;nbsp; {{editions|n}}</nowiki></tt>
|}
<center>'''Adding the works entry code'''</center>
<center>'''Adding the works entry code'''</center>
{|border="0" cellpadding="10" cellspacing="0"
{|border="0" cellpadding="10" cellspacing="0"
|-valign="top"
|-valign="top"
|width="45%"|4a. Now, make a new works 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 original output of code from the add work form and select all of the code from "<tt>==Music files==</tt>" to the last line which would be something like "<tt><nowiki>[[Category:Romantic music]]</nowiki></tt>". 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 works page. Now type an appropriate edit summary and click "Save page" to save the new works page on the CPDL Wiki.
|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%"|4b. 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.
|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.
|}
|}
:5. 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.
: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.
:6. If your works 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".
: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".
:7. 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, use the cleanup template as explained in the previous step to alert an admin to the error.
: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==
==Help if you can't complete these instructions==
''"I give up! I'm a musician, not a computer scientist! All I wanted to do is post my %^$%#$ score. What ever happened to the old CPDL site?" (and similar frustrations)''
Please email "addscore (at) cpdl.org" or post a message to the forums.
 
#Computers can be very frustrating. Take a deep breath -- we at CPDL can add your scores for you.
#Log into the [[ChoralWiki:CPDL support, help, and feedback|CPDL support, help, and feedback]]. (You must have a CPDL.org login and be logged in to post messages.)
#Click on <b>General topics</b>, then click the Edit link to the right of General Topics to post your request. Indicate the subject of your request, such as Please Upload My Score. Paste into the big text box the URLs of your uploaded files, or your remote website file URLs. Include the code created by the add work form if you are able to do so.
#An admin will do all the posting work, and leave a reply below your posting to let you know it's done.


==What to include in your edition==
==What to include in your edition==

Revision as of 20:03, 7 July 2020

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

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:

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: Work_title,_Op._n,_No._n or Work_title,_Op._n (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 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


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

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".

Adding the works entry code
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. 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: "==Music files== {{Legend}}". 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 "*{{NewWork|yyyy-mm-dd}} '''CPDL..." and ends :'''Edition notes:'''. 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: "{{Cleanup|reason}}" where reason 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 this page.

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