Schematron and Validation Errors Technical Writer Navarra Houldin Proofreader Mahayla Galliford Project Director Janelle Jenstad Project Manager Mahayla Galliford Training and Documentation Lead Navarra Houldin Programmer Martin Holmes Programmer Joey Takeda Junior Programmer Tracey El Hajj Social Sciences and Humanities Research Council of Canada

Released with Linked Early Modern Drama Online 1.0

 University of Victoria on the Linked Early Modern Drama Online Platform

This file is licensed under a CC BY-NC_ND 4.0 license, which means that it is freely downloadable without permission under the following conditions: (1) credit must be given to the author and LEMDO in any subsequent use of the files and/or data; (2) the content cannot be adapted or repurposed (except in quotations for the purposes of academic review and citation); and (3) commercial uses are not permitted without the knowledge and consent of the editor and LEMDO. This license allows for pedagogical use of the documentation in the classroom.

Linked Early Modern Drama Online

TEI Customization created by Martin Holmes, Joey Takeda, and Janelle Jenstad; documentation written by members of the LEMDO Team

Encoded in TEI P5 according to the LEMDO Customization and Encoding Guidelines

n/a

 Automatically generated this file by extracting its content from lemdo.lite.odd.
Prior Reading <ref target="doc:learn_repoIntro">The LEMDO Platform and Repository</ref> <ref target="doc:learn_validate">Validate Files</ref>
Introduction

Schematron is the language that LEMDO uses to write rules specific to LEMDO’s encoding. Schematron, alongside our schema, ensures that encoding is consistent and correct throughout the LEMDO project. If your encoding does not follow one of the Schematron rules that we have written, then you will get a validation error. This will prompt you to go back and correct your encoding. It is important that you fix validation errors as soon as you get them.

If you commit an invalid file, it will break the build. This means that our Jenkins Continuous Integration Server is unable to finish serving up a new version of the LEMDO-dev website. When the build is broken, nobody can see the work that they have recently committed rendered in HTML. If you inadvertently break the build, a member of the LEMDO team will contact you so that you can fix the error causing the build break.

If there is an error that is frequently occurring that is not currently prevented by Schematron, we will write a new Schematron rule in the ODD file (lemdo.odd). You must svn up regularly to ensure that you get any new Schematron rules that we add.

Step-by-Step: Check Validity Click the validation button at the top of your Oxygen window (it resembles a piece of paper with a checkmark on it). Check for the validation message at the bottom of your Oxygen window. It will say either Validation successful or Document contains errors. If your validation is successful, you can either continue working or save and commit your file. If your validation is not successful, you must fix the error. Never commit an invalid file.

For more detailed instructions for validating a file, see <ref target="doc:learn_validate">Validate Files</ref>.

Practice: Fix Validation Errors

To fix a validation error, look at the error message at the bottom of your Oxygen window. In most cases, we have written instructions for how to fix Schematron errors. For example, if you have a straight apostrophe in your file, you will get an error message that says: ERROR: Straight apostrophes are not allowed in text. Use curly apostrophes instead. The shortcut to add a curly apostrophe is ctrl+shift+’ (on PC or Unix) and command+shift+’ (on iOS).

If you are unable to see the entire message because it is cut off, you can pull up a window with the full message by double clicking on the message text.

If you are unable to fix the error yourself, contact the LEMDO team for help. Do not commit your file while it is invalid.