Who We Are
This section details the known limitations of the current xqDoc conversion package.
The following list highlights these limitations to minimize any problems that could
be encountered when utilizing the xqDoc tools.
The following limitations apply when an underlying XML database is used to store the xqDoc XML.
There should be no function declared with the name of 'xqDoc-main' in a main module. This is because xqDoc uses 'xqDoc-main' to
represent a pseudo function for the XQuery body which can exist within a main module outside of the prolog. The
name choice of 'xqDoc-main' was arbitrary and we are open to suggestions.
Embedded XQuery comments within a function will not be visible when viewing the source code for a function. However,
if the source code for the entire module is viewed, the embedded XQuery comments will be retained.
The xqDoc grammar (part of the xqDoc conversion package) attempts to follow the W3C Recommendation for XQuery 1.0. In some cases, the grammar will actually
support cases not permitted in the specification to allow for support of various XQuery implementations extensions.
The following limitations apply when a XQuery processor is used to store xqDoc XML in the filesystem.
Each XQuery library module must be identified by a unique URI value (defined in the library module declaration).
This URI value must be unique since it will be used to enable cross-reference links for the xqDoc XML associated with the library module.
This also implies that the XPath F&O URI should not be used for a user defined
library module URI.
Each XQuery main module must be identified by a unique URI value (using the baseModule prefix and name passed to the xqDoc conversion package).
Once again, the URI value must be unique since it will be used to enable cross-reference links for the xqDoc XML associated with the main module.
More details on base module prefix and name convention can be found in the conversion documentation.
Only intra document links will be hypertext linked when displaying functions and variables that are
used by a function. The 'text' will be displayed for external references, it will simply not
be hypertext linked.
The @see xqDoc comment parameter can only be used to display text or reference external web sites. It
can not be used to link internally to other xqDoc modules (including functions and variables).