Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Documentation update
  • Loading branch information
Klaus Thoden committed Aug 21, 2018
1 parent f1b478e commit 4f79034
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
8 changes: 6 additions & 2 deletions INSTALL.md
Expand Up @@ -9,5 +9,9 @@ In a terminal, run the command

to install the required packages.

In order to run the xsl scripts found in the `data` directory, an XSL
processor like [Saxon](http://saxon.sourceforge.net/) is required.
In order to run the xsl scripts found in the
[data](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/tree/master/data)
directory, an XSL processor like
[Saxon](http://saxon.sourceforge.net/) is required. See
[doc/XSL.md](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/doc/XSL.md)
for details.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -26,7 +26,7 @@ respectively. The Django-XML format is ingested into the database of
the EOA site where it will show up as an online publication.

The EPUB files can be put together to form an ebook. The script
`data/misc/epub.sh` performs the required steps.
[data/misc/epub.sh](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/data/misc/epub.sh) performs the required steps.

The conversion to TEI is still work in progress.

Expand All @@ -41,7 +41,7 @@ Similar to the LaTeX workflow we require the authors to hand in their
bibliographic references in a database format, such as BibTeX. The
Word template explains in detail how citations should be entered.

The script `fix_tei` corrects some artifacts of the oxgarage
The script [fix_tei](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/fix_tei.py) corrects some artifacts of the oxgarage
conversion and expands the shorthand codes for references and figures
to XML tags.

Expand All @@ -50,14 +50,14 @@ 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.
See [doc/XSL.md](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/doc/XSL.md) for a documentation of the XSL workflow.

## Examplary workflow

To install the whole toolchain, clone at least this repository as well
as the 'advanced' branch of
[EOA sample project](https://github.molgen.mpg.de/EditionOpenAccess/eoa_sample_project).
Follow the installation instructions in `INSTALL.md`.
Follow the installation instructions in [INSTALL.md](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/INSTALL.md).

In `eoa_sample_project`, run `xelatex`, `biber` (the version included
in your TeX distribution) and `xelatex` two more times. This will give
Expand All @@ -79,7 +79,7 @@ These scripts don't take any arguments and will produce output in the

External dependencies
---------------------
See INSTALL.md for details.
See [INSTALL.md](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/INSTALL.md) for details.

- lxml (<https://pypi.org/project/lxml/>)
- bibtexparser (<https://pypi.org/project/bibtexparser/>)
Expand Down
6 changes: 3 additions & 3 deletions doc/XSL.md
Expand Up @@ -6,9 +6,9 @@ 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.
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.

There is command line parameter available which toggles the creation
and inclusion of a List of Contributors (mainly used in edited books).
Expand Down

0 comments on commit 4f79034

Please sign in to comment.