Publish.Utils

class Publish.Utils

Method Inventory

CompileExclusionList()
GetRationalizedExclusionList()
Initialize()
InitializeAndChoose()
LoadedMatchesInstalled()
RereadFile()
SelectivelyUpdateGlobals()
SetCanonicalBaseURL()
SetGlobals()
SetMaintRelStuff()
ShowBuildSpec()
UseSelectedBuildSpec()

Methods

classmethod CompileExclusionList(ByRef docbookobj As Publish.DocBook = "", verbose As %Boolean = 0)

Updates ^Settings("EXCLUSIONS") from the relinfo file

classmethod GetRationalizedExclusionList(ByRef docbookobj As Publish.DocBook = "") as %String

classmethod Initialize(verbose As %Integer = 0, noop="") as %Boolean

Initialize the tables from files

classmethod InitializeAndChoose(verbose As %Integer = 1) as %String

Gives user a selection of products and then releases. When user selects a release, this method sets the DocBook configuration globals.

classmethod LoadedMatchesInstalled(verbose As %Boolean = 0) as %Boolean

This method returns true or false to indicate whether the underlying instance matches the loaded DocBook content. Use this to determine whether to suppress links to the local Class Reference.

classmethod RereadFile(filename As %String = "") as Publish.RelInfo

Helper method for use by SelectivelyUpdateGlobals.

classmethod SelectivelyUpdateGlobals(verbose As %Boolean = 1)

Rereads the relinfo file and uses it to set these nodes in ^Settings:

^Settings("EXCLUSIONS"), which we update constantly as new content is added to IRIS/IFH and needs to excluded elsewhere
^Settings("excludedtags"), which is undergoing churn right now
^Settings("maintrelnum"),which gets updated at each maintenance release
^Settings("P4ChangesFile"), which gets updated at each maintenance release
^Settings("P4HistoryFile"), which gets updated at each maintenance release
^Settings("maintrelnotesurl"), which is for use in older versions
^Settings("EXTERNAL"), which gets updated as we need to add or remove external files like devdoc/API doc
^Settings("ITEMSTOLOAD"), which is derived from other settings

classmethod SetCanonicalBaseURL(ReleaseID As %String = "", verbose As %Boolean)

Set the global ^Settings("CanonicalBaseURL") appropriately for the release ID given in the ReleaseID argument.

classmethod SetGlobals(ReleaseID As %String = "", verbose As %Boolean = 1) as %String

The ^docmaint routine calls this when you select a release ID. Given a release ID, this method sets nodes in several key globals that are used when we load content and when we render content. This message returns a warning message or an empty string.

classmethod SetMaintRelStuff(buildspec As Publish.RelInfo = "", verbose As %Boolean = 0)

Sets ^Settings("P4ChangesFile"), ^Settings("P4HistoryFile"), ^Settings("maintrelnum"), and ^Settings("maintrelnotesurl"). The last of these applies only in old content.

classmethod ShowBuildSpec(ReleaseID As %String = "")

Utility method

classmethod UseSelectedBuildSpec()