http://www.zorba-xquery.com/modules/project_xqdoc ZC

Module Description
Before using any of the functions below please remember to import the module namespace:
import module namespace pxqdoc = "http://www.zorba-xquery.com/modules/project_xqdoc";

Function library provides functions for generating the XQDoc XML's for a project.

Author:

Sorin Nasoi

XQuery version and encoding for this module:

xquery version "3.0" encoding "utf-8";

Zorba version for this module:

The latest version of this module is 2.0. For more information about module versioning in Zorba please check out this resource.

Module Resources
Module Dependencies

Imported modules:

Imported schemas:

Please note that the schemas are not automatically imported in the modules that import this module.
In order to import and use the schemas, please add:

import schema namespace xqdoc =  "http://www.xqdoc.org/1.0";
import schema namespace output =  "http://www.w3.org/2010/xslt-xquery-serialization";

Namespaces
an http://www.zorba-xquery.com/annotations
err http://www.zorba-xquery.com/modules/xqdoc2xhtml/error
fetch http://www.zorba-xquery.com/modules/fetch
file http://expath.org/ns/file
output http://www.w3.org/2010/xslt-xquery-serialization
pxqdoc http://www.zorba-xquery.com/modules/project_xqdoc
ver http://www.zorba-xquery.com/options/versioning
werr http://www.w3.org/2005/xqt-errors
xqd http://www.zorba-xquery.com/modules/xqdoc
xqdoc http://www.xqdoc.org/1.0
zm http://www.zorba-xquery.com/manifest
Variables
$pxqdoc:serParamXml
The serialization parameters for XML serialization.
Function Summary
Sequential delete-XML-dir ( $xqdocPath as xs:string ) as empty-sequence()
Delete the intermediary xml dir.
Sequential generate-xqdoc-XML ( $zorbaManifestPath as xs:string, $xqdocPath as xs:string ) as empty-sequence()
This function generates the XQDoc XML for all the modules found in build/ZorbaManifest.
get-filename ( $moduleURI as xs:string ) as xs:string
Returns the string resulting from replacing the directory-separators (i.
Nondeterministic load-manifest ( $zorbaManifestPath as xs:string ) as document()?
This function loads the ZorbaManifest.
Functions
Sequential delete-XML-dir back to 'Function Summary'
declare function pxqdoc:delete-XML-dir (
            $xqdocPath as xs:string
) as empty-sequence()

Delete the intermediary xml dir

Parameters:
Returns:

Sequential generate-xqdoc-XML back to 'Function Summary'
declare function pxqdoc:generate-xqdoc-XML (
            $zorbaManifestPath as xs:string,
            $xqdocPath as xs:string
) as empty-sequence()

This function generates the XQDoc XML for all the modules found in build/ZorbaManifest.xml

Parameters:
Returns:

get-filename back to 'Function Summary'
declare function pxqdoc:get-filename (
            $moduleURI as xs:string
) as xs:string

Returns the string resulting from replacing the directory-separators (i.e. / ) with '_'

Parameters:
Returns:

load-manifest back to 'Function Summary'
declare function pxqdoc:load-manifest (
            $zorbaManifestPath as xs:string
) as document()?

This function loads the ZorbaManifest.xml

Parameters:
Returns:

blog comments powered by Disqus