XSL documentation

README.md

@@ -50,6 +50,8 @@ create a LaTeX file, or the TEI file can be converted into the
 customized DocBook format from above workflow so that the existing
 tools can be used.
 
+See `doc/XSL.md` for a documentation of the XSL workflow.
+
 ## Examplary workflow
 
 To install the whole toolchain, clone at least this repository as well

doc/XSL.md

@@ -0,0 +1,34 @@
+# The XSL workflow
+
+A 2.0 XSL processor is required to perform the transformation of the
+TEI manuscript to LaTeX files. It has been successfully used with
+Saxon-HE 9.7.0.21J, found at
+[sourceforge](https://sourceforge.net/projects/saxon/files/Saxon-HE/9.7/SaxonHE9-7-0-21J.zip/download).
+
+There are two files to choose from, depending on whether the highest
+element of a publication is part (`tei2eoatex-parts.xsl`) or chapter
+(`tei2eoatex-noparts.xsl`). Both scripts then import
+`tei2eoatex-common.xsl` which contains the rest of the templates.
+
+There is command line parameter available which toggles the creation
+and inclusion of a List of Contributors (mainly used in edited books).
+It is set to `false` by default. Enable it by adding
+
+     contributors=1
+
+to the command line.
+
+## Output
+
+The transformation will create a number of files that closely
+resembles the structure in the classic EOATeX way. There is one main
+file that links to the separate chapter files which are located in a
+directory `texfiles`.
+
+## Working with the LaTeX files
+
+The LaTeX files are considered temporary files to create a PDF version
+of the TEI text. All changes to the contents and structure of the text
+should be made in the master TEI file. However, some elements need to
+be fixed at the LaTeX level, e.g. the placement and size of images,
+line and page breaks or hyphenation.