doc.scripts.DTBForwardMigrator.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipeline1-adapter Show documentation
The newest version!




	
	Pipeline Script: DTB Forward Migrator [BETA]
    
	


Pipeline Script: DTB Forward Migrator [BETA]


	Overview
	Input Requirements
	Output
    Configuration
    Appendix: List of Transformers used



Overview

This script migrates a valid DAISY 2.02 talking book to a Z39.86-2005 equivalent.


Input Requirements
A valid DAISY 2.02 talking book. Please note that no validation of this book is performed before
transformation takes place,
so any problems during transformation or with the result of the process, might be due to
invalid input.

Please note that the DAISY 2.02 talking book must be a Single Volume DTB.
	If you want to migrate a Multi Volume DTB, you should first use the
	DTB Merger to merge the volumes together.
	
The content document(s) associated with the talking books must comply with the restrictions given for the XHTML to DTBook transformer,
see especially the section Requirements for the canonical form of the XHTML document.


Configuration

    
	Input NCC
	Required. The NCC of the DAISY 2.02 DTB to be migrated.
	Output Directory
	Required. The directory for the resulting Z39.86-2005 DTB.
    
	Input DTB Type
	Optional. Used to specify the type of DTB to be migrated. This parameter is optional, with
			Auto detect as the default value.
	Identifier
	Optional. A string that uniquely identifies the Zed DTB to be generated. If no value is supplied, a value is extracted from the input NCC.
	Add NCX navLabel audio
	Optional. Check this box to have audio added to the NCX navMap,
			pageList and navList elements.
			The process of adding such audio elements will increase the transformation time notably,
			especially for DAISY 2.02 books with a rich navigational structure.
			The default is not to add audio elements.
	Audio clip length
	Optional. Use this parameter to specify the shortest allowed clip length for audio used for navLabel
			elements in the NCX. Minimum value is 1 millisecond and maximum is 5000 milliseconds (equals 5 seconds).
			If the first audio event in the DAISY 2.02 DTB, that is associated with the relevant navigation point, is shorter than
			the specified value, the transformer will try to add another audio event to the  navLabel.
			The default is 1000 milliseconds (equals 1 second).
			

			Note; it only makes sense to specify a value for this parameter, if the "Add NCX navLabel audio" check box is checked.
	Transfer NCC metadata
	Optional. Check this box to have appropriate metadata transfered from the DAISY 2.02 NCC file to the
			DTBook file(s) generated in the process.
			The default is not to transfer metadata.
    Optional CSS
	Optional. The Cascading Style Sheet (CSS) to be referenced from the generated DTBook document(s).
        If no CSS is specified, a default CSS (dtbook.2005.basic.css) will be referenced from the DTBook file(s).
    
    Optional Resource File
	Optional. The Z39.86-2005 Resource File that will be copied to the output directory, and form a part of the
			talking book.
			If no resource file is specified, no such file will be available in the resulting talking book.
    




Output
A Z39.86-2005 file set that is hopefully valid. The output is automatically validated, so watch out for error reports.

Appendix: List of Transformers used
The documents linked below are parts of the Transformer technical documentation. These are developer and systems-administrator centric documents.

	DTB Migrator
			
				Validator