View source for Tei-xsl

[[Category:Tools]]

[[Category:Conversion and preprocessing tools]]
[[Category:Publishing and delivery tools]]
[[Category:XSLT]]

== 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/Tools/Stylesheets/</ref>

Software dependencies:

* Saxon 9.2 or later.  If using Debian or Ubuntu, you can get it from http://tei.oucs.ox.ac.uk/teideb/ .
* ant and ant-contrib.  Note that as of 2011-11-30, ant-contrib is not availabe as as RedHat package.

== 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 ==
These two pages should be identical and therefore equally authoritative:

* http://www.tei-c.org/Tools/Stylesheets/
* http://www.tei-c.org/release/doc/tei-xsl/

Among the components of this package of stylesheets not documented are the following:

* <code>tools/oddbyexample.xsl</code> &ndash; 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 Roma
* <code>tools/odd2nuodd.xsl</code> &ndash; switches from a traditional ODD-by-exclusion to a newer form ODD-by-inclusion

See also this guide by Laura Mandell, which contains some documentation and some videos: http://idhmc.tamu.edu/chat/xslt/modifyTEI.html
However, be aware that this covers an earlier release, and things may have changed

=== Creating a custom profile ===

To create a profile for converting to/from a format and TEI XML, create either or both as needed:

<code>profiles/$PROFILENAME/$FORMAT/to.xsl</code>

<code>profiles/$PROFILENAME/$FORMAT/from.xsl</code>

Start by copying the files in <code>profiles/default/$FORMAT/</code> and then adding your own overrides and/or additional templates.  See [http://listserv.brown.edu/archives/cgi-bin/wa?A2=ind1303&L=TEI-L&F=&S=&P=99998 this brief example of additional templates].

Note that if your <code>$FORMAT</code> is docx, this directory must contain a file <code>template.docx</code> which is used to create .docx files from. See the sample in the default profile.

=== Converting from DOCX format ===

Word has two kinds of styles: paragraph styles and character styles.  According to Sebastian, "The basic rule of the conversion is that if named [character] styles are used, they take precedence over manual formatting."  That is, if text (even a whole paragraph) has a character style applied but is also marked in Word as being italicized, the italics will not come through in the conversion separate from the character style. This is the single biggest defect in the system (according to Lou, and Ron!)

== Tech support ==
Bugs and feature requests should be made via the TEI general ticketing system on [https://sourceforge.net/projects/tei/ Sourceforge]

== User community ==

== Sample implementations ==

The package includes a number of profiles in the <code>profiles/</code> directory.

== Current version number and date of release ==

7.1.0 (2013-09-07)

== History of versions ==

Versions prior to 7.0.1 are at https://sourceforge.net/projects/tei/files/Stylesheets/ .

Later versions are on Github

== How to download or buy ==

If you use [[Oxygen]], the easiest thing to do might be to download as part of [http://code.google.com/p/oxygen-tei/ oxygen-tei], the open-source TEI framework built into &lt;oXygen/&gt;.  Otherwise, there are three options:

=== Download zip file ===
Download the latest zip file (below all of the folders) from https://sourceforge.net/projects/tei/files/Stylesheets/ .

=== Install the Debian package ===

Install the <code>tei-xsl</code> Debian package from the [http://tei.oucs.ox.ac.uk/teideb/ list of Debian packages].

=== Get from Github ===

<code>
git clone git@github.com:TEIC/Stylesheets.git /path/to/local/directory/Stylesheets
</code>

Then, if you want to add these to <code>/usr/</code> (which you will need to do in order to use the command-line shell scripts), you can do the following:

<code>
cd /path/to/local/directory/Stylesheets/
</code>

<code>
make install
</code>

<strong>but note the following</strong>:

* You will need to run <code>make install</code> as a user with write permission to <code>/usr/</code> .  So if using Ubuntu, for example, you will need to instead do <code>sudo make install</code> .

== 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/>