Help:Automated add score process: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
(New help page for the Automated add score process)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=Introduction=
==Introduction==
The new "automated" add score process, introduced in October 2013, is intended to simplify the process to add a new score edition to ChoralWiki, especially for those users who are not familiar 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 is 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 users (and not only the administrators) to refine submissions that the automatic process may have not perfectly handled.
Furthermore, this process allows any registered user (not just the administrators) to refine submissions that the automatic process may not have handled perfectly.


For example, the list of works in some composer pages are ordered alphabetically by title, while in other composer pages they are grouped into "sacred works" and "secular works", or into collections. The automatic process cannot complemplate all these alternatives, so it simply places a new work entry at the first place in the list. Users sufficiently familiar with the wiki editing are then supposed to move the new work entry to the appropriate position in the page.
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.


Similarly, if a new edition of an existing work is added, a "multiple editions available" label is added, but the precise number of editions available is not shown, as it is very difficult to automatically determine the number of editions available for a given work (for example, in the case of a Mass where both the complete score and the individual items - Kyrie, Gloria, etc. - exist, or when the full score plus parts for individual voices and instruments are provided).
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 may help to refine composer pages and work pages created/amended automatically.
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 Forums for any problems or suggestions.
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.


=Step 1: go to the composer page or to the work page of the score that you intend to add=
==Step 1: Locating the composer page==


By browsing the list of composers, go to the composer page of the work that you intend to add. Check if the same work is listed already. If yes, click on the work title and go to the existing work page, otherwise remain on 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.


If a composer page does not exist yet for the composer in subject, a new composer page can be created. Just go to any existing composer page, and 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: fill the first part of the "Add new work" form down to the "Files Section" (excluded)=
==Step 2: Adding a new work==


If you found that a work page exists already, 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.
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.


If a work page does not exist already, you should click on the "Add new work" tab on the top-right part of the composer page. This will also open the "Add new work" form, however only the "Composer name" and the "Composer's time period" are filled automatically, based on the information present already in the composer page.
==Step 3: Adding a new edition==
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.


If you need to create a new composer page for a composer not yet available in the list, 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 the "Composer name" and the "Composer's time period" with the name and time period relevant to the composer that is to be added.
==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.


Fill the other fields of the form down to the "Files Section" (excluded) with the pursuant work information. See the [[Help:Score_submission_guide#Adding_new_edition_information|Score submission guide - Adding new edition information]] for details.
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.).


=Step 3: upload the files or enter links to externally hosted files=
==Step 5: Completing and submitting the "Add new work" form==


If you wish that files (pdf, midi, mp3, etc) are stored on the CPDL servers, you have to upload them. Click on the "Click here" link shown on the "Click here to open a new window and upload files now" text present on the "Add new work" form. This will open a file upload window that you can use to upload one or more files. See [[Help:Score_submission_guide#Uploading_files|Score submission guide - Uploading files]] for details. The system will automatically try to detect the file types and fill 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.
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.


If you prefer that files are stored on external servers, please enter the relevant links (full URL beginning with ''http://'') and the applicable details (file type, size, page size, number of pages, etc.).
You will also receive an email summarizing your submission. You can retain a copy of it for your records.


=Step 4: complete and submit the "Add new work" form=
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.


Please fill 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. The composer page, newly created or amended according to the work/edition added, will be shown to you in a new window after 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.
==Step 6: Checking and refining the composer page==


You will also receive an email summarizing your submission. You can retain a copy of it for your records.
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.


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


=Step 5: check and refine the composer page=
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 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 like "''The next work entry has been recently added or modified 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. Remove the ''<nowiki>{{Recent additions}}</nowiki>'' template when done so that the page is removed from the list of pages yet to be reviewed, and the text "''The next work entry has been recently added or modified automatically ...''" is not displayed any more.
You can also consider to automate the work list on the composer page if not automated already.


If a new edition has been added to an existing work page, the system should have been able to identify the work entry already present on the composer page, and to amend it using the multiple editions template ''<nowiki>{{editions|n}}</nowiki>''. You may wish to assign the correct value of "n" according to the number of editions actually available. If the system was unable to identify the work entry already present on the composer page, you will need to amend the existing work entry manually.
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.


Composer pages newly created will lack many information (birth and death dates, biography, etc.) that will have to be added  by editing the page manually.
==Step 7: Checking and refining the work page==


=Step 6: check and refine the work page=
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.


Click on the work title of the newly added (or amended) work entry, so that the relevant work page is displayed. 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.
[[Category:Help]]

Revision as of 10:11, 22 May 2019

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.

Furthermore, this process allows any registered user (not just the administrators) to refine submissions that the automatic process may not have handled perfectly.

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.

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 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, 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

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, to voicing.

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

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

You will also receive an email summarizing your submission. You can retain a copy of it 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

Composer pages created or amended automatically are traced through the category 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 {{Recent additions}} 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 a new edition has been added to an existing work page, you may delete the line after the {{Recent additions}} template, and amend the already existing work entry so that the multiple editions template {{editions|n}} is applied. You may wish to assign the correct value of "n" according to the number of editions actually available.

If the work list on the composer page is automated already (see 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 {{Recent additions}} template. Then also remove the {{Recent additions}} template.

You can also consider to automate the work list on the composer page if not automated already.

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

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.