%CSP.Documatic

class %CSP.Documatic extends %CSP.Page

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Automatic HTML Document Generator for InterSystems classes.

The documentation for a class can consist of just plain text, or it may have embedded HTML tags. When present, these tags are also sent to the browser displaying the class page. Thus, it is possible to exert finer control over the presentation of class information such as list formatting, definitions, even tables.

If HTML is used to enhance the display, the user should take care to follow the HTML standard and insert as little markup as necessary to accomplish the job. The reason for this is that the class documentation may be viewed on many different browsers, each of which has its own extensions. The closer the HTML is to the standard (and to those features of the standard that all browsers support), the better the chance that the information will appear the same on all displays.

Documatic also supports several additional tags:

Method Inventory

Parameters

parameter CSPURL = /csp/documatic/%CSP.Documatic.cls;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter DEFAULTNS = %SYS;
parameter DOCUMATICCENTRALCSSFILE = https://docs.intersystems.com/irislatest/csp/documatic/classrefstyles.min.css;
parameter DOCUMATICFEEDBACKURL = ../docbook/Doc.Feedback.cls;
parameter DOCUMATICLOCALCSSFILE = classrefstyles.min.css;
parameter DOMAIN = %Utility;
Default Localization Domain
parameter EMPTYNS = -EMPTY NAMESPACE-;
parameter URL = %25CSP.Documatic.cls;

Methods

classmethod DefinedByClose(QHandle As %Binary) as %Status [ Language = objectscript ]
classmethod DefinedByExecute(ByRef QHandle As %Binary, type As %String, member As %String) as %Status [ Language = objectscript ]
classmethod DefinedByFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod GetJquery() [ Language = objectscript ]
Get the script tag for including jquery
classmethod ImplementedByClose(QHandle As %Binary) as %Status [ Language = objectscript ]
classmethod ImplementedByExecute(ByRef QHandle As %Binary, type As %String, member As %String) as %Status [ Language = objectscript ]
classmethod ImplementedByFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod ReferencedByClose(QHandle As %Binary) as %Status [ Language = objectscript ]
classmethod ReferencedByExecute(ByRef QHandle As %Binary, refclass As %String) as %Status [ Language = objectscript ]
classmethod ReferencedByFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod RenderCode(streamIn As %CharacterStream, lang As %String, streamOut As %AbstractStream) [ Language = objectscript ]
Color the code in streamIn based on the language lang and return the result in the stream streamOut. If lang is 'NONE' then it will not try and syntax color the example code.
classmethod RenderDescription(thisclass As %String, desc As %String, starttag As %String, endtag As %String) [ Language = objectscript ]
Write a description string out as HTML. Apply substitutions for documatic tags.

Queries

query DefinedBy(type As %String, member As %String)
Selects ClassName As %String
The DefinedBy query returns a list of class names that define member member. type is the type of the class member, e.g., "method".
query ImplementedBy(type As %String, member As %String)
Selects ClassName As %String
The ImplementedBy query returns a list of class names that implement member member. type is the type of the class member, e.g., "method".
query ReferencedBy(refclass As %String)
Selects ClassName As %String, Property As %String
The ReferencedBy query returns a list of class names that refer to (has properties of type) refclass.

Inherited Members

Inherited Methods

Subclasses

Feedback