Digital Publishing Module 1.0

1.1 Namespace conventions

The module defined by this document defines functions and elements in the namespace http://expath.org/ns/digi-pub. In this document, the digi-pub prefix, when used, is bound to this namespace URI.

Error codes are defined in the namespace http://expath.org/ns/error. In this document, err prefix, when used, is bound to this namespace URI.

1.2 Error management

Error conditions are identified by a code (a QName). When such an error condition is reached during the execution of the function, a dynamic error is thrown, with the corresponding error code (as if the standard XPath function error had been called).

2.1 The digi-pub:get-module-metadata() Function

This function is used for getting the metadata of this module. It returns the module metadata.

digi-pub:get-module-metadata() as element(digi-pub:module-metadata)
			

<digi-pub:module-metadata>
	(
	digi-pub:description,
	digi-pub:version,
	digi-pub:namespace-uri,
	digi-pub:prefix,
	digi-pub:formats
	)
</digi-pub:module-metadata>
				

2.2 The digi-pub:transform() Function

This function is used to transform a document from one digital publishing format to another.

digi-pub:transform($transformation-formula as xs:string,
	$input-document as xs:anyAtomicType,
	$options as element(digi-pub:options)?) as xs:anyAtomicType*
			

• $transformation-formula is the formula used to specify the source format and the target format. These formulae are detailed below. If the transformation formula is not supported, this is an error [err:DPUB001].

• $input-document is the document to be transformed from source format to target format.

• $options are the options for the current operation.

$input-format-to-$output-format
			

If the syntax of the transformation formula is wrong, this is an error [err:DPUB004].

If neither the input format, or output format is supported, this is an error [err:DPUB001].

<digi-pub:options>
	(digi-pub:multiple-output?)
</digi-pub:options>
				

2.3 The digi-pub:get-resource-metadata() Function

This function is used for getting the metadata of a resource. It returns the resource metadata.

digi-pub:get-resource-metadata($resource-path as xs:string) as element(digi-pub:resource-metadata)
			

• $resource-path is the path of the resource. If the path is not correct, this is an error [err:DPUB002]. If the user has no rights to access the path, this is an error [err:DPUB003].

2.4 The digi-pub:set-resource-metadata() Function

This function is used for setting the metadata of a resource. It returns true if successfully completed, false if not.

digi-pub:set-resource-metadata($resource-path as xs:string,
	$new-resource-metadata as element(digi-pub:resource-metadata) as xs:boolean
			

• $resource-path is the path of the resource. If the path is not correct, this is an error [err:DPUB002]. If the user has no rights to access the path, this is an error [err:DPUB003].

• $new-resource-metadata is the new resource metadata.

3.1 The digi-pub:validate-identifier() Function

This function is used for validating the publication's numeric identifier. It returns true if successfully completed, false if not.

digi-pub:validate-identifier($identifier as xs:string) as xs:boolean
			

• $identifier is the publication's numeric identifier.

3.2 The digi-pub:parse-identifier() Function

This function is used for parsing the publication's numeric identifier. It returns digi-pub:identifier element, whose content varies according to the identifier, as it is detailed below.

digi-pub:parse-identifier($identifier as xs:string) as element(digi-pub:identifier)
			

• $identifier is the publication's numeric identifier.