Skip to content

Commit

Permalink
docs: minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
HelenaSabel authored Oct 3, 2023
1 parent c33025d commit d0ef755
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
# Schema
TEI schemas for project documents
TEI schemas for project documents.

This repo contains the schema and annotated template files to be used to enter new data while a proper form is prepared.

## Contents

- The main ODD specification is `tei-betamesaheft.xml`.
- `tei-betamesaheft-expanded.odd` is derived ODD (that uses `tei-betamesaheft.xml` as its source) and it’s meant to validate the expanded files generated in the app as well as file generated by other project.
- Both RELAXNG schemas, `tei-betamesaheft.rng` and`tei-betamesaheft-expanded.rng` are generated through the [TEIGarage](https://github.com/TEIC/TEIGarage) API.
- `tei-betamesaheft-expanded.odd` is derived ODD (that uses `tei-betamesaheft.xml` as its source) and it is meant to validate the expanded files generated in the app as well as files generated by other related projects.
- Both RELAXNG schemas, `tei-betamesaheft.rng` and`tei-betamesaheft-expanded.rng` are generated from these ODDs through the [TEIGarage](https://github.com/TEIC/TEIGarage) API.
- The main ODD specification is validated on CI. Also, the RELAXNG schemas are continuously updated on CI.

## Build requirements
For creating a XAR file with the schemas:

- [ant](http://ant.apache.org/) version: 1.10.7 (for building from source)
- [ant](http://ant.apache.org/) version: 1.10.7

## Build instructions

To create a XAR file with the schemas run

Run
```
ant
```

or
```
ant xar
```


0 comments on commit d0ef755

Please sign in to comment.