Editing the Schema

In the Schema repository there should be the index files, the actual schema files and the README.md

The .xml files are the ODD (One Document Does it all) and the .rng are the actual RelaxNG schema files used for validation.

To update the schema start always from the ODD (tei-betamesaheft.xml).

There is a very good tutorial to edit ODD (One Document Does it all) among the TEI resources.

In most cases, you will be simply adding a value to an existing list. But to add rules it is safer to ask somebody who has done it.

Please, try to discuss any schema update in a issue before editing the schema.

If you are happy with your changes, create a pull request for the modified .xml file. Once merged, the new RelaxNG schema file (.rng) and expanded versions will be generated automatically.

If you want to test the RelaxNG prior to submitting your changes, you can always use the manual transformation, either with the help of your oXygen software (using the appropriate transformation scenario will save a .rng file in a "out" directory relative to the place where your schema is stored) or by using the TEI Roma web application or with the OxGarage web application. Please do not commit any changes in .rng files to GitHub.

If you are not sure of what you are doing please ask.

This page is referred to in the following pages

Revisions of this page

  • Pietro Maria Liuzzo on 2018-04-30: first version of guidelines from Wiki
  • Eugenia Sokolinski on 2023-10-24: updated the workflow desc (transformation in CI)