Skip to content

Latest commit

 

History

History
1196 lines (905 loc) · 61.9 KB

NEWS.md

File metadata and controls

1196 lines (905 loc) · 61.9 KB
Raw

Changes in release v1.14.20

Framework

  • NEW API for voice previews
  • NEW Allow setting org.daisy.pipeline.tts.config property through settings API
  • FIX Remove error stack traces from webservice responses
  • FIX Java API: Make job input parser more relaxed about boolean option values

Modules

  • NEW Support for Microsoft natural voices over NaturalVoicesSAPIAdapter
  • FIX Support standard CSS's voice-family property (backward compatibility with the old behavior is ensured)
  • FIX Compatibility with espeak-ng
  • FIX Wrong doctype declaration of SMIL files in output of DAISY 3 to DAISY 2.02
  • FIX Indent TTS log output
  • Various other bugfixes and improvements

Details

See all the closed issues of this release. To view using the Github CLI: gh project --owner daisy item-list 6

Changes in release v1.14.19

Framework

  • NEW API to list TTS services and their status (available, disabled or error)
  • NEW Access to Sass variables defined in user agent style sheets via /stylesheet-parameters API

Modules

  • NEW DOCX (MS Word) to DTBook script: this brings some of the functionality of the Word Save-as-DAISY addin to Pipeline
  • NEW Option for speaking image alt text
  • NEW "Style sheet parameters" option supported on more scripts (DTBook to DAISY 3, DTBook to EPUB 3, EPUB 3 Enhancer and EPUB to DAISY)
  • NEW New syntax for "Style sheet parameters" option
  • FIX Improved error diagnostics for Google and Azure TTS services
  • FIX Improved logging of the status of TTS services in general (only show relevant services, shorten error messages)
  • FIX Handle text in sidebar not within p in DTBook to ODT
  • FIX DAISY 3 and DAISY 2.02 MegaVoice multi-level scripts do not try to produce files with forbidden characters in their name anymore
  • FIX Fix NCC metadata in output of DAISY 3 to DAISY 2.02
  • FIX Support for rel="pronunciation" links in DTBook to DAISY 3
  • FIX Support for Apple Silicon processors
  • Changes to braille production scripts, see release notes of braille modules v1.14.26

Details

See all the closed issues of this release. To view using the Github CLI: gh project --owner daisy item-list 5

Changes in release v1.14.18

Framework

  • NEW API for analyzing CSS style sheets and exposing Sass variables.

Modules

  • NEW Script options to specify user lexicons
  • NEW Global setting for default user lexicon
  • NEW Global setting for default speaking rate
  • FIX Major simplification of configuration of braille scripts, see release notes of braille modules v1.14.24 and v1.14.25
  • FIX Fix bugs in handling of language during voice selection.
  • FIX Fix bugs in processing of aural CSS.
  • FIX Improved usability of the DAISY 3 and DAISY 2.02 MegaVoice multi-level scripts.
  • FIX Improve support for DPUB ARIA
  • FIX Preserve external hyperlinks in EPUB
  • FIX Include page source identification metadata in EPUB created from DTBook
  • Other bugfixes and optimizations

Details

See all the closed issues of this release. To view using the Github CLI: gh project --owner daisy item-list 4

Changes in release v1.14.17

Framework

  • NEW API for getting and setting TTS and other properties globally

Modules

  • NEW Script option for specifying aural CSS style sheets for TTS
  • FIX Support for linking to aural CSS style sheets from source document
  • FIX Support for speech-rate CSS property with Azure voices
  • FIX Simplified Azure voice names
  • FIX Improved interpretation of voice configuration XML
    • region subtags are now significant
    • engine overall priority is taken into account
  • FIX Drop title attribute from page breaks when creating HTML from DTBook/ZedAI
  • FIX Take into account enum and start attributes on DTBook lists when converting to RTF
  • FIX Various issues reported by EPUBCheck and Ace in EPUBs created from DTBook, ZedAI and HTML
  • Other bugfixes
  • Changes to braille production scripts, see release notes of braille modules v1.14.19 and v1.14.21

Details

See all the closed issues of this release. To view using the Github CLI: gh project --owner daisy item-list 3

Changes in release v1.14.16

Modules

  • FIX Connection issue in Google TTS adapter
  • FIX Reduce the number of audio files in books generated with text-to-speech
  • Other bugfixes

Changes in release v1.14.15

Framework

  • FIX Some vulnerable dependencies were eliminated
  • Bugfixes

Modules

  • NEW Support for Microsoft Azure Cognitive Speech Services
  • NEW Options for the DAISY 3 and DAISY 2.02 MegaVoice multi-level scripts to choose the player type and book folder level.
  • FIX Better support for HTML with other encodings than UTF-8
  • FIX Retain master.smil if present in a DAISY 2.02 publication
  • FIX Preserve indentation and DOCTYPE declaration of documents in a DAISY 2.02 publication
  • FIX Better marking of page breaks in EPUB 3 output
  • FIX Issues in SAPI adapter
  • Other bugfixes
  • Changes to braille production scripts, see release notes of braille modules v1.14.15 and v1.14.16

Backwards incompatibility note: some script options were renamed. Please check the script documentation and update your client code if needed.

Details

See all the closed issues of this release. To view using the Github CLI: gh project --owner daisy item-list 2

Changes in release v1.14.14

This is a bugfix release. It fixes some regressions in the framework introduced in version 1.14.13.

Changes in release v1.14.13

Framework

  • Simplified and improved script & job API
  • NEW Web API: added "desc" attribute to <result> elements in job XML
  • FIX Make "log" link available in job XML also when a job errors
  • Other bugfixes

Modules

  • NEW NIMAS support: the scripts that produce HTML, EPUB 3 and ZedAI from DTBook now also support NIMAS as input
  • NEW DAISY 3 Upgrader script to upgrade a DAISY 3 publication from version 1.1.0 (Z39.86-2002) to version 2005 (Z39.86-2005)
  • NEW Support for Z39.86-2002 in DAISY 3 to DAISY 2.02
  • NEW Options in DAISY 3 Upgrader and DAISY 3 to DAISY 2.02 to ensure that the output uses allowed audio file formats only (MP2, MP3 and WAVE in the case of DAISY 2.02; MP3, MPEG-4 AAC and WAVE in the case of DAISY 3). Audio files in other formats are transcoded to MP3.
  • FIX Preserve heading hierarchy in DTBook to HTML and DTBook to EPUB 3
  • FIX Wrong EPUB page list heading (in Arabic instead of the requested language) when the xml:lang defined in the DTBook is a three-letter code such as "eng"
  • FIX Issue in Google TTS adapter: clicking sound at beginning of phrases
  • FIX Issues in SAPI adapter
  • Various other bugfixes
  • Changes to braille production scripts, see release notes of braille modules v1.14.14

Details

See all the closed issues of this release. To view using the Github CLI: gh project --owner daisy item-list 1

Changes in release v1.14.12

Details

Changes in release v1.14.11

Framework

  • FIX Issue of empty job log files.
  • FIX Regression in web server: handling of simultaneous requests was broken in release 1.14.10.

Modules

  • FIX Various fixes and improvements to DAISY 3 to MP3 and DAISY 2.02 to MP3 scripts.
  • FIX Headings generated from aria-label attributes are now inserted after any leading page breaks.
  • Other bugfixes

Details

Changes in release v1.14.10

Modules

  • NEW Script to transform a DAISY 2.02 into a folder structure with MP3 files (experimental)
  • NEW Script to unscramble audio files in a DAISY 2.02 publication
  • NEW Support for new type of Windows text-to-speech voices ("OneCore" voices).
  • Changes to braille production scripts, see release notes of braille modules v1.14.11

Framework

  • FIX Bug in web server: store files with spaces in their name correctly in result ZIP

Details

Changes in release v1.14.9

Modules

  • FIX bypass sentence detection in EPUB when sentence spans are already present
  • Various bugfixes

Details

Changes in release v1.14.8

Framework

  • NEW org.daisy.pipeline.ws.cors setting to permit cross-origin requests from browsers (Cross-Origin Resource Sharing).

Modules

  • NEW Script to transform a DAISY 3 into a folder structure with MP3 files (experimental)
  • FIX DAISY 2.02 validator did not support WAVE audio file type
  • Optimizations
  • Bugfixes

Details

Changes in release v1.14.7

Framework

  • Engine optimizations

Modules

  • Improvements to TTS log
  • The org.daisy.pipeline.tts.log setting is deprecated. Since v1.14.3 there is a dedicated script option to enable the TTS log.
  • Changes to braille production scripts, see release notes of braille modules v1.14.8
  • Various optimizations
  • Various other improvements and bugfixes

Details

Changes in release v1.14.6

Modules

Details

Changes in release v1.14.5

Framework

  • Engine optimizations
  • Remove external dependency on the Lame MP3 encoder

Modules

  • NEW Automatic selection of MacOS voices
  • NEW Automatic selection of Windows (SAPI) voices
  • NEW Automatic selection of Google Cloud TTS voices
  • NEW Possibility to select Norwegian voices for CereProc
  • NEW TTS configuration setting for bitrate of MP3s
  • FIX CereProc TTS adapter
  • FIX SAPI adapter
  • FIX Google Cloud TTS adapter
  • FIX Bug in DTBook to DAISY 3 script: <?xml-stylesheet?> processing instructions were getting lost in the conversion.
  • FIX Bug in EPUB Updater script: embedded TrueType fonts were not preserved.
  • Changes to braille production scripts, see release notes of braille modules v1.14.6

Details

Changes in release v1.14.4

Modules

  • NEW DAISY 2.02 to DAISY 3 upgrader script
  • NEW Support for CereProc text-to-speech engine
  • Improvements to the EPUB 3 enhancer script
    • NEW Options to update dc:identifier and title in content documents based on EPUB metadata.
    • FIX Error when processing EPUB with double-occurrence page numbers in navigation document.
    • FIX Don't strip doctype from XHTML documents.
  • Improvements to the EPUB 3 to DAISY 2.02 script
    • FIX Improved handling of anchor elements: href attributes are dropped in cases where navigation between elements is handled through SMIL.
  • Improvements to the DAISY 2.02 to EPUB 3 script
    • FIX broken epub:textref links in SMILs.
  • Changes to braille production scripts, see release notes of braille modules v1.14.3

Details

Changes in release v1.14.3

Modules

  • EPUBCheck updated to 4.2.5
  • Improvements to the EPUB 3 enhancer script
    • NEW Option to perform sentence detection even when text-to-speech is disabled. Useful for talking book production with human narration.
    • NEW Option to specify class attribute for sentence spans.
    • NEW Option to include additional metadata in the EPUB package document.
    • NEW Option to update lang attributes of content documents based on metadata in the package document.
    • NEW Support for ::before and ::after pseudo-elements in speech CSS, to include speech-only content.
    • NEW Option to generate text content for page numbers based on the navigation document or aria-label and title attributes.
    • NEW Option to generate headings for untitled sections based on aria-label attributes.
    • FIX Improvements to sentence detection.
  • Improvements to the EPUB 3 to DAISY 2.02 script
    • NEW NCC now lists the noterefs present in the publication.
    • FIX Page numbers, footnotes, endnotes and sidebars are now skippable.
    • FIX The result does not contain nested a elements anymore (invalid HTML).
  • NEW Option to enable TTS log (without having to modify the TTS configuration)
  • FIX Timeout issues in TTS process
  • Changes to braille production scripts, see release notes of braille modules v1.14.2
  • Various other bugfixes and improvements

Details

Changes in release v1.14.2

This is a bugfix release. It fixes some installation and launch issues there were introduced in release v1.14.1.

  • FIX Launch script was broken on Linux.
  • FIX Debian installer was broken when updating from old version.
  • FIX Braille scripts were broken when running without OSGi.

Details

Changes in release v1.14.1

Distribution/Installation

  • The configuration files were simplified. Note for Debian users: if you have made changed to configuration files, we recommend to first uninstall before installing the new version, and then manually apply your configuration changes again.
  • The location of the user properties configuration file was changed. See the Help pages for more information.

Framework

  • By default the system is now run without OSGi. An option was provided to run the system within an OSGi framework (Apache Felix) like before.
  • Repetitive log messages are hidden.
  • Some improvements were made to the Java API. The long-term goal is to make Pipeline usable as Java library.

Graphical User Interface

  • Made compatible with MacOS Big Sur.

Modules

  • Changes to braille production scripts, see release notes of braille modules v1.14.0
  • NEW Support for ssml:ph and ssml:alphabet attributes in EPUB 3 (for text-to-speech)
  • NEW TTS log output for EPUB 3 Enhancer script
  • FIX Improvements to TTS voice selection logic
  • FIX Timeout issues in TTS process
  • FIX Bug in DAISY 3 to DAISY 2.02 (empty title field in NCC)
  • Various other bugfixes and improvements

Details

Changes in release v1.13.6

Framework

  • FIX Bug in web server: datatypes could not be retreived by non-admin clients.
  • The web server can now be run outside the OSGi framework.
  • Speed/performance improvements

Modules

  • NEW Support for Google Cloud text-to-speech engine
  • NEW Option to create media overlays with TTS in EPUB 3 enhancer script
  • NEW EPUB 3 to DAISY 3 script
  • NEW EPUB 2 to EPUB 3 updater script
  • NEW EPUB to DAISY convenience script which produces both DAISY 3 and DAISY 2.02.
  • FIX A lot of bug fixes and improvements to EPUB 3 to DAISY 2.02
  • Changes to braille production scripts, see release notes of braille modules v1.13.7
  • FIX Bug in DAISY 3 to DAISY 2.02 SMIL conversion
  • FIX Validation issue in DTBook to DAISY 3
  • Major XProc code cleanup

Details

Changes in release v1.13.5

Modules

Details

Changes in release v1.13.4

Modules

Details

Changes in release v1.13.3

Modules

Details

Changes in release v1.13.2

Modules

Details

Changes in release v1.13.1

Modules

  • FIX Bug in DTBook to DAISY 3 script

Details

Changes in release v1.13.0

Distribution/Installation

  • The minimum required Java version is changed back to 8 (but newer versions are also still supported)
  • FIX Loading of TTS configuration on Mac OS
  • FIX Problem with windows start menu

Framework

  • The core part of Pipeline including all the conversion scripts can now be run outside the OSGi framework. This means it is possible to use Pipeline as a regular Java library from any Java application and get most of the functionality. The web server and the graphical user interface are not part of this yet.
  • FIX Out of memory error when zipping up a lot of mp3's

Modules

  • NEW Produced EPUBs are now compliant with the EPUB 3.2 specification
  • NEW "Accessibility check" option for the "EPUB 3 Validator" script that invokes DAISY Ace if it is installed on the system.
  • FIX Validation issues with produced DAISY 2.02, especially in case of text-only
  • FIX Attempt to fix timeout issues in text-to-speech process
  • FIX Speed up the DTBook to ZedAI conversion
  • FIX Make it possible to run a DAISY 3 to EPUB 3 conversion offline, or when the DAISY website is down
  • EPUBCheck updated to 4.2.2
  • Various changes to braille production scripts, see release notes of braille modules v1.13.0
  • XProc code cleanup

Details

Changes in release v1.12.1

This is a bugfix release. It fixes epub3-validator which was broken in release v1.12.0.

Details

Changes in release v1.12.0

Distribution/Installation

  • FIX Installation issues on Windows
  • Minimum Java requirement is changed to Java 11

Command Line Interface

  • NEW Progress indication of jobs
  • NEW Improved help for script options, incl. possible values and default values
  • NEW Validation of script options
  • NEW Configurable verbosity of help command

Framework

  • Refactoring of messaging system, incl. support for progress indication
  • Calabash (XProc engine) updated to version 1.1.20
  • Saxon (XSLT/XPath engine) updated to version 9.8.0.8

Modules

  • NEW Improved HTML chunking, incl. new option "chunk-size" for daisy3-to-epub3, dtbook-to-epub3, dtbook-to-html, zedai-to-epub3 and zedai-to-html scripts
  • NEW Configuration file for well-known TTS voices
  • Scripts with TTS now fail when audio is missing
  • Various changes to braille production scripts, see release notes of braille modules v1.11.2
  • XProc code cleanup

Details

Changes in release v1.11.1

Distribution/Installation

  • FIX Installation and launch issues on Windows

Modules

  • FIX Error in epub3-to-daisy202 when EPUB has multiple dc:identifier in OPF
  • FIX Support "dir" attribute on dtbook element in dtbook-to-epub3
  • FIX Support validating unzipped EPUBs
  • FIX Issue with adapter for Qfrency speech engine
  • Various changes to braille scripts, see release notes of braille modules v1.11.1

Details

Changes in release v1.11

Distribution/Installation

  • NEW The application is now available as a set of Docker images

Graphical User Interface

  • Improved accessibility
  • Improved troubleshooting for application launch issues on Windows

Framework

  • Simplified configuration

Modules

  • NEW DTBook to ODT (OpenDocument Text) script
  • NEW DTBook to RTF (Rich Text Format) script
  • NEW Support for Qfrency text-to-speech engine
  • NEW EPUB 3 enhancer script for adding a braille rendition to an EPUB
  • various changes to braille scripts, see release notes of braille modules v1.11.0
  • FIX Issues with lost significant spaces in dtbook-to-zedai and zedai-to-html
  • FIX Improve support for DTBook 1.1.0
  • Simplified configuration of text-to-speech

Details

Changes in release v1.10.4

This is a bugfix release. It includes fixes to daisy202-to-epub3 and epub3-to-daisy202 that were advertised but not included in release v1.10.2.

Details

Changes in release v1.10.3

  • Fixed regression in all modules that perform XSD validation

Details

Changes in release v1.10.2

Installer/Updater

  • FIX Updater couldn't find the Pipeline installation from the registry on 64bit Windows
  • FIX Updater couldn't find releases info ("404 not found")

Framework and API

  • Improve launch-time stability
  • Support file names with spaces inside zipped job context
  • Improve search algorithm for binaries
  • FIX Spaces in paths of book files cause job failure

Modules

  • Add basic tests for all scripts
  • daisy202-to-epub3 Various bugfixes and/or tests:
    • FIX smil references inside links should also be removed
    • FIX Whenever a epub:textref attribute is added to a SMIL, an attribute-value attribute with the same value is added
    • FIX epub:textref in SMIL refers to .html files instead of .xhtml files
    • FIX Remove superfluous xmlns:d from package document metadata
  • dtbook-to-epub3 various bugfixes and/or tests:
    • FIX Issue with whitespace being removed
    • FIX The "assert validity" option on dtbook-to-epub3 does not seem to work
  • daisy202-validator
    • FIX Attribute "shape" not allowed here
  • braille modules
  • TTS modules
    • FIX problem finding lame
  • Utility modules
    • fileset-utils change the actual base URI of documents in px:fileset-load

Build maintenance

  • Cleanup dependencies in Maven POMs
  • Update Calabash to v1.1.9
  • Reorganize the build of some modified/OSGified 3rd party libraries
  • Move web API tests to the pipeline-framework project
  • Add a modules-test-helper project for reducing boiloplate in Pipeline modules tests
  • Various enhancements to the pax-exam-helper test helper
  • Various improvements to the xproc-maven-plugin
  • Re-enable all XSpec and and XProcSpec tests in the modules

Details

Changes in release v1.10.1

Modules

  • Fixed missing audio bug in scripts with speech synthesis

Changes in release v1.10

Distribution

  • NEW new graphical user interface (GUI)
  • NEW installers for the GUI on Windows
  • NEW packaged application on Mac OS X
  • online Java installer bundled in the Windows installer
  • Java Runtime Environment bundled in the Mac OS X app

Command Line Interface

  • NEW clean command to remove jobs with an ERROR status
  • inputs and options arguments are no longer prefixed with --i and --x
  • the version command now works as expected
  • Properly detect Java under OpenJDK and Ubuntu 15.04

Framework and API

  • NEW Add datatypes to options and list them through the api
  • NEW Expose the default value for options
  • NEW Add support for job batches
  • Get rid of the folder in zipped ports and options
  • Catch out of memory errors
  • Return a more meaningful error when inputs are not corect
  • Improved control of script removal
  • Improved logging filters
  • Normalize whitespace in script documentation parsing
  • Do not strip out spaces if xml:space="preserve"
  • Allow posting job requests using a namespace prefix

Modules

  • NEW DAISY 2.02 validator
  • NEW DAISY 3 (audio-only) to DAISY 2.02
  • NEW EPUB 3 validator (EpubCheck)
  • NEW EPUB 3 to PEF script
  • NEW HTML to PEF script
  • Experimental audio-only DAISY 3 production
  • Improved MathML production in DAISY 3
  • Improved NIMAS validation
  • Optimized fileset lading
  • ... and various other bug fixes

Details

Changes in release v1.9

Distribution

  • NEW new CLI implementation (in Go)
  • NEW per-platform distribution, with native CLI executables
  • improve Java detection on Mac OS X
  • notify users of unsupported Java version
  • improve build of Debian packages

Framework and API

  • NEW Primary outputs are returned in the jobs list from the web API
  • NEW Script version is returned in the web API
  • Update Calabash (XProc engine) to v1.0.23
  • Configurable number of concurrent threads
  • Fix support for UNC paths on Windows

Modules

  • NEW DAISY 2.02 validator
  • NEW DTBook to ODT script
  • NEW DTBook to EPUB 3 with TTS-narrated Media Overlays
  • NEW EPUB 3 to DAISY 2.02 script (experimental)
  • audio new API for audio encoders
  • audio make sure we have logs when Lame is failing
  • epub3 Set the title metadata in EPUB 3 HTML Content Docs
  • epub3 Fix improper tagging of spine items as "non-linear"
  • daisy202-to-epub3 Align audio-only conversion to the TIES guidelines
  • dtbook Fix loss of MathML IDs when converting to ZedAI or EPUB 3
  • dtbook Fix support for validation of DTBook 2005-1 and 1.1.0
  • nlp Proper detection of sentences and words in multiple HTML documents
  • tts Fix a bug with voice listing on Mac OS X
  • tts Possibility to use XSLT in TTS SSML adapters
  • tts Improve multithreading
  • tts Gender-based voice selection
  • tts New modules to process EPUB 3 documents
  • tts Fine selection of TTS voice with aural CSS
  • tts improve support for SAPI5
  • tts Delete the generated audio directory when the JVM exits gracefully

Details

Changes in release v1.8.1

Windows Installer

  • FIX issue that prevented a 64-bit JRE to be detected

Framework and API

  • FIX a memory leak in the XProc adapter.
  • FIX a bug preventing the deletion of a job's log in Windows
  • FIX URI mapping for the non-local mode
  • FIX Recalculate priorities when a new job is sent to the queue
  • FIX Add nicename to the jobElement schema (Web API)
  • FIX The CLI now returns 255 if the job failed

Web UI

  • FIX issue with reports not being displayed

Modules

  • zedai-to-epub3 Fix a conversion issue when the source has multiple toc elements

Details

Changes in release v1.8

Framework

  • Update Calabash (XProc engine) to version 1.0.18
  • Update Saxon (XSLT/XPath engine) to version 9.5.1.5
  • Reorganize the framework's packages and projects
  • The IP address the web service binds to is now configurable
  • Catch logging statements from EclipseLink libraries
  • Add a priority-management system to the job queue
  • New utility class BinaryFinder to find executables in $PATH

Modules

  • NEW dtbook-to-daisy3 script with TTS-based audio production
  • NEW modules for TTS-based audio production, including adapters for: Acapela TTS (v7), eSpeak, Microsoft Windows SAPI5, Max OS X Speech
    Note: the SAPI5 adapter requires the pre-installation of Visual C++ Redistributable Packages runtime components.
  • NEW modules for NLP-based structure detection
  • NEW EpubCheck adapter module (script not included in this release)
  • braille Property for using an externally installed liblouisutdml only
  • braille Remove -brl- prefix from Braille CSS properties
  • braille Add CSS properties border, margin, padding, left, right
  • braille Deprecate CSS "display: toc-item"
  • braille Improve pef:compare
  • braille css-core: allow functions in 'content' declarations
  • braille liblouis-formatter: render TOC items more accurately
  • braille Update to liblouis 2.5.4 and liblouis-java 1.2.0
  • braille Add many tests
  • common-utils New px:message step that allows to set logging levels
  • common-utils New px:i18n-translate XPath function and XProc step used for localization
  • css-utils New XSLT utility to retrieve a list of CSS stylesheet URIs from a document
  • daisy202-to-epub3 New option to set the output file name
  • daisy202-to-epub3 The default EPUB file nameuse is now only based on the identifier
  • daisy202-to-epub3 Copy more of the metadata to the resulting EPUB3
  • daisy202-to-epub3 Improved performance
  • daisy3-to-epub3 temporary files are no longer included in the result directory
  • dtbook-to-epub3 temporary files are no longer included in the result directory
  • dtbook-to-zedai Better conversion of image descriptions in prodnotes
  • epub3-utils Compatibility with the latest EPUB 3.0.1 specifications
  • epub3-utils Allow non-linear spine items in px:epub3-opf-create
  • epub3-utils Allow non-numbered page breaks (use a hyphen in the Nav Doc)
  • file-utils Expand 8.3 file names during URL normalization
  • file-utils Add a 2-args pf:normalize-uri that discards URI fragments
  • fileset-utils Add support for "file:/...zip!/..." URIs
  • fileset-utils Added "encode-as-base64" option to px:unzip-fileset
  • fileset-utils Various fixes and improvements to px:fileset-store
  • html-utils Rewrite of the HTML to XHTML5 upgrader + tests
  • html-utils Simplify and improve the html-to-fileset implementation
  • html-to-epub3 Better conversion of longdesc and aria-describedat attributes
  • html-to-epub3 DIAGRAM descriptions are now converted to HTML embedded in hidden iframe elements
  • mediaoverlays-utils improved performance
  • validation-utils Added support for message severity and report metadata
  • zedai-to-epub3 temporary files are no longer included in the result directory
  • zip-utils don't create d:file elements for directories when unzipping
  • all Integration of XSpec testing
  • all Update custom XPath functions to the new Saxon 9.5 API
  • all reorganize Maven POMs and BoMs
  • all and other small fixes and improvements

Web UI

  • The Web UI now must run on the same file system as the Pipeline engine
  • better file names for downloads
  • FIXED incorrect content type was returned when downloading single files
  • FIXED Unable to set password for newly created account
  • FIXED Missing submit button in "add user" section of admin settings
  • FIXED Web UI does not allow downloading results bigger than 100 MB

CLI (Ruby implementation)

  • Add job priority option and print it in the job status
  • Add client priority options
  • Add queue command and resource
  • Add options to move jobs up and down the execution queue

Installation

  • Change java version check from nsis installer
  • A Debian package can now be produced from the assembly project

Details

Changes in release v1.7

Command-line tool

  • Now the results are always get through a zipped file with the --output option
  • Handle VALIDATION_FAIL status
  • Fix single result handling
  • Move .lastid to the appropriate folder ( %APP_DATA%/Daisy Pipeline 2/dp2/ in windows; ~/.daisy-pipeline/dp2 in linux and ~/Library/Application Support/DAISY Pipeline 2/dp2 in OS X
  • Added suport for multiple-valued options

Web API

  • /scripts/$ID : All the outputs are filtered out
  • /scripts/$ID : Order of options preserved from the script when building the xml representation.
  • alive: @mode disappears in favor of @localfs=(true|false)
  • jobs/$ID : The file size is returned along with the result files (not for the zip files).
  • jobs/$ID : When the local fs is accessible the actual location is returned in the result xml response. This can be used to fetch the results from disk bypassing the web ui.
  • MD5 and file size added to the http headers when a file is returned.
  • Added support for multiple-valued options.

Framework

  • When a validation fails during the job execution the VALIDATION_FAIL status is returned. (Currently only working with validation scripts but all the scripts that validate outputs could implement this functionality in the future).
  • Update to guava version 15.0
  • Custom logger avoids creating default log file and duplicating framework logging lines.
  • The framework controls all the outputs as it used to do in remote mode and they have to be fetched through the web api
  • Fixed size limits for inputs and options.

Modules

  • NEW: asciimath-utils module wrapping ASCIIMathML.js
  • common-utils: addeed missing DTDs to catalogs
  • common-utils: px:assert: added test-count-min and test-count-max options
  • common-utils: new px:tokenize step
  • fileset-utils: px:fileset-store: store c:data documents as text
  • fileset-utils: px:fileset-store: don't systemtically indent XML
  • fileset-utils: px:fileset-store: store c:data documents as text
  • fileset-utils: px:fileset-store: support serialization options
  • fileset-utils: new px:fileset-rebase step
  • html-to-epub3: support multiple HTML documents as input
  • html-to-epub3: allow to provide custom metadata
  • html-to-epub3: improved HTML chunking
  • html-to-epub3: support empty page breaks in page lists
  • epub3-pub-utils: better metadata merging
  • zip-utils: new px:unzip-fileset step
  • zedai-to-pef: page numbering improvements (e.g. support `counter-reset: braille-page' in CSS)
  • zedai-to-pef: better whitespace handing (e.g. support `xml:space=preserve')
  • zedai-to-pef: update dependencies (liblouis, libhyphen dictionaries, etc.)
  • all: harmonized all URIs of public components
  • all: use fileset-utils for all file set loading
  • all: various fixes and improvements

Web UI

  • support for running behind proxies (no absolute URLs; the absolute URL to the Web UI must be set in e-mail settings if you want to enable e-mail support).
  • Added support for hiding scripts from guests and public users.
  • Support for the new job result API where you can download individual files. when there's only one file in the results, the main download button downloads that file directly. Otherwise it downloads the zip.
  • support for HTML reports that are displayed inline on the job status page when the job finishes.
  • Temporary and result directories are not handled by the Web UI anymore; they are handled by the Pipeline 2 engine. No need to configure them in the UI anymore.
  • Ability to compile the webui in a continous integration environment (i.e. Jenkins)
  • Renamed project from pipeline2-webui to daisy-pipeline-webui
  • Split desktop and server into separate maven projects (desktop depends on server)
  • Packaging of the distributables are now performed by the "pipeline-assembly" project