doc.enduser.installation.html Maven / Gradle / Ivy
Daisy Pipeline Installation
Daisy Pipeline Installation
This document describes how to get and install the Daisy Pipeline (GUI version) on your system
Prerequisites
In order to run the Daisy Pipeline, you need to have the Java Runtime Environment (JRE) version 5 or later installed on your system.
The Java Runtime Environment can be downloaded from http://www.java.com.
Installation
On Windows XP
- Download the "DAISY Pipeline GUI for Windows" on the Pipeline download page.
- Launch the downloaded installer: PipelineGUI-versiondate_setup.exe
- Follow the instructions of the installer.
On Mac OS X
- Download the "DAISY Pipeline GUI for Mac OS X" on the Pipeline download page.
- Mount the "PipelineGUI-versiondate.dmg" disk image (with double-click or cmd-down).
- Make sure to read the README file.
- Copy the "DAISY Pipeline" application to the folder of your choice (for instance the "Applications" folder).
Note: the disk image comes with an installer for the external utility tools used by some Pipeline transformers. If you want to install these tools, launch the "External Tools" installer and follow the instructions.
On Linux(es)
- Download the "DAISY Pipeline GUI for Linux" on the Pipeline download page.
- Create a directory on your local file system where you want to install the application.
- Extract the content of the "PipelineGUI-versiondate.tar.gz" archive to the newly created directory.
Note: you may want to create a shortcut to the Pipeline executable and put that on a convenient place (such as your desktop) for convenient access later on.)
Configuration
Paths to third party executables called by the Pipeline are configurable in the Preferences dialog, which can be reached from the Window menu item.
Note that on Windows and Mac OS X the installer takes care of setting the right paths and installing the required third party tools.
The paths that may be set are:
Temporary Directory- Directory to store temporary files in. This directory must be set, and write access to it must be enabled.
LAME executable- Path to the LAME executable (Must be set if you intend to run a script that includes MP3 encoding).
ImageMagick convert executable- Path to the ImageMagick convert executable (Must be set if you intend to run the WordML to DTBook script with image conversions).
SoX executable- Path to the SoX (Sound eXchange) executable used on Mac OS X for speech synthesis.
Information on how to install LAME is available in Installing the Lame MP3 Encoder for use within the Daisy Pipeline.
Information on how to install ImageMagick is available in Installing ImageMagick for use within the Daisy Pipeline.
Advanced configuration
Using a non-default Java virtual machine
In order to run the Daisy Pipeline using a non-default (not the one found on the system path) Java virutal machine (JRE), use the -vm [JRE path] command line parameter when starting the GUI.
Displaying the browser widget on Linux
If the browser widget used by for example the documentation perspective in the Daisy Pipeline GUI doesn't work, it can be configured by following the instructions at eclipse.org.
Updates
The DAISY Pipeline can be updated by applying zipped patches provided by the development team. These zip patches can be applied using the Updates... entry in the Help item of the main menu bar of the Pipeline GUI.
Update patches are available on the sourceforge and also listed on the Pipeline download page.
For more information on how to use the update feature, please refer to the Pipeline User Guide
Uninstalling the Pipeline
To uninstall the Pipeline, simply delete the directory to which you extracted the Pipeline application archive during the installation process.
On Windows XP
Use the Pipeline uninstaller available in the Pipeline installation directory.
On Mac OS X
Delete the "DAISY Pipeline" application from the applications directory.
On Linux(es)
Delete the directory to which you extracted the Pipeline application archive during the installation process.