doc.scripts.DTBookValidator.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: DTBook Validator
	


Pipeline Script: DTBook Validator




Overview
Input Requirements
Output
Configuration
Appendix: List of Transformers used



Overview
This script validates a DTBook XML document. The validation process includes the following:

	Validation of the document structure against the DTD.
	
	Validation of the document structure beyond the constraints expressed in the DTD.

	These additional constraints are defined by the formal Z3986 conformance validator ZedVal.

	Examples of additional constraints are:

	
	  That the metadata required by the Z3986 specification is actually present
	  That the link between a note reference and a note resolve
	
	
	
	Validation of local links, that is, checking that all referenced images, CSS stylesheets, etc, are actually present.


If you want to validate your DTBook document and add constraints that are specific to your organisation or production flow, you can use the more advanced Configurable Validator script.

Input Requirements

A DTBook XML document.

Output
By default, this script does not render any physical output; instead, messages are displayed in the user interface.
However, by configuring the XML Report setting, you can have the validation result stored in an XML document.

Configuration



	
	Input DTBook
	Required. Path to input DTBook document		
	XML Report
	Optional. Path to a file to store an XML report in				
	Generate Context Info
	Optional. 
	Show additional hints on the location of the error; if available, nearest heading, nearest page, surrounding text and XML path. Default is false.
	

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

	Validator