From 34a7dea5070484a647c22e29e905bf7a4fac2109 Mon Sep 17 00:00:00 2001 From: EsGeh Date: Thu, 28 Mar 2019 15:41:40 +0100 Subject: [PATCH] docu: fix redundant/outdated information, dependencies, updated python deps --- INSTALL.md | 28 +++++++++++++++++++++++++--- README.md | 4 ++-- doc/COSMOS.md | 4 ++-- doc/INSTALL.md | 22 ---------------------- doc/eoaclassic-workflow.md | 4 ++-- requirements.txt | 7 ++++++- 6 files changed, 37 insertions(+), 32 deletions(-) delete mode 100644 doc/INSTALL.md diff --git a/INSTALL.md b/INSTALL.md index 3f509e4..8f5195d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,14 +1,33 @@ +# Installation instructions + +## Python Dependencies + All programs require the installation of Python 3, which can be obtained at 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 @@ -16,6 +35,9 @@ directory, an XSL processor like [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 diff --git a/README.md b/README.md index 882c719..71f1acb 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 () - bibtexparser () diff --git a/doc/COSMOS.md b/doc/COSMOS.md index f04f9da..09f5ab0 100644 --- a/doc/COSMOS.md +++ b/doc/COSMOS.md @@ -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. diff --git a/doc/INSTALL.md b/doc/INSTALL.md deleted file mode 100644 index 2ef2a5e..0000000 --- a/doc/INSTALL.md +++ /dev/null @@ -1,22 +0,0 @@ -For running the tool you will need two additional Python modules. `lxml` -and `PyPDF2`. If you use pip for installing them, there's the -`requirements.txt` which you can run using the command - - pip install -r requirements.txt - -Additionally, you will need two extra tools: -* [graphicsmagick](http://www.graphicsmagick.org/) -* [tralics](https://www-sop.inria.fr/marelle/tralics/) - -Then, edit `config/eoaconvert.cfg` and adjust the paths accordingly. -_texbin_ is the directory that contains executables like _xelatex_. You -can use the which command (e.g. `which xelatex`) to find the correct -path. - -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 later versions, the file format was changed. We still need to adapt -to the new format. diff --git a/doc/eoaclassic-workflow.md b/doc/eoaclassic-workflow.md index 8ebb561..cdcb588 100644 --- a/doc/eoaclassic-workflow.md +++ b/doc/eoaclassic-workflow.md @@ -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 diff --git a/requirements.txt b/requirements.txt index 18e0863..c61ecf8 100644 --- a/requirements.txt +++ b/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