doc.enduser.cmd-user-guide.html Maven / Gradle / Ivy
DAISY Pipeline Command Line User Guide
DAISY Pipeline Command Line User Guide
This document is a User Guide to the command line version of the Daisy Pipeline. If you want to run Daisy Pipeline using a graphical user interface (GUI), read the GUI user guide instead.
This guide refers to the "Daisy Pipeline installation directory" several times. If you installed the DAISY Pipeline command-line-only distribution, this directory is the place where you unzipped the Pipeline files.
If you installed the Pipeline GUI application, this directory refers to $PIPELINE_GUI_INSTALLDIR/plugins/org.daisy.pipeline_1.X.X/
Daisy Pipeline Overview
The DAISY Pipeline is a framework for XML- and DTB-related transformations. As such, it can be employed in various contexts, relating to both content creation and distribution.
The actual functionality within the DAISY Pipeline is provided by several collaborating organizations. Most contributions are open source, and reside at the DAISY Pipeline Sourceforge project.
You can contribute!
The DAISY Pipeline fully depends on the spirit of sharing within the DAISY community. Remember: you can contribute to its future in many ways: by developing new functionality, by writing or reviewing documentation, by supplying feature requests, and by reporting bugs.
If you want to contribute, contact any of the project participants, or send an email to markus.gylling[at-sign]tpb.se.
See also the Making a feature request and Reporting a bug sections below.
Configuration
Before running the Pipeline, open pipeline.user.properties located in the pipeline installation directory and edit the following properties:
- pipeline.tempDir
- Directory to store temporary files in. This directory must be set, and write access to it must be enabled.
- pipeline.lame.path
- Path to the LAME executable (Must be set if you intend to run a script that includes MP3 encoding). Further information is available in the LAME installation instructions.
- pipeline.imageMagick.converter.path
- Path to the ImageMagick convert executable (Must be set if you intend to run the WordML to DTBook script). Further information is available in the ImageMagick installation instructions.
- pipeline.dotify.cli.path
- Path to the Dotify CLI executable (Must be set if you intend to run the DTBook to PEF script). Further information is available in the Dotify installation instructions.
Executing Daisy Pipeline
Windows
To run Daisy Pipeline, open a command shell and run the pipeline.bat file in the Daisy Pipeline installation directory. Since a few command line paramaters need to be supplied, it is not possible to double click on the .bat file from Windows Explorer.
If your Java 5 (or later) isn't found on your system path, you need to edit the pipeline.bat file and supply a full path to the java.exe on the line that starts with set JAVA=.
Linux/MacOSX/Unix
To run Daisy Pipeline, execute the pipeline.sh shell script. The executable bit must be set on the file in order to be executable, run chmod u+x pipeline.sh to achieve that.
If you get complaints about missing or incorrect version of Java when you run pipeline.sh, edit the line in the beginning of the file that starts with JAVA= and supply a full path to a Java 5 (or later) executable.
Command line parameters
The basic command line parameters pattern is:
[-i] scriptfile --name=value...
- -i
- Print some information about scriptfile instead of running it.
- scriptfile
- The path to the scriptfile to run. The scripts are located in the
scripts subdirectory of the Daisy Pipeline installation.
- --name=value
- Sets script parameter name to value. In order to be able to run a script, values for all required script parameters must be supplied. When running on Windows, the script parameters must be enclosed in double quotes like this:
"--name=value".
Making a Feature Request
To make a feature request, please sign on to SourceForge, and use the DAISY Pipeline Feature Request tracker.
If you want to discuss a feature before making a request for it, you may subscribe to the DAISY Pipeline interest group emailing list. To do this, please contact markus.gylling[at-sign]tpb.se.
Reporting a bug
To report a bug, please sign on to SourceForge, and use the DAISY Pipeline Bug tracker.
Getting further help
If you need help or have some other type of question, you should primarily use the DAISY Consortium Training and Technical Support emailing list. Information on how to subscribe to this list is available on http://www.daisy.org/get_involved/join-lists.asp.