Closed craigsapp closed 7 years ago
I also enabled a button when there is no critical report for the page yet.
When you press alt-e
on a page without a critical report, a button will appear at the bottom of the page labeled "Add critical report":
Clicking on that link will take you to the critical report page for the website on Github:
From there you can click on the button "Create new file" to add a new report. The name of the file should be [ID]-report.aton
, where [ID]
is the catalog number of the work in TMP, such as Trm0059c
in this case.
A template for creating a new report:
@@BEGIN: CRITICAL_REPORT
@CATALOGNUM: Trm0047m
@PRINCIPAL_SOURCE:
@OTHER_SOURCE:
@OTHER_SOURCE:
@EMENDED_READING: None
@CRITICAL_NOTE:
@CRITICAL_NOTE:
@COMMENTARY:
@@END: CRITICAL_REPORT
Most of the fields can be repeated, such as @OTHER_SOURCE:
which should include information about a single source with multiple @OTHER_SOURCE:
fields describing all of the other sources.
But I will probably soon add a simple report for every work with the princeps edition information from the rime-settings.aton index files in the data/indexes
page:
https://github.com/TassoInMusicProject/tasso-website/tree/gh-pages/data/indexes
The dummy reports can then be filled in as critical reports are generated.
I have added mostly empty critical reports for all TMP works:
https://github.com/TassoInMusicProject/tasso-website/tree/gh-pages/data/reports
Only the CATALOG and PRINCIPAL_SOURCE are filled in. Note that the PRINCIPAL_SOURCE should switch to a templating system based on the RISM id number once the RISM spreadsheet has been completed:
Here is what a mostly empty critical report looks like on a work page:
http://www.tassomusic.org/work/?id=Trm0059c
This is created with the report:
https://github.com/TassoInMusicProject/tasso-website/blob/gh-pages/data/reports/Trm0059c-report.aton
Also note that a link to this report can be displayed on the work page by pressing alt-e
(expert mode):
Note that the princeps clefs and mensuration information is not stored in the report, but in the *-settings.aton
files in the data/index
directory/folder:
https://github.com/TassoInMusicProject/tasso-website/tree/gh-pages/data/indexes
A minor point: what is the best way to display RISM numbers in long form. In this example they are given:
RISM A/I, P 793
I am wondering about the purpose of the comma. Is it necessary and/or customary to place a comma between the A/I
series name and the RISM number for that series? It is a bit confusing since a comma implies a list of numbers, but in this case it is a separator between the series and the number in the series. So perhaps:
RISM A/I P 793
Although that also looks a little strange as well. removing the space between the P and the number make it look better:
RISM A/I P793
Although that is not the style in the RISM website mentioned earlier.
Pressing
alt-e
while on a work page that already has a critical report will cause a button to be displayed to the right of the "Musical Sources" entry:http://www.tassomusic.org/work/?id=Trm0047m
If you click on this button a new tab will open with the source for the critical report on Github:
which can then be edited to fix typos or add content. (Note that you have to be logged into Github in order to edit the content by clicking on the pencil icon).
Pressing
alt-e
again will hide the button.Once the changes have been made to the critical report file, they will appear automatically on the website. It may take up to 10 minutes depending on how busy Github is (typically under a minute).