Pipeline Lite is a minimalist user interface used to run single Pipeline jobs and designed to ease the development of export functionality in third-party applications. It consists of a sequence of 5 dialogs which will select a Pipeline script, configure the job, run it and report the result.
The various dialogs making up Pipeline Lite are described below. Note: some of these dialogs are skippable or customizable via command line options as detailed.
This dialog allows the user to select a script to instantiate into a job. The script list matches the content of the scripts directory in the Pipeline home.
This dialog can be skipped if the user directly specifies a script file with the script option.
When a script is selected (via the script selection dialog or the –script command line option), a job is created and the job configuration dialog is shown to set parameters. The dialog initially shows only the required parameters for the job. and the Run button becomes enabled when all these required parameters are set. Additionally, the user can expand the dialog to access further optional parameters by pressing the Advanced button.
This dialog can be skipped if the user specifies the execute option and sets all the required parameters with the -params option.
When the job is launched (via the Run button in the job configuration dialog or directly via the –execute command line option), a progress information dialog is shown. This dialog consists of a simple progress bar labelled with the job name. The name of the subtask is displayed by default below the progress bar and can be hidden with the –no-subtask command line option.
Job execution can be cancelled by pressing the Cancel button. However, any modifications of the file system that have already occurred will not be undone.
When the job execution is complete a result dialog is shown. The user can access the detailed list of Pipeline messages by pressing on the Details button. These messages can then be copied to the system clipboard using the usual keyboard shortcuts or a popup menu.
This dialog can be skipped if the user specifies the quit option.
When job execution fails, an error dialog is shown. The user can access a detailed list of Pipeline messages by pressing on the Details button. These messages can be copied to the system clipboard using the usual keyboard shortcuts or a popup menu.
Pipeline Lite offers a number of different options which are described below:
usage: pipeline [options] [-s <file>] [-p <param#value,...>]
- i—info display information on the script specified with ‘-s’
- no subtask—don’t display the subtask label in the progress dialog
- h—help print this help message
- p—params <param#value,…> set script parameters
- q—quit quit after a successful execution (no result dialog)
- s—script <file> the script file to execute
- v—verbosity <threshold> the severity with which messages are logged. Possible values are: DEBUG, INFO_FINER (default), INFO, WARNING, ERROR
- x—execute execute the script directly if all required parameters are set
pipeline -i -s path/to/DTBAudioEncoder.taskScript
pipeline -x -q -s path/to/DTBAudioEncoder.taskScript -p input#path/to/manifest.opf
Note: in Windows, the user can launch Pipeline Lite via a pipeline-lite.bat DOS script on the command line, or via a pipeline-lite.exe executable file. In the latter case the application will be run in GUI mode, and the options can be passed by creating a shortcut pointing to this executable.Pipeline 1