Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [Util] >  [Documentation]
Private  Storage   

class Ens.Util.Documentation

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
17


Summary

Methods
BookName CheckDocExists CreateDoc GetDocHTML


Methods

• classmethod BookName(pProduction As %String, Output BookName As %String, Output BookFileName As %String, Output LogFileName As %String)
Choose a book name and file name for the book and for the log, based on a CRC of the namespace and production name. The files are temporary, they will be created in the system's temp directory.
• classmethod CheckDocExists(pProduction) as %Boolean
Return a boolean value indicating if the production documentation already exists.
• classmethod CreateDoc(pProduction As %String = "", pIntro As %Boolean = 1, pFormat As %String, Output LogFileName As %String, Output URL As %String, Output BookName As %String, PDFFileName As %String = "", PDFRenderer As %String = "", ByRef Params As %String) as %Status
Production documentation generation -- Common code for HTML and PDF formats. See the description for methods CreateDocumentHTML and CreateDocumentPDF in class Ens.Config.Production.
• classmethod GetDocHTML(ProductionClass As %String, Output URL As %String)
Helper method: Return the URL to render the production documentation in HTML format.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.