Module URI

xqdoc-display.xqy

Module Description

This module provides the functions that control the Web presentation of xqDoc. The logic contained in this module is not specific to any XQuery implementation and is written to the Nov 2005 XQuery working draft specification. It should also be noted that these functions not only support the real-time presentation of the xqDoc information but are also used for the static offline presentation mode as well. The static offline presentation mode has advantages because access to a native XML database is not needed when viewing the xqDoc information ... it is only needed when generating the offline materials.

Variables

Internal Functions that reference this Variable
Module URIFunction Name
  
xqdoc-display.xqyprint-external-functions-invoked-by
print-external-variable-references
print-imports
print-modules
Internal Functions that reference this Variable
Module URIFunction Name
  
xqdoc-display.xqyget-module-uris
   

Function Summary

 

Function Detail

 
decode-uri

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).

External Functions that are used by this Function
Module URIFunction Name
  
http://www.w3.org/2005/xpath-functionsreplace
 
get-code-html

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.

External Functions that are used by this Function
Module URIFunction Name
  
http://www.w3.org/2005/xpath-functionsdoc
empty
exists
Internal Functions used by this Function
Module URIFunction Name
  
xqdoc-display.xqyprint-preserve-newlines
 
get-default-html

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

Internal Functions used by this Function
Module URIFunction Name
  
xqdoc-display.xqyget-stylesheet
print-intro
print-modules
 
get-function-names

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

External Functions that are used by this Function
Module URIFunction Name
  
http://www.w3.org/2005/xpath-functionsdoc
exists
normalize-space
 
get-module-html

Construct the HTML for a xqDoc module page.

Internal Functions used by this Function
Module URIFunction Name
  
xqdoc-display.xqyget-stylesheet
print-module-control
print-module-intro
Internal Functions that invoke this Function
Module URIFunction Name
  
xqdoc-display.xqyxqDoc-main
Internal Variables used by this Function
Module URIVariable Name
  
xqdoc-display.xqy$XQDOC_LITE
 
get-module-uris

Construct a list of module uris contained in xqDoc.

Internal Functions that invoke this Function
Module URIFunction Name
  
xqdoc-display.xqybuild-link
Internal Variables used by this Function
Module URIVariable Name
  
xqdoc-display.xqy$XQDOC_URIS
 
get-stylesheet

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.

Internal Functions that invoke this Function
Module URIFunction Name
  
xqdoc-display.xqyget-default-html
get-module-html
 
module-uri

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).

                          
xqDoc-main
External Functions that are used by this Function
Module URIFunction Name
  
http://www.w3.org/2005/xpath-functionsfalse
Internal Functions used by this Function
Module URIFunction Name
  
xqdoc-display.xqyget-module-html
 
 
Created by xqDoc-Lite version 1.0 on Mon May 08 09:27:53 EDT 2006