Help:Automated add score process: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
(Updated to reflect recent changes to the process)
Line 2: Line 2:
The new, automated add score process, introduced in October 2013, is intended to simplify the process of adding a new score edition to ChoralWiki, especially for those users who are unfamiliar with adding and editing wiki code inside composer and work pages. Using this process, the composer and the work pages are automatically created or updated, without the user being required to do it manually.
The new, automated add score process, introduced in October 2013, is intended to simplify the process of adding a new score edition to ChoralWiki, especially for those users who are unfamiliar with adding and editing wiki code inside composer and work pages. Using this process, the composer and the work pages are automatically created or updated, without the user being required to do it manually.


Furthermore, this process allows any registered user (not just the administrators) to refine submissions that the automatic process may not have handled perfectly.
The traditional add score process required instead to copy-and-paste one fragment of wiki code into the composer page, and another fragment of wiki code into the work page. Users who are more familiar with the traditional process can still use it by clicking a specific checkbox available on the submission form. See details hereinbelow (steps 5 to 7).


For example, the list of works on some composer pages is ordered alphabetically by title, while on other composer pages works are grouped into "sacred" and "secular", or into collections. The automatic process cannot accommodate all these alternatives, so it simply places a new work entry at the first place on the list. Users sufficiently familiar with wiki editing should then move the new work entry to the appropriate position on the page.
A key element of the automated process is the automation of composer pages, that automatically update whenever a new work is added. This automation is based on a specific function, named 'SortWorks', which automaticalli lists all works by a certain composer according to certain criteris (e.g., by creating separate lists for sacred vs. secular music. Please note that not all composer pages have been automated using the 'SortWorks' functions: 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 has 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.
 
Similarly, if a new edition of an existing work is added, a "multiple editions available" label should be added or updated.
 
All registered users who are sufficiently familiar with editing wiki pages are encouraged to help refine composer pages and work pages created/amended automatically.


Please contact the administrators through the [https://forums.cpdl.org CPDL user forums] for any problems or suggestions. Note: the forum does not use the same account as on the main cpdl.org site, so it requires creating an account specificalliy for the forums if you haven't already done so.
Please contact the administrators through the [https://forums.cpdl.org CPDL user forums] for any problems or suggestions. Note: the forum does not use the same account as on the main cpdl.org site, so it requires creating an account specificalliy for the forums if you haven't already done so.
Line 14: Line 10:
==Step 1: Locating the composer page==
==Step 1: Locating the composer page==


Click on ''[[:Category:Composers|Composer pages]]'' in the navigation list on the left of the screen, then on the first letter of the composer's surname. If the composer name does not appear on the list, a new composer page will need to be created. To do it, just go to any existing composer page and click on the "Add new work" tab on the top-right part of the page. Then, in the "Add new work" form, replace the "Composer name" and the "Composer's time period" with the name and time period of the new composer. Then go to step 2.
Click on ''[[:Category:Composers|Composer pages]]'' in the navigation list on the left of the screen, then on the first letter of the composer's surname. If the composer name does not appear on the list, a new composer page will need to be created. To do it, just go to any existing composer page and click on the "Add new work" tab on the top-right part of the page. Then, in the "Add new work" form that opens, replace the "Composer name" and the "Composer's time period" with the name and time period of the new composer. Then go to step 2.


If the composer already appears in the list of composers, open the composer page and check if the same work is listed already. If it is, click on the work title and go to step 3. Otherwise, click on the "Add new work" tab at the top right of the page. This will open the "Add new work" form, with the "Composer name" and the "Composer's time period" fields already filled in. Now go to step 2.
If the composer already appears in the list of composers, open the composer page and check if the same work is listed already. If it is, click on the work title and go to step 3. Otherwise, click on the "Add new work" tab at the top right of the page. This will open the "Add new work" form, with the "Composer name" and the "Composer's time period" fields already filled in. Now go to step 2.
Line 22: Line 18:
Fill in the other fields of the form down to the "Files Section" (excluded) with the relevant information. See the [[Help:Score_submission_guide#Adding_new_edition_information|Score submission guide - Adding new edition information]] for details. Then go to step 4.
Fill in the other fields of the form down to the "Files Section" (excluded) with the relevant information. See the [[Help:Score_submission_guide#Adding_new_edition_information|Score submission guide - Adding new edition information]] for details. Then go to step 4.


==Step 3: Adding a new edition==
==Step 3: Adding a new edition of an existing work==
Click on the <b>"Add new edition" tab on the top-right part of the page</b>. This will open the "Add new work" form where some fields (work title, composer name, work genre/subgenre, composer's time period) are filled automatically with the information present already in the work page. Make any manual changes necessary, for example, to voicing.
After having clicked on the work title present already on the composer page, click on the <b>"Add new edition" tab on the top-right part of the page</b>. This will open the "Add new work" form where some fields (work title, composer name, work genre/subgenre, composer's time period) are filled automatically with the information present already in the work page. Make any manual changes necessary (for example, the edition that you are adding may have a different voicing with respect to editions present already).


==Step 4: Uploading files or entering links to externally hosted files==
==Step 4: Uploading files or entering links to externally hosted files==
If you wish your files (pdf, midi, mp3, etc.) to be stored on the CPDL servers, you will need to upload them. Click on the "Upload now" buttons present on the "Add new work" form. This will open a file upload window that you can use to upload files. See [[Help:Score_submission_guide#Uploading_files|Score submission guide - Uploading files]] for details. The system will try to automatically detect the file types and fill in the appropriate fields of the "Add new work" form accordingly. Please check the data entered, and update them if necessary. You can close the file upload window(s) after all files are uploaded.
If you wish your files (pdf, midi, mp3, etc.) to be stored on the CPDL servers, you will need to upload them. Click on the "Upload now" buttons present on the "Add new work" form. This will open a file upload window that you can use to upload files. See [[Help:Score_submission_guide#Uploading_files|Score submission guide - Uploading files]] for details. The system will try to automatically detect the file types and fill in the appropriate fields of the "Add new work" form accordingly. Please check the data entered, and update them if necessary. You can close the file upload window(s) after all files are uploaded.


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.).
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 try to detect such information on externally store files.


==Step 5: Completing and submitting the "Add new work" form==
==Step 5: Completing and submitting the "Add new work" form==


Please fill in the remaining fields of the "Add new work" form (notes about the edition, copyright, external web links, your email address - see [[Help:Score_submission_guide#Adding_new_edition_information|Score submission guide - Adding new edition information]] for details) and 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 in a new window after a few seconds. The "Add new work" form remains open if you need to check any data on it. You can close it if you don't need it any more.
Please fill in the remaining fields of the "Add new work" form (notes about the edition, copyright, external web links, your email address - see [[Help:Score_submission_guide#Adding_new_edition_information|Score submission guide - Adding new edition information]] for details).
 
If are more familiar with the traditional process and you don't want that the work page and/or the composer page are 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 be 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 autmated already.


You will also receive an email summarizing your submission. You can retain a copy of it for your records.
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 in a new window after a few seconds. The "Add new work" form remains open if you need to check any data on it. You can close it if you don't need it any more. 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.
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.
Line 40: Line 38:
==Step 6: Checking and refining the composer page==
==Step 6: Checking and refining the composer page==


Composer pages created or amended automatically are traced through the category ''[[:Category:Pages_with_recent_additions|Pages with recent additions]]''. Work entries yet to be reviewed and refined are clearly identified on the composer page by a text in italics that reads "''The next work entry has been recently added automatically ...''". Please cut-and-paste the work entry line so that it is moved to the appropriate position within the works list according to the work ordering adopted on the specific composer page. Then remove the ''<nowiki>{{Recent additions}}</nowiki>'' template. This will remove the page from the list of pages yet to be reviewed, and the text "''The next work entry has been recently added automatically ...''" is not displayed any more.
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 of missing works 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 cahe 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.


If a new edition has been added to an existing work page, you may delete the line after the ''<nowiki>{{Recent additions}}</nowiki>'' template, and amend the already existing work entry so that the multiple editions template ''<nowiki>{{editions|n}}</nowiki>'' is applied. You may wish to assign the correct value of "n" according to the number of editions actually available.
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, it's the wiki code 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.


If the work list on the composer page is automated already (see [[Help:Automating_the_work_list_on_composer_pages|Automating the work list on composer pages]]) the work entry should be already automatically shown at the appropriate position, so you can just delete the line after the ''<nowiki>{{Recent additions}}</nowiki>'' template. Then also remove the ''<nowiki>{{Recent additions}}</nowiki>'' template.
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.


You can also consider to automate the work list on the composer page if not automated already.
==Step 7: Checking and refining the work page==


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.
While on the composer page, please click on the work title of the work you added (or you added a new edition to). The automatic process should have added the new edition information as the first edition in the list if other editions were present already. Please correct anything that the automatic process was unable to handle properly.


==Step 7: Checking and refining the work page==
If you selected the checkbox "Do not automatically add wiki code to the pages, I will do it manually", the work page was 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 shown under "Works entry (this should appear on the works page,copy all material below except for the last line of text)".


Click on the work title of the newly added (or amended) work entry to open that page. The new edition information should have been automatically added as the first edition in the list. Please correct anything that the automatic process was unable to handle properly.
Check that everything is correct on the page, including especially the links to the files that you uploaded or linked from external websites.


[[Category:Help]]
[[Category:Help]]

Revision as of 16:44, 4 July 2020

Introduction

The new, automated add score process, introduced in October 2013, is intended to simplify the process of adding a new score edition to ChoralWiki, especially for those users who are unfamiliar with adding and editing wiki code inside composer and work pages. Using this process, the composer and the work pages are automatically created or updated, without the user being required to do it manually.

The traditional add score process required instead to copy-and-paste one fragment of wiki code into the composer page, and another fragment of wiki code into the work page. Users who are more familiar with the traditional process can still use it by clicking a specific checkbox available on the submission form. See details hereinbelow (steps 5 to 7).

A key element of the automated process is the automation of composer pages, that automatically update whenever a new work is added. This automation is based on a specific function, named 'SortWorks', which automaticalli lists all works by a certain composer according to certain criteris (e.g., by creating separate lists for sacred vs. secular music. Please note that not all composer pages have been automated using the 'SortWorks' functions: 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 has 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.

Please contact the administrators through the CPDL user forums for any problems or suggestions. Note: the forum does not use the same account as on the main cpdl.org site, so it requires creating an account specificalliy for the forums if you haven't already done so.

Step 1: Locating the composer page

Click on Composer pages in the navigation list on the left of the screen, then on the first letter of the composer's surname. If the composer name does not appear on the list, a new composer page will need to be created. To do it, just go to any existing composer page and click on the "Add new work" tab on the top-right part of the page. Then, in the "Add new work" form that opens, replace the "Composer name" and the "Composer's time period" with the name and time period of the new composer. Then go to step 2.

If the composer already appears in the list of composers, open the composer page and check if the same work is listed already. If it is, click on the work title and go to step 3. Otherwise, click on the "Add new work" tab at the top right of the page. This will open the "Add new work" form, with the "Composer name" and the "Composer's time period" fields already filled in. Now go to step 2.

Step 2: Adding a new work

Fill in the other fields of the form down to the "Files Section" (excluded) with the relevant information. See the Score submission guide - Adding new edition information for details. Then go to step 4.

Step 3: Adding a new edition of an existing work

After having clicked on the work title present already on the composer page, click on the "Add new edition" tab on the top-right part of the page. This will open the "Add new work" form where some fields (work title, composer name, work genre/subgenre, composer's time period) are filled automatically with the information present already in the work page. Make any manual changes necessary (for example, the edition that you are adding may have a different voicing with respect to editions present already).

Step 4: Uploading files or entering links to externally hosted files

If you wish your files (pdf, midi, mp3, etc.) to be stored on the CPDL servers, you will need to upload them. Click on the "Upload now" buttons present on the "Add new work" form. This will open a file upload window that you can use to upload files. See Score submission guide - Uploading files for details. The system will try to automatically detect the file types and fill in the appropriate fields of the "Add new work" form accordingly. Please check the data entered, and update them if necessary. You can close the file upload window(s) after all files are uploaded.

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 try to detect such information on externally store files.

Step 5: Completing and submitting the "Add new work" form

Please fill in the remaining fields of the "Add new work" form (notes about the edition, copyright, external web links, your email address - see Score submission guide - Adding new edition information for details).

If are more familiar with the traditional process and you don't want that the work page and/or the composer page are 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 be 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 autmated 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 in a new window after a few seconds. The "Add new work" form remains open if you need to check any data on it. You can close it if you don't need it any more. 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.

Step 6: Checking and refining the composer page

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 of missing works 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 cahe 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, it's the wiki code 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.

Step 7: Checking and refining the work page

While on the composer page, please click on the work title of the work you added (or you added a new edition to). The automatic process should have added the new edition information as the first edition in the list if other editions were present already. Please correct anything that the automatic process was unable to handle properly.

If you selected the checkbox "Do not automatically add wiki code to the pages, I will do it manually", the work page was 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 shown under "Works entry (this should appear on the works page,copy all material below except for the last line of text)".

Check that everything is correct on the page, including especially the links to the files that you uploaded or linked from external websites.