Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.93 KB

README.md

File metadata and controls

55 lines (40 loc) · 1.93 KB
Raw

Post Processor Workbench

ppwb is a set of tools used in post-processing, the final stage of ebook production.

The workbench is a web front-end written in PHP that performs a variety of post-processing activities by calling out to external programs. It consists of a user-visible page (index.php) with links to programs for text analysis (see pptext.php), HTML analysis (see pphtml.php), "smart quote" processing (see ppsmq.php) and a file compare tool (see ppcomp.php).

The following two external tools need to be installed in directories under bin/:

It's recommended that you clone those repos into bin/ directly:

cd bin
git clone https://github.com/DistributedProofreaders/pptext.git
git clone https://github.com/DistributedProofreaders/pphtml.git
git clone https://github.com/DistributedProofreaders/ppcomp.git

See the individual tools' README.md for their prerequisites.

For ppcomp to work, dwdiff needs to be installed as well.

Python environment

The external python programs require various python libraries to be installed in order to work. Consult with each of the tools' requirements.txt files for more details. These can be installed in the system's python3 installation or in a virtualenv dedicated for ppwb.

If using a virtualenv, you will need to create a python proxy script to initialize the environment. For example:

#!/bin/bash

VENV=/path/to/virtualenv/basedir/
source $VENV/bin/activate

python $*

Make this script executable and set it as your $python_runner in config.php.

Ensure that the web server can access the virtualenv. virtualenvs created in ~/.local may need to have the permissions updated (o+x) to allow the web server sufficient permissions.