Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
eoa-publication-model/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
89 lines (50 sloc)
2.57 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# EOA publication model | |
This repository contains the document model for EOA publications. The model is maintained as a TEI ODD file which contains both the definition of the model as well as its documentation. | |
This repository also contains an example file that contains all the phenomena that can occur in an EOA publication. | |
# Initialising the Repository | |
After cloning the repository, make shure to run this script first: | |
$ ./scripts/init.sh | |
This will | |
- locally download dependencies | |
- create autogenerated resources (e.g. ODD, schemata) | |
# Cleaning up the Repository | |
In order to purge all local dependencies and resources, run | |
$ ./scripts/exit.sh | |
# Example Publication | |
For a short example of a valid EOA publication in TEI syntax, see | |
- `./examles/tei/` | |
This example file serves the following purposes: | |
- give a first impression of the | |
- exhaustively document all features available in EOA documents | |
There is also a version of the same publication in old EOATeX[^eoatex] format here: | |
- `./examples/eoatex/` | |
The TEI version is the more recent format and is recommended for new EOA publications. | |
[^eoatex]: What is EOATeX? | |
The TEI example file itself is modeled after the original EOA document model, | |
which was designed in LaTeX, the set of macros eventually being called EOATeX. | |
# Checking Validity of a Publication | |
In order to proof that some XML document is a valid TEI publication consider the schemata in | |
- `./schema/` | |
Because EOA has some more complex restrictions, both, a schema (typically in RelaxNG syntax) and a schematron stylesheet needs to be applied, to be completely shure. | |
There are two helper scripts that automatise this task: | |
$ `./scripts/validate_xml.sh` | |
$ `./scripts/validate_xml_by_schematron.sh` | |
For usage details append the `--help` option. | |
# HTML Documentation | |
The documentation of the EOA format can be found in | |
- `./doc/html/` | |
Use your favourite webbrowser to read it. | |
# Abandoned | |
A further component is a stylesheet for | |
[ConTeXt](https://en.wikipedia.org/wiki/ConTeXt), which processes the | |
XML file to a PDF. This is currently incomplete and not maintained. | |
# Information for Developers | |
The final ODD is the result of a process that involves multiple steps and depends on the following input files in `./schema/resource/`: | |
- the TEI example publication | |
- a schema in RelaxNG Compact syntax | |
After changing one of these resources, you'll have to update all files that depend on them: | |
## Updating autogenerated Files | |
$ ./scripts/clean_output.sh | |
$ ./scripts/update_output.sh | |
### Dependencies | |
- pandoc(optional) : only needed if you want ODD statistics as HTML. |