xqdoc-display.xqy

build-link

• view code
• ( $type as xs:string ,
    $local as xs:boolean ,
    $parms as xs:string* ,
    $name as xs:string?) as element()?
  
  

Construct a link. Based on the parameters, the link will be built for the static (off-line viewing mode of xqDoc) or the dynamic viewing mode of xqDoc. The parameters will also indicate which link to construct, supply the appropriate paramters for the link, and assign a name for the link.

• Parameters:
• $type - the type of link to construct. The link can be for the xqDoc home page, the module page for a particular module, or for the XQuery code for a specific function.
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• $parms - the parameters associated with the link $type
  
• $name - the name to assign for the link
  
• Return:
• HTML

decode-uri

• view code
• ( $uri as xs:string) as xs:string
  
  

Decode the uri. This routine is needed for some XML databases that have problems with specific characters contained in a document URI. This routine makes the URI more human readable ... by removing the encoding. Currently, the only character encoded is a "/". Other characters could easily be added. However, they would also need to be specified in the xqDoc conversion package (XQDocContext).

• Parameters:
• $uri - the string to be decoded
  
• Return:
• the decoded string

get-code-html

• view code
• ( $module as xs:string ,
    $name as xs:string? ,
    $local as xs:boolean) as element()
  
  

Construct the HTML that will contain the XQuery code for the function in the current module (or the entire module). The code will be presented via a Javascript popup Window from the module. The lack of a $name parameter indicates to construct the HTML for entire module.

• Parameters:
• $module - the uri associated with the current module
  
• $name - the name associated with the current function contained in the module
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML ... the XQuery code for the function

get-default-html

• view code
• ( $local as xs:boolean) as element()
  
  

Construct the HTML for the xqDoc home page. This will include the welcome text and the list of modules available in xqDoc.

• Parameters:
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

get-function-names

• view code
• ( $module as xs:string) as xs:string*
  
  

Construct a list of function names defined in the current module.

• Parameters:
• $module - the uri for the current module
  
• Return:
• List of function names defined in the current module

get-module-html

• view code
• ( $module as xs:string ,
    $local as xs:boolean) as element()
  
  

Construct the HTML for a xqDoc module page.

• Parameters:
• $module - the module uri
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

get-module-uris

• view code
• ( ) as xs:string*
  
  

Construct a list of module uris contained in xqDoc.

• Return:
• List of module uris contained in xqDoc

get-stylesheet

• view code
• ( ) as element()
  
  

Get the xqDoc presentation stylesheet. This is embedded into the returned XHTML for all of the presentation pages. It is embedded into pages (instead of referencing a link) to keep things simple for the off-line viewing mode.

• Return:
• the stylesheet

module-uri

• view code
• ( $e as element()) as xs:string
  
  

Find the module uri for the associated element. This routine is needed since we can't rely soley on base-uri(). Instead, the xqDoc XML URI is contained in the XML of the document (the xqDoc module section).

• Parameters:
• $e - the element (i.e. function or variable) that we want to find the module uri
  
• Return:
• the module URI associated with the element

print-comment

• view code
• ( $comment as element()* ,
    $name as xs:string? ,
    $local as xs:boolean) as element()*
  
  

Construct the xqDoc HTML for the specified xqDoc comment. The following xqDoc comment values are supported.

• author
• version
• param
• return
• error
• deprecated
• see
• since
• empty which indicates a description

• Parameters:
• $comment - the xqDoc comment element associated with a function
  
• $name - the xqDoc comment name to process (i.e. author, version, etc.)
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-comment-param

• view code
• ( $entry as element()) as item()*
  
  

Construct the xqDoc HTML for the specified xqDoc param comment element.

• Parameters:
• $entry - the xqDoc param comment element associated with a function
  
• Return:
• HTML

print-comment-see

• view code
• ( $entry as element() ,
    $local as xs:boolean) as item()*
  
  

Construct the xqDoc HTML for the specified xqDoc see comment element. If the comment is a URI that exists for a module contained within xqDoc, build a link to this module (and optionally method or variable name. If the comment is a 'http://' URL, then build a link to the URL. If the comment is simply text, return the text. With version 1.1, it is now also possible to specify the visible display name for the link. This is accomplished by specifying an option second semi-colon followed by the link name. So, the format for the parameter would be as follows:

• Parameters:
• $entry - the xqDoc param comment element associated with a function
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-detail-comment

• view code
• ( $comment as element()* ,
    $name as xs:string? ,
    $local as xs:boolean) as element()*
  
  

Construct the detailed xqDoc HTML for the specified xqDoc comment. Detailed essentially implies the xqDoc comments for the method detail. The following xqDoc comment values are supported.

• author
• version
• param
• return
• error
• deprecated
• see
• since
• empty which indicates a description

• Parameters:
• $comment - the xqDoc comment element associated with a function
  
• $name - the xqDoc comment name to process (i.e. author, version, etc.)
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-external-functions-invoked

• view code
• ( $function as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (contained in other modules) that are used by the current function. If that module exists in xqDoc, construct a link to the module and function. If that module does not exist in xqDoc, simply identify the module and function name.

• Parameters:
• $function - the current function
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-external-functions-invoked-by

• view code
• ( $function as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (contained in other modules) that use the current function. If that module exists in xqDoc, construct a link to the module and function. If that module does not exist in xqDoc, simply identify the module and function name.

• Parameters:
• $function - the current function
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-external-variable-references

• view code
• ( $variable as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (defined in other modules from the current variable) that used the current variable. If that module exists in xqDoc, construct a link to the module and function. If that module does not exist in xqDoc, simply identify the module and function name.

• Parameters:
• $variable - the current variable
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-external-variables-referenced

• view code
• ( $variable as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (defined in other modules from the current variable) that use the current variable. If that module exists in xqDoc, construct a link to the module and function. If that module does not exist in xqDoc, simply identify the module and function name.

• Parameters:
• $variable - the current variable
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-footer

• view code
• ( $uri as xs:string) as element()*
  
  

Construct the fotter information for the current module. The footer will contain the version of the xqDoc conversion program used to generate the xqDoc XML stored in the XML database and the time when the XML was created. If the xqDoc conversion program was not used (i.e. XPath F & O) then this information will be marked as N/A.

• Parameters:
• $uri - the current module uri
  
• Return:
• HTML

print-imports

• view code
• ( $uri as xs:string ,
    $local as xs:boolean) as element()*
  
  

Construct the high-level xqDoc HTML for any modules imported by the module.

• Parameters:
• $uri - the URI for the module
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML.

print-internal-functions-invoked

• view code
• ( $function as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (contained in the module for the current function) that are used by the current function. Construct a link to the module and function.

• Parameters:
• $function - the current function
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-internal-functions-invoked-by

• view code
• ( $function as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (contained in the module for the current function) that use the current function. Construct a link to the module and function.

• Parameters:
• $function - the current function
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-internal-variable-references

• view code
• ( $variable as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (defined in the module for the current variable) that use the current variable. Construct a link to the module and function.

• Parameters:
• $variable - the current variable
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-internal-variables-referenced

• view code
• ( $variable as element() ,
    $local as xs:boolean) as element()*
  
  

Construct the information to identify those functions (defined in the module for the current variable) that use the current variable. Construct a link to the module and function.

• Parameters:
• $variable - the current variable
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML

print-intro

• view code
• ( $local as xs:boolean) as element()+
  
  

Construct the welcome banner for the xqDoc home page.

• Parameters:
• $local - indicates whether to build static HTML link for offline viewing or dynamic linke for real-time viewing.
  
• Return:
• HTML.

print-method-detail

• view code
• ( $uri as xs:string ,
    $local as xs:boolean) as item()*
  
  

Construct the xqDoc HTML method detail for each function defined in the module. The method detail will contain the function signature and all xqDoc comments associated with the function. In addition, cross-reference links will be included for the following:

• Functions (contained in this module) that are used by this function
• Functions (not contained in this module) that are used by this function
• Functions (contained in this module) that use this function
• Functions (not contained in this module) that use this function
• Variables (contained in this module) that are used by this function
• Variables (not contained in this module) that are used by this function

• Parameters:
• $uri - the URI for the module
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML.

print-method-summary

• view code
• ( $uri as xs:string) as element()*
  
  

Construct the xqDoc HTML method summary for each function defined in the module. The method summary will contain the function signature and the first sentence of any xqDoc comments associated with the function.

• Parameters:
• $uri - the URI for the module
  
• Return:
• HTML.

print-module

• view code
• ( $uri as xs:string ,
    $local as xs:boolean) as element()*
  
  

Construct the high-level xqDoc HTML for the module. This is essentially any introductory xqDoc comments that might be associated with the module.

• Parameters:
• $uri - the URI for the module
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML.

print-module-control

• view code
• ( $uri as xs:string ,
    $local as xs:boolean) as item()+
  
  

The controller for constructing the xqDoc HTML information for the specified module. The following information for each module will be generated.

• Module introductory information
• Global variables declared in this module
• Modules imported by this module
• Summary information for each function defined in the module
• Detailed information for each function defined in the module

• Parameters:
• $uri - the URI for the module
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML.

print-module-intro

• view code
• ( $local as xs:boolean) as element()
  
  

Construct the welcome banner for the xqDoc module page.

• Parameters:
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML.

print-modules

• view code
• ( $local as xs:boolean) as element()+
  
  

Construct the list of modules available to xqDoc for presentation. The list of modules is availalbe on the xqDoc home page.

• Parameters:
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML.

print-preserve-newlines

• view code
• ( $strin as xs:string?) as item()*
  
  

Modify the markup (i.e. newlines) associated with an XQuery function so that it presents cleanly in HTML.

• Parameters:
• $strin - the code associated with an XQuery function
  
• Return:
• the presentation friendly version of the code

print-preserve-xqdoc-lite

• view code
• ( $strin as xs:string?) as xs:string*
  
  

Modify the markup (i.e. newlines) associated with an XQuery function so that it presents cleanly in HTML. This function is specific to the 'lite' version of xqDoc (where an underlying XML database is not used to store the intermediate xqDoc XML.

• Parameters:
• $strin - the code associated with an XQuery function
  
• Return:
• the presentation friendly version of the code

print-signature

• view code
• ( $sigs as xs:string* ,
    $local as xs:boolean) as item()*
  
  

Construct the xqDoc HTML for the function signature.

• Parameters:
• $sigs - the signatures associated with the current function. Although only one signature is allowed for user-defined functions, more than one signature is required to support other 'modules' such as XPath F & O.
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• String containing the marked up function signature.

print-variables

• view code
• ( $uri as xs:string ,
    $local as xs:boolean) as element()*
  
  

Construct the high-level xqDoc HTML for any global variables declared in the module. In addition, cross-reference links will be included for the following:

• Functions (contained in this module) that use this variable
• Functions (not contained in this module) that use this variable

• Parameters:
• $uri - the URI for the module
  
• $local - indicates whether to build static HTML link for offline viewing or dynamic links for real-time viewing.
  
• Return:
• HTML.

xqDoc-main

• view code