Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 5.35 KB

data-creation-workflow.md

File metadata and controls

61 lines (43 loc) · 5.35 KB

Workflow how to prepare data for an edirom edition

In the description of how to setup Edirom Online on a local machine there is the assumption you already have a data package. In the early days of Edirom there was a (meanwhile deprecated) Edirom Editor that supported the data creation for writing annotations, creating zones for measures, creating concordances and it created the data package. So this document trys to describe the workflow to generate data for an Edirom Edition. If you beyond that also want to customize Edirom Online and the content, eg the table of content of your edition shown in the online publication, have a look to the customize.md.

Prepare repositories

Start with the creation of two repositories on your own account or create an organization for your edition that will contain all the content.

  • software: create a fork of the Edirom Online for your own edition for later edition-specific modifications to the software
  • data: create a repository for your Edirom data, the Edition Example might be helpful as a start, but you could fill up your data repository also on your own

Images

Check if you have to host the images on your own or if the library or institution can provide you with iiif. If you have to host the images on your own, make sure the name of the images are fine to avoid possible later trouble (eg special characters, vowel mutation, spaces). Try to decide which sources should be part of your edition in an early stage, so you can have this step done as a whole.

Create measure-zones

Use the cartographer-app to create the zones of measures. The App uses the images and creates zones for measures that match the corresponding images and saves the zones in an MEI-file. Please take care about possible joint-measures in your images. If a measure is divided because of a line break in the facsimile it seems like two measures. You need to make this clear in the App that it is actually one measure consisting of two (or even more) zones so it can give you the correct number of measures.

MEI

Of courses it is posssible to write MEI from scratch to your editor but more likely you use music notation software of your choice to enter your music. You need to save this as MEI if possible. If not, at least MusicXML should be possible as a format to choose. If you got MusicXML you can use mei-friend to import it and convert it to MEI. Also use mei-friend for proof-reading and adjustments to your MEI-file. If you have already (old) MEI-files and you need to update them to a newer MEI version, you can use MEI garage to convert different MEI versions. The MEI garage uses scripts from music-encoding/encoding-tools, so choose on your own, if you want to use the scripts directly from music-encoding or the option with a graphical user interface of the MEI garage.

TEI

You can write your text-files like introductions to your edition in html or TEI. You can use TEI garage if you need to convert text formats.

Annotations

Annotations have to be added to notesStmt in the work-file of your data-package. For an example see the work-file of the EditionExample. You can modify the categories and priorities for annotations. Make sure to modify them accordingly in the termList of your work-file. See termList classcode="#ediromCategory" for category and termList classcode="#ediromPriority" for priority of the EditionExample.

Concordances

The Edirom-Online has the option to navigate through different sources and the edition in parallel with the concordance navigator. To make this happen, a concordance of corresponding measures of different sources have to be added as concordance Element to the edition-file. See an example in the clarinet quintet edition data.

Examples of Edirom editions

While thinking about the structure and the content your edition should have the following examples might be of any help for you.