XSL to HTML documentation

doc/XSL.md

@@ -1,18 +1,21 @@
 # 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
+TEI manuscript. 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).
 
+This workflow is used to convert the TEI source both to LaTeX and HTML versions.
+
+## LaTeX
 There are two files to choose from, depending on whether the highest
 element of a publication is part ([tei2eoatex-parts.xsl](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/data/tei2eoatex-parts.xsl)) or chapter
 ([tei2eoatex-noparts.xsl](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/data/tei2eoatex-noparts.xsl)). Both scripts then import
 [tei2eoatex-common.xsl](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/data/tei2eoatex-common.xsl) which contains the rest of the templates.
 
-## Command line switches
+### Command line switches
 Four command line switches are available
-### Document structure (required)
+#### Document structure (required)
 This switch is required and tells if the document structure contains parts or not.
 
 Use value `1` if there are parts.
@@ -22,34 +25,52 @@ Use value `1` if there are parts.
 Use value `0` if there are no parts.
 
     parts=0
-### Frontmatter (optional)
+#### Frontmatter (optional)
 Toggles the creation and inclusion of a frontmatter, which is
 generated from the TEI header. Default: `false`. To enable it, use
 
     frontmatter=1
-### List of contributors (optional)
+#### List of contributors (optional)
 Toggles the creation and inclusion of a List of Contributors (mainly
 used in edited books). It is optional set to `false` by default.
 Enable it by adding
 
      contributors=1
 
 to the command line.
-### Verbosity (optional)
+#### Verbosity (optional)
 Selects the amount of output messages during runtime. Possible values are `0`, `1`, `2`. Example:
 
     verbosity=1
-## Output
+### 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
+### 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.
+
+## HTML
+The HTML conversion is as of March 2018 still incomplete.
+### Command line switches
+Up until now, only the the optional `verbosity` switch is available.
+
+### Example file
+The example file, available in
+[eoa-publication-model](https://github.molgen.mpg.de/EditionOpenAccess/eoa-publication-model)
+can be used to check the conversion of all available commands.
+
+    `java -jar …/saxon9.jar -t -s:…/eoa-publication-model/examples/exampleTEI.xml -xsl:…/EOASkripts/tei2html.xsl`
+
+The script will create a directory structure similar to the one on the
+publication platform. To enjoy the webdesign, a directory containing
+stylesheets, javascript and images is necessary. A version of this can
+be downloaded from
+<https://oc.rz-berlin.mpg.de/owncloud/index.php/s/EEfZycDLCHjwwCF>.