Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docu: fix redundant/outdated information, dependencies, updated pytho…
…n deps
  • Loading branch information
EsGeh authored and EsGeh committed Mar 28, 2019
1 parent 28f42e0 commit 34a7dea
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 32 deletions.
28 changes: 25 additions & 3 deletions INSTALL.md
@@ -1,21 +1,43 @@
# Installation instructions

## Python Dependencies

All programs require the installation of Python 3, which can be
obtained at <https://www.python.org/downloads/> or through package
managers (depending on the operating system). Current installations
already include `pip` which is used to install further packages.

In a terminal, run the command

pip3 install lxml bibtexparser bs4
$ pip install -r requirements.txt

to install the required packages.

## Runtime Dependencies

Additionally, you will need these extra tools installed ( = in your systems $PATH ):
* [graphicsmagick](http://www.graphicsmagick.org/)
* [tralics](https://www-sop.inria.fr/marelle/tralics/)
* [pandoc](https://pandoc.org/)
* curl
* from your latex distribution:

- pdfcrop
- xelatex

For a successful run of the whole conversion you will also need a
slightly older version (Version 2.1) of the biber tool. You can
download the source and/or binaries at
https://sourceforge.net/projects/biblatex-biber/files/biblatex-biber/2.1/

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.

In later versions, the file format was changed. We still need to adapt
to the new format.

## TEI components
Clone the repositories
- https://github.com/TEIC/TEI.git
Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -57,7 +57,7 @@ See [doc/XSL.md](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/
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](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/INSTALL.md).
Follow the installation instructions in [INSTALL.md](./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](https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts/blob/master/INSTALL.md) for details.
See [INSTALL.md](./INSTALL.md) for details.

- lxml (<https://pypi.org/project/lxml/>)
- bibtexparser (<https://pypi.org/project/bibtexparser/>)
Expand Down
4 changes: 2 additions & 2 deletions doc/COSMOS.md
Expand Up @@ -12,8 +12,8 @@ Contains the most important programs for the whole document conversion workflow.
- `imxml2django.py` : Create an XML file that can be inserted into the Django database of an EOAv1 installation.
- `imxml2epub.py` : Convert a customized DocBook XML file into a set of files that constitute the contents of an EPUB file.
- `imxml2tei.py` : Unfinished program to convert a customized DocBook XML to TEI-XML.
- `libeoabibitem.py`: A library for the formatting of bibliographical references.
- `libeoaconvert.py` : A collection of functions for the different conversion steps
- `utils/libeoabibitem.py`: A library for the formatting of bibliographical references.
- `utils/libeoaconvert.py` : A collection of functions for the different conversion steps
- `mkimage.py` : Create an automatically generated dummy cover to be used during testing.
- `tei2eoatex.xsl` : An XSL converter from TEI-XML to EOATeX
- `tei2imxml.py` : A converter from TEI to customized DocBook XML.
Expand Down
22 changes: 0 additions & 22 deletions doc/INSTALL.md

This file was deleted.

4 changes: 2 additions & 2 deletions doc/eoaclassic-workflow.md
Expand Up @@ -25,8 +25,8 @@ This document documents the different parts of the *EOA classic* workflow, which
## imxml2epub.py
## imxml2tei.py
## Libraries
### libeoabibitem.py
### libeoaconvert.py
### utils/libeoabibitem.py
### utils/libeoaconvert.py
## Other files
### config
### debug
Expand Down
7 changes: 6 additions & 1 deletion requirements.txt
@@ -1,3 +1,8 @@
lxml==3.8.0
beautifulsoup4==4.7.1
bibtexparser==1.1.0
bs4==0.0.1
future==0.17.1
pyparsing==2.3.1
PyPDF2==1.26.0

soupsieve==1.9

0 comments on commit 34a7dea

Please sign in to comment.