%CSP.Documatic

class %CSP.Documatic extends %CSP.Page

Automatic HTML Document Generator for InterSystems classes.

This class generates a fully formed HTML page for the requested class definition. You can include HTML markup within your descriptions. Note that the description of the class is contained within the <body> element on the page, so your markup should not include the tags <html>, <body>, <head>, <title>, <meta>, or any other tags normally contained within <head>. Also, the class name is displayed as a <h1> heading, so if you use headings, use only <h2> and lower headings.

If you use HTML to enhance the display, 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 (which it converts to standard HTML):

<CLASS>Classname</CLASS> This produces a link that when clicked on will take you to the documentation for the class named 'Classname'.
<METHOD>Method</METHOD> Produces a link that will take you to the method called 'Method' in the current class.
<PROPERTY>Property</PROPERTY> Produces a link that will take you to the property called 'Property' in the current class.
<QUERY>Query</QUERY> Produces a link that will take you to the query called 'Query' in the current class.
<PARAMETER>Parameter</PARAMETER> Produces a link that will take you to the parameter called 'Parameter' in the current class.
<EXAMPLE>Set A="Test</EXAMPLE> Formats the text enclosed in the <EXAMPLE></EXAMPLE> tags as a formatted code example. The example will include syntax colorizing if possible, using %Library.SyntaxColor.
By default, the syntax colorizer treats the example as ObjectScript. To specify another language, include the LANGUAGE attribute. Other languages include SQL, JAVA, and XML. To see a list of languages currently supported, call the Languages() instance method of %Library.SyntaxColor:
```
  set colorizer=##class(%Library.SyntaxColor).%New()
  set status=colorizer.Languages(.langlist)
  zw langlist
  
```
To suppress syntax colorizing, use <EXAMPLE LANGUAGE=NONE>.

NOTE: You can include the other special tags inside <EXAMPLE>, but other HTML tags are ignored in this context.
<link href="/AboutStreams.html"> Documentation on streams</link> Creates a link to this document using the stream server when coming from CSP so that this document can still be served when you are going through a web server or when you are going to the built in web server.

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 GetBottomOfPageScripts()

classmethod GetTopOfPageScripts()

classmethod RenderCode(streamIn As %CharacterStream, lang As %String, Output streamOut As %AbstractStream)

Arguments

streamIn: Stream that contains code to be colorized
lang: Name of the language in which the code is written. If no syntax colorizing is needed, use "NONE"
streamOut: Stream that contains the colorized code, returned as Output

Queries

query DefinedBy(type As %String, member As %String)

Selects ClassName As %String

Arguments

type: Specifies the type of member, e.g., "method"
member: Specifies the name of the member

Return Value

List of class names that define the given member.

query ImplementedBy(type As %String, member As %String)

Selects ClassName As %String

Arguments

type: Specifies the type of member, e.g., "method"
member: Specifies the name of the member

Return Value

List of class names that implement the given member.

query ReferencedBy(refclass As %String)

Selects ClassName As %String, Property As %String

Arguments

refclass: A classname

Return Value

List of class names that have properties of the type of the given class.

%CSP.Documatic

Method Inventory

Parameters

Methods

Arguments

Queries

Arguments

Return Value

Arguments

Return Value

Arguments

Return Value

Inherited Members

Inherited Methods

Subclasses

%CSP.Documatic

Method Inventory

Copy link to this sectionParameters

Copy link to this sectionMethods

Arguments

Copy link to this sectionQueries

Arguments

Return Value

Arguments

Return Value

Arguments

Return Value

Copy link to this sectionInherited Members

Inherited Methods

Copy link to this sectionSubclasses

Parameters

Methods

Queries

Inherited Members

Subclasses