Index of /epidoc/schema/latest
XXX README.txt for EpiDoc ODD and schema XXX
What it is:
The EpiDoc RelaxNG schema and the TEI ODD file from which it is generated.
The TEI Schema is copyright the TEI Consortium
To the extent that the EpiDoc ODD and schema have been customized and
amount to transformative versions of the original schema, they are
copyright Gabriel Bodard and the other contributors (as listed in
tei:revisionDesc). See LICENSE.txt for license details.
The ODD requires the OxGarage tool to generate the RelaxNG schema.
The schema (whose canonical released versions live at
https://www.stoa.org/epidoc/schema/) may be used by any XML editor or
processing environment to validate EpiDoc XML files.
How to use it:
1. To validate your EpiDoc files in an editor:
If using Oxygen or similar editor to edit XML files, processing instructions such as:
at the top of the XML file (above the <TEI> element but below the <?xml?>
declaration) will instruct the editor to validate against this schema
(as RelaxNG and Schematron respectively).
You may also point at a local copy of the tei-epidoc.rng file.
2. To generate a new version of the schema from the ODD:
1. edit the ODD (tei-epidoc.xml) to make any changes to the EpiDoc schema.
*NB* that as a matter of policy the EpiDoc schema should be a conformant
subset of the latest TEI schema (only exceptions being when the dev TEI ODD
contains changes that will not make it into the TEI release for 1-6 months).
2. Go to https://oxgarage.tei-c.org
3. Select "Convert from:" -> "Document" -> "ODD Document"
4. Select "Convert to:" "RELAX NG SCHEMA"
5. Under "Select file to convert" press "Browse" and select tei-epidoc.xml
from your local file system.
6. Press "Convert".
7. Save to your local file system as tei-epidoc.rng (or a project-specific variant).
8. Test thoroughly (and ask for support on Markup to test) before committing as
canonical new EpiDoc schema.
To generate the compiled ODD, repeat the above, only changing point (4) from
"RELAX NG Schema" to "Compiled ODD Document"
3. How to decide which schema to use:
1. if your project is complete and more or less static, it is recommend you use
the most recent numbered release of the schema as of your publication,
because this file will remain stable indefinitely;
2. if your project is in active development and you are comfortable following
the changes in the community fora such as the MARKUP list, and updating
your XML if the schema changes, you should use the /latest/ release
which will be updated whenever a new schema is released.
See https://sourceforge.net/p/epidoc/wiki/Schema/ for more information on the EpiDoc schema and how to use it.