Skip to content

Latest commit

 

History

History
55 lines (28 loc) · 4.77 KB

BUILD_OXYGEN.md

File metadata and controls

55 lines (28 loc) · 4.77 KB
Raw

Building MEI with Oxygen XML Editor

If you are not that comfortable with the command line, here we provide an alternative to build MEI schema files for customizations and the HTML version of the Guidelines with Synchrosoft’s oXygen software family. Although the following documentation was developed with oXygen XML Editor, the illustrated workflows should also be possible in oXygen XML Developer and oXygen XML Author.

Build a Specific Customization’s RNG Schema

To build the RNG schema of a specific customization, follow these steps:

  1. Open the customization file in oXygen.

    To make sure that step 2 works out of the box, make sure that it has the extension .odd and not .xml. This is necessary for oXygen to recognize the file as TEI ODD customization and offer you the pre-configured transformation scenario for generating RNG schema files from an ODD.

  2. Click on the Configure Transformation Scenario(s) button (the red play button with the wrench). This will open a window of the same name.

  3. Check the TEI ODD to RELAX NG XML check box.

  4. Click on the Duplicate button. This will open the Edit Ant Scenario window.

  5. Once in the Edit Ant Scenario, assign an appropriate name for the project (e.g., “MEI Mensural Schema - plica feature”). The storage option can be either Project Options or Global Options.

  6. Change its defaultSource parameter by:

    a. Clicking on the Parameters tab.

    b. Locating the defaultSource parameter and double-clicking on its value to change it. This will open the Edit Parameter window.

    c. Change the value of the defaultSource to the path of the MEI source file (mei-source.xml) found on your computer. You can do this by clicking on the folder icon and browsing to the file location (it is located in your local copy of the music-encoding repo, in music-encoding/source/mei-source.xml). Select the file and click Open Button. If you are on Windows, make sure that the path starts with the file protocol, e.g. file:/D:/music-encoding/source/mei-source.xml.

    d. Back in the Edit Parameter window click on the OK button. The Edit Parameter window will close.

  7. Now, you will be back in the Edit Ant Scenario window again. If you are satisfied with your changes, click on the OK button. Otherwise, you could also edit the directory where your schema gets stored by clicking on the Output tab.

  8. Now, you will be back in your Configure Transformation Scenario(s) window. In the Projects or Global section of the window based on your choice in step 5, you will find your new project with the name you gave it in step 5. Click on it and then click on the Applied associated button at the left-bottom corner of your window. This will build the schema.

Once the building is done, Oxygen will automatically open the schema. The schema file is also stored in the music-encoding/customizations/out/ folder if you want to consult it later. You can change the location where the schema generated is saved by clicking on Output in the Edit Ant Scenario window and changing the file path.

Build Guidelines HTML

In this section, we will use Oxygen to generate the HTML document for the guidelines using the XSLT Stylesheet located at music-encoding/utils/guidelines_xslt/odd2html.xsl. The steps are the following:

  1. Open the mei-source.xml file in Oxygen. This file is located in music-encoding/source/mei-source.xml.

  2. Click on the Configure Transformation Scenario(s) button (the button with the wrench). This will open a window of the same name.

  3. Click on the New button and select the XML transformation with XSLT option. This will open the New scenario window.

  4. Assign a name to your new XML transformation.

  5. In the XSLT tab, look for the XSL URL field and add the path to your odd2html.xsl file. You can do this by clicking on the folder icon to browse this file (it is located in your local copy of the music-encoding repo, in music-encoding/utils/guidelines_xslt/odd2html.xsl) and opening it.

  6. Now, you will be back in the New Scenario window again. If you are satisfied with your changes, click on the OK button. Otherwise, you could also edit the XML URL field for a particular folder, as well as the Parameters to change the output folder.

  7. Now, you will be back in your Configure Transformation Scenario(s) window. In the Global section of the window, you will find your new XML transformation with XSLT with the name you gave it in Step 4. Click on it and then click on the Applied associated button at the left-bottom corner of your window. This will generate the HTML document for the guidelines.

After a few minutes, the results of this build can be found in the web folder (music-encoding/dist/guidelines/web). The guidelines are stored in the index.html file.