To generate HTML documentation for an XQuery document, use the dialog XQuery
Documentation. It is opened with the action . . It can be also opened from the Project
Tree's . . The dialog enables the user to configure a set of parameters of the
process of generating the HTML documentation. The parameters are:
The XQuery Documentation Dialog
- Input - The Input panel allows the user to
specify either the File or the Folder which
contains the files for which to generate the documentation. One of the two text fields of
the Input panel must contain the full path to the XQuery file.
Extensions for the XQuery files contained in the specified directory can be added as
comma-separated values. Default there are offered xquery, xq, xqy.
- Default function namespace - Optional URI for the default namespace
for the submitted XQuery, only if it exists.
- Predefined function namespaces - Optional engine dependent,
predefined namespaces that the submitted XQuery refers to. They allow the conversion to
generate annotation information to support the presentation component hypertext linking,
only if the predefined modules have been loaded into the local xqDoc XML repository.
- Open in browser - When checked, the generated documentation is
opened in an external browser.
- Output - Allows the user to specify where the generated
documentation is saved on disk.