tei-examples

Collection of TEI sample files intended to be used for teaching and as specimens for TEI Publisher Demo Collection.

Demo Collection

TEI Publisher provides a community-curated Demo Collection of encoded TEI samples of varied material. All the examples have been based on existing material shared by real editorial projects. It has proven a very useful resource for showcasing the possibilities of using TEI Publisher as an open source publishing platform but also as a repository of best-practice TEI encodings for numerous practical applications.

The Demo Collection has truly grassroot origin and spirit and we'd love to see as many interesting examples from varied domains as possible. Everyone is invited to contribute a sample which demonstrates either a type of encoding or manner of presentation that is not yet covered. Please read the guidelines for contributions below.

Examples wanted

Please feel free to propose examples beyond these topics:

• 'tabular' sources, e.g. historical accounting books
• encoding of textual variants in parallel-segmentation method
• encoding of textual variants in other methods
• samples using ROI encoding for lines, words or even single glyphs
• RTL and non-European script text samples (ideally with translation into English or other language to make it work as an example for users who can't read the script)

Contributing

Proposing an example for consideration

If you'd like to contribute an example make sure it is clearly openly licensed or you can release it under an open licence yourself.

Create a new issue for your example using the TEI example template describing your encoded sample, it's interest as a showcase or teaching material and intended output layout and processing requirements. Attach TEI Publisher-compatible layout template and ODD if possible.

In most cases you can expect some comments or questions to arise following your proposal. Please take active part in the discussion via the GitHub tracker.

Proposing a PR

If you're happy working with Git and can provide a complete example for TEI Publisher please make a PR and it will be enormous help. PR should include:

• xml file with a licence element and TEI Publisher processing instruction specifying required odd and template
• odd file with processing models
• TEI Publisher compatible page template
• facsimile images (where applicable, no need to do that if they are stored in IIIF server somewhere already)

Please mention the issue number in your PR so we don't lose track of the discussion.