4.14. Generating ebooks in EPUB format

The EPUB plugin generates ebooks in EPUB format based on ABBYY XML or ALTO files and the corresponding METS files from Goobi. The plugin uses the formatting, tables and images from the ABBYY files to create an ebook.

Starting the plugin

Ein Beispiel-Aufruf des TaskClients lautet folgendermaßen:

java -jar TaskClient.jar -itm http://localhost:8080/itm/service 
    -e 
    -d {imagepath}  
    -gid {processid} 
    -n template.xml 
    -s {processpath}/ocr/{processtitle}_xml/ 
    -T {processtitle} 
    -t EPUB 
    -if {tifpath} 
    -mf {metaFile} 
    -amf {processpath}/meta_anchor.xml

Parameters

The command parameters are explained in the following table:

Parameter	Possible Goobi variable	Meaning
-itm	http://localhost/itm/service	URL to intranda TaskManager interface
-e, --returnError	-	If entered, the TaskClient will end with an error code to prevent the workflow from continuing automatically
-p	0 – 10	Priority to execute this job
-gid	{processid}	Goobi process ID
-i	{stepid}	ID for the workflow step that launches the call
-T, --title	{processtitle}	Goobi process title for which the call is launched
-t, --jobtype	EPUB	Job type
-n, --templatename	template.xml	This parameter is not used by the plugin.
-s, --source	{processpath}/ocr/{processtitle}\_xml/	Path to the folder containing the ABBYY XML files
-d, --destination	{imagepath}	Path to the folder in which the ebook is to be stored
-if	{tifpath}	Path to the images previously used for text recognition by ABBYY
-mf	{metaFile}	Path to the METS file in Goobi
-amf	{processpath}/meta\_anchor.xml	Path to the METS file of the anchor in Goobi. This parameter is used only for periodicals.
-loc	de	Optional parameter used to specify a language variant when generating headings such as the index title. If no other language is specified, the default language is English (en).
-rtl	true / false	Optional parameter to specify whether the work is a book that needs to be processed from right to left (e.g. works in Hebrew). If this parameter is not specified, the default direction is from left to right.

Configuration of the plugin

The configuration path for generating ebooks is shown below:

/opt/digiverso/itm/plugins/config/epubconfig.xml

An example of the structure of this configuration file is given below:

<epubConfig>
 <tempPath>/tmp/</tempPath>
 <jobsInProcessing max="5"/>
</epubConfig>