doc.scripts.OPSCreator.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: EPUB Creator
	


Pipeline Script: EPUB Creator



Overview
Input Requirements
Output
Configuration
Appendix: List of Transformers used



Overview
This script creates an EPUB Open Publication Structure (OPS) 2.0 publication.

Input Requirements
The input to the script is one or several DTBook or XHTML documents.
If you are adding several documents, ensure that they are added in the logical order of the presentation (Chapter1.xml; Chapter2.xml) etc.
When selecting an input document, only point to the root/manifest file (XHTML or DTBook document); auxilliary files (CSS, images, etc) are added automatically.


	The OPS Specification is quite picky about what kind of text documents can be used within an EPUB. You can only use XHTML 1.1 (not 1.0) documents, or DTBook 2005-2 (not 2005-1 or 2005-3) documents.
	If you add a document of a type not supported by the specification, this script will issue a warning and then attempt to convert the document into an allowed version, preferrably XHTML 1.1.


Output
An OPS 2.0 publication, including an NCX. The OPS publication is wrapped in an OCF container.
If the NCX is not created according to your expectations, note that you can
configure how the NCX is generated. Be warned however that this is 
a rather complex endeavour that requires XML knowledge.

Note - the OPS creator does not (yet) support the XML Island and fallback features of OPS 2.0.



The output OPS publication is validated using the IDPF.org EpubChecker tool

Handling of metadata
As the default case, it is expected that the input documents contain all required Dublin Core metadata. However, it is possible to specify metadata values explicitly when running the script (see Configuration below).
If you set an explicit value for a metadata item, and that item exists in the content document as well, your explicit value will take precedence.

Configuration

	
		Input file(s)
		Required. One or several DTBook or XHTML documents, added in proper order.
		
		Output OCF
		Required. Output OCF (*.epub) file
		
		forceXhtml			
		Optional. Force XHTML-based EPUB (even with DTBook 2005-2 input). Defaults to true.
		
		dc:title			
		Optional. Dublin Core Title (OPS required)

		dc:identifier			
		Optional. Dublin Core Identifier (OPS required)

		dc:language			
		Optional. Dublin Core Language. A language code. (OPS required)
	
		dc:creator			
		Optional. Dublin Core Creator

		dc:publisher			
		Optional. Dublin Core Publisher

		dc:date			
		Optional. Dublin Core Date (date of publication). Must be in format YYYY(-MM-DD)

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

	OPS Creator
	Unicode Normalizer
	Pretty Printer
	Validator	
	OCF Creator