Tei-xsl
Contents
- 1 Synopsis
- 2 Features
- 3 User commentary
- 4 System requirements
- 5 Source code and licensing
- 6 Support for TEI
- 7 Language(s)
- 8 Documentation
- 9 Tech support
- 10 User community
- 11 Sample implementations
- 12 Current version number and date of release
- 13 History of versions
- 14 How to download or buy
- 15 Additional notes
- 16 Notes
Synopsis
This is a family of XSLT 2.0 stylesheets to transform TEI XML documents to various formats, including XHTML, LaTeX, XSL Formatting Objects, ePub, plain text, RDF, JSON; and to/from Word OOXML (docx) and OpenOfice (odt). They concentrate on the core TEI modules which are used for simple transcription and "born digital" writing. It is important to understand that they do not
- cover all TEI elements and possible attribute values
- attempt to define a standard TEI processing or rendering model
They should not be treated as the definitive view of the TEI Consortium about rendering TEI documents.
Features
User commentary
Please sign all comments.
System requirements
"The XSL FO style sheets were developed for use with PassiveTeX (http://projects.oucs.ox.ac.uk/passivetex/), a system using XSL formatting objects to render XML to PDF via LaTeX. They have not been extensively tested with the other XSL FO implementations."<ref>http://www.tei-c.org/release/doc/tei-xsl/</ref>
Software dependencies:
- Saxon 9.2 or later, which you can get from https://www.saxonica.com/download/java.xml .
- ant and ant-contrib.
Source code and licensing
This software is dual-licensed:
1. Distributed under a Creative Commons Attribution-ShareAlike 3.0 Unported License http://creativecommons.org/licenses/by-sa/3.0/
2. http://www.opensource.org/licenses/BSD-2-Clause
Support for TEI
The stylesheets render TEI XML documents to various formats, with the constraint that they do not offer an implementation of all tags, and only support a limited range of values for the @rend attribute.
Language(s)
Documentation is in English.
Documentation
http://www.tei-c.org/release/doc/tei-xsl/
Among the components of this package of stylesheets not documented are the following:
tools/oddbyexample.xsl
– generates a list of all the attribute values used in the directory of texts you apply it to, in the form of an ODD file, from which you can in turn generate documentation and schemas using Romatools/odd2nuodd.xsl
– switches from a traditional ODD-by-exclusion to a newer form ODD-by-inclusion
Creating a custom profile
To create a profile for converting to/from a format and TEI XML, create either or both as needed:
profiles/$PROFILENAME/$FORMAT/to.xsl
profiles/$PROFILENAME/$FORMAT/from.xsl
Start by copying the files in profiles/default/$FORMAT/
and then adding your own overrides and/or additional templates. See this brief example of additional templates.
Note that if your $FORMAT
is docx, this directory must contain a file template.docx
which is used to create .docx files from. See the sample in the default profile.
Converting from DOCX format
"The TEI conversions from docx are better in many ways than the conversions from other the wordprocessing formats. There are also small tricks like having docx styles of 'tei_elementName' to get certain phrase-level elements converted."<ref>https://listserv.brown.edu/archives/cgi-bin/wa?A2=TEI-L;1123776a.1605</ref>
Tech support
Bugs and feature requests should be made in GitHub: https://github.com/TEIC/Stylesheets/issues
User community
Sample implementations
The package includes a number of profiles in the profiles/
directory.
Current version number and date of release
7.48.0 (2019-07-16)
History of versions
See detailed changelog at https://github.com/TEIC/Stylesheets and automatically generated commit log at https://github.com/TEIC/Stylesheets/commits/master . Past versions can be downloaded at https://github.com/TEIC/Stylesheets/releases .
How to download or buy
If you use Oxygen, the easiest thing to do might be to use the open-source TEI framework built into <oXygen/>. Otherwise, there are three options:
a) Download zip file
Download the latest zip file from https://github.com/TEIC/Stylesheets/releases .
b) Install the Debian package
Install the tei-xsl
Debian packages (see https://wiki.tei-c.org/index.php?title=TEIDebian).
c) Get from Github
git clone git@github.com:TEIC/Stylesheets.git /path/to/local/directory/Stylesheets
Then, if you want to add these to /usr/
(which you will need to do in order to use the command-line shell scripts), you can do the following:
cd /path/to/local/directory/Stylesheets/
make install
but note the following:
- You will need to run
make install
as a user with write permission to/usr/
. So if using Ubuntu, for example, you will need to instead dosudo make install
.
Additional notes
The XSLT 1.0 version of this stylesheet family, which is no longer actively maintained, can be found on Github at https://github.com/sebastianrahtz/TEIXSL-v1.git
Notes
<references/>