Help:Automated add score process: Difference between revisions

From ChoralWiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(24 intermediate revisions by 6 users not shown)
Line 1: Line 1:
=Introduction=
{{DisplayBox|bgcolor=#ddffdd|text='''This page has been consolidated into [[Help:Score submission guide]] and its subpages.'''}}
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.
{{TOC2}}
<!-- MATERIAL INCORPORATED INTO OTHER PAGES - HELP:SCORE SUBMISSION GUIDE AND ITS SUBPAGES


Furthermore, this process allows any registered users (and not only the administrators) to refine submissions that the automatic process may have not perfectly handled.
==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.


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 contemplate 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.
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 4 to 6).


Similarly, if a new edition of an existing work is added, a "multiple editions available" label is also added, however 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).
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.


All registered users who are sufficiently familiar with editing wiki pages may help to 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 Forums for any problems or suggestions.
==Step 1: Locating the "Add new work" form==


=Step 1: go to the composer page or to the work page of the score that you intend to add=
First, go to the composer page. A list may be found at ''[[:Category:Composers|Composer pages]]'' (also linked in the navigation list on the left of the screen) and navigated by clicking on the first letter of the composer's surname in the bar at the top.


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.
If the title is already linked from the composer page, click on the work title and go to the work page. Then 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).


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.
Otherwise, click on the "Add new work" tab at the top right of the composer 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)=
If the composer name does not appear on the list at [[:Category:Composers]], 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, manually replace "Composer name" and "Composer's time period" with the name and time period of the new composer: the new composer page will automatically be created.  Then go to step 2.


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.
==Step 2: completing the "Add new work" form==


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.
Depending on Step 1, some information on the form will already be filled in. Fill in the other fields with the relevant information (there are some explanations at the old help page, [[Help:Score_submission_guide#Adding_new_edition_information|Score submission guide - Adding new edition information]]). When done with general information about the work, go to step 3.


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 3: The files section===
Follow the prompt: "Click here to open a new window and upload files now."  This will open a new file upload window that you can use to upload files ([[Help:Score_submission_guide#Uploading_files|Score submission guide - Uploading files]] is still up to date). 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 added to the the "Add new work" form, 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.) because the system cannot automatically detect such information on externally stored files.


=Step 3: upload the files or enter links to externally hosted files=
===Step 4: 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).


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


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


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


You will also receive an email summarizing your submission. You can retain a copy of it for your records.
==Step 5: Checking and refining the composer page==


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


=Step 5: check and refine the composer 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.


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


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.
While on the composer page, please click on the 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 6: check and refine 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 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)".


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

Latest revision as of 02:40, 18 July 2020

This page has been consolidated into Help:Score submission guide and its subpages.

Retrieved from "https://www.cpdl.org/wiki/index.php?title=Help:Automated_add_score_process&oldid=1154485"