Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
kthoden committed Jan 2, 2019
1 parent bbba60e commit bd82276
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# eoa_sample_project
A sample project that contains all the phenomena that can occur in an EOA publication.
# 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.

For reference of all the commands, check out [EOA reference](http://edition-open-access.de/media/support/files/EOAReference.pdf).
This repository also contains an example file that contains all the phenomena that can occur in an EOA publication.

# EOA goes TEI
This repository contains the EOA sample file as a TEI-conform XML
document. Also included is a RELAX-NG Compact schema to validate XML
files against. The file `eoa_roma.xml` is a configuration file for
[Roma](http://www.tei-c.org/Roma), the TEI schema generator.
# Producing the output
From the ODD file, documentation and schema files can be created. Several possibilities exist, the most straightforward being
[Roma](http://www.tei-c.org/Roma), the TEI schema generator or oxygen, the XML editor.

## Validity checking
A schema file, created from the ODD file, can be used for checking the validity of the XML files. At the time of writing, there is also a hand-made `rnc` file, `eoa-tei-stric.rnc` which is a very strict schema. Its features will eventually be transferred to the ODD file

# What is EOATeX?
The TEI file itself is modeled after the original EOA document model,
which was designed in LaTeX and can be also found in this repository.
which was designed in LaTeX, the set of macros eventually being called
EOATeX. A sample project and can be also found in this repository.

# 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.

## Validity checking
The schema `eoa-TEI.rnc` is a subset of <http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_all.rnc>. That is, it will validate against both, but the EOA schema is more restrictive.

It is not a subset of <http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_lite.rnc> or <http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_bare.rnc>, though.
XML file to a PDF. This is currently incomplete and not maintained.

0 comments on commit bd82276

Please sign in to comment.