This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > CSPX.EnsProductionDocumentation


class CSPX.EnsProductionDocumentation extends %CSP.Page

Production Documentation Page - This CSP page displays production documentation as HTML document with links into InterSystems' online documentation in DOCBOOK. If there is an error while producing the book, it displays the errors.

Method Inventory


parameter CHARSET = UTF-8;
Default charset
parameter DOMAIN = Ensemble;
Use our own domain for localization


classmethod DrawHTMLHead()
classmethod OnPage() as %Status
Inherited description: Event handler for PAGE event: this is invoked in order to generate the content of a csp page.
classmethod OnPreHTTP() as %Boolean
Inherited description: Event handler for PreHTTP event: this is invoked before the HTTP headers for a CSP page have been sent. All changes to the %CSP.Response class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing %session.EndSession or %session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to %session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent OnPage() from being called.

Inherited Members

Inherited Methods