%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.
To use, point a browser at: http://127.0.0.1:1972/csp/documatic/%25CSP.Documatic.cls.
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 special tags in addition to those defined by 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 documentation for property 'Property' in the current class.
- <QUERY>Query</QUERY> Produces a link that will take you to the documentation for the query 'Query' in the current class.
- <PARAMETER>Parameter</PARAMETER> formats the method parameter 'Parameter' in the parameter style.
- <EXAMPLE>Set A="Test</EXAMPLE> Formats the text enclosed in the <EXAMPLE></EXAMPLE> tags as a code example. This will syntax highlight the code if possible, as well as formatting it to look pretty. You can include the other tags 1-5 inside an <EXAMPLE> tag, however no other HTML formatting will work inside an <EXAMPLE> tag. By default it assumes the language you are entering the example in is COS, if you wish to specify another language use <EXAMPLE LANGUAGE=BAS> for Basic, if you do not wish it to attempt to color the language enter <EXAMPLE LANGUAGE=NONE>.
- <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.
Method Inventory
- DefaultNS()
- DefinedByClose()
- DefinedByExecute()
- DefinedByFetch()
- GetStyleSheetHTML()
- ImplementedByClose()
- ImplementedByExecute()
- ImplementedByFetch()
- OnPage()
- OnPreHTTP()
- ReferencedByClose()
- ReferencedByExecute()
- ReferencedByFetch()
- RenderClassPage()
- RenderCode()
- RenderDescription()
- RenderIndexPage()
- RenderNameSpaceList()
- RenderNameSpacePage()
- RenderPackageInfo()
- RenderPackagePage()
- RenderStoragePage()
- SwapNS()
Parameters
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.
Methods
Queries
Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %New()
- %OriginalNamespace()
- %PackageName()
- %SetModified()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- OnHTTPHeader()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()