doc.scripts.ConfigurableValidator.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: Configurable Validator
	


Pipeline Script: Configurable Validator




Overview
Input Requirements
Output
Configuration
Appendix: List of Transformers used



Overview

This advanced script validates input of varying types, and allows you to customize what validation
is actually performed by allowing you to attach additional validation resources to the process.

Note that the script may or may not be able to perform a validation - if the script is not able
to identify the type of the input file, or if it cannot locate any (built-in or added) validation resources, it will
issue an error message and fail.

Input Requirements

The input file of the document or fileset to be validated.

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 file
	Required. Path to input file		

	XML Report
	Optional. Select a file to store an XML report in. Default is to not store a report at all.
					
	Report stylesheet
	Optional. Add a reference to a specific XSLT stylesheet to include in the XSL processing instruction in the generated XML output. This will override (not complement) the stylesheet that is used as default. This setting only has meaning if the XML Report setting has been activated.
	
	Abort on Exception
	Optional. Whether to perform a Job abort when a caught exception occurs. Default is true.
	
	Generate Context Info
	Optional. 
	Show additional hints on the location of the error; if available, nearest heading, nearest page, surrounding text and XML path. This feature does not work identically across grammars, and for some grammars not at all. Default is false.
		
	Additional schemas
	Optional. Comma separated list of additional schemas to apply while validating. The schemas can be of Schematron, RelaxNG or WXS types.
		
	Java delegates
	Optional. Comma separated list of fully qualified names of Java delegates to execute on the input. The delegates must implement the org.daisy.util.fileset.validation.delegate.ValidatorDelegate interface.
		
	Force implementation
	Optional. A fully qualified Java name of a Fileset validator to use to validate an input fileset. The validator must implement the org.daisy.util.fileset.validation.Validator interface.
			
	Require Input Type
	Optional. Require the input content to be of a specific type, if the content is not of this type, abort. The default value is "Off", meaning that content type requirement checks are not made.					

		
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