To generate HTML documentation for an XQuery document, use the XQuery Documentation dialog. It is opened with the XQuery Documentation... action that is available from the menu or from the Generate Documentation submenu in the contextual menu of the Project view.
The dialog allows you to configure a set of parameters of the process of generating the HTML documentation.
Figure: The XQuery Documentation Dialog Box
The following options are available:
- 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/System Application - Select this option if you want
the result to be opened in the system application associated with that file type.Note: To set the browser or system application that will be used, open the Preferences dialog box, then go to Global and set it in the Default Internet browser field. This will take precedence over the default system application settings.
- Output - Allows the user to specify where the generated documentation is saved on disk.