Home > Class Reference > ENSLIB namespace > %zDocBookUtils.HTML
Private  Storage   

%zDocBookUtils.HTML


Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
17


Summary


Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
GetBodyEnd GetBodyStart GetBreadcrumbArrayForClass GetBreadcrumbDiv
GetCookieSeen GetGTMBodyCode GetGTMCode GetHomeDivAsFooter
GetLocatorDiv GetLogoDiv GetSitesMenu GetSkipDivHTML
GetSkipLinkHTML GetStyleSheet GetStylesheetName GetStylesheetNameForOldUI
GetUniversalFooter


Methods


• classmethod GetBodyEnd(scenario As %String = "", DocBookID As %String = "") as %String
scenario is "docbook" "ispexport" or "static" and DocBookID is a DocBook KEY. This argument is used only in the DOCBOOK namespace.
• classmethod GetBodyStart(pageTopic As %Boolean = 0, skiplink As %Boolean = 0) as %String
• classmethod GetBreadcrumbArrayForClass(namespace As %String = "%SYS", classname As %String = "") as %DynamicArray
• classmethod GetBreadcrumbDiv(breadcrumbarray="", showCount As %Integer = "", classname="locatordiv") as %String
Given a breadcrumb array, return the HTML we can use to display a locator div for it. breadcrumbarray is an array of objects, each of which has the properties title, subtitle, type, and url. GetBreadcrumbArray() in DocAPI.v1.Content) returns such an array. So does GetBreadcrumbArrayForClass(), in this class.
• classmethod GetCookieSeen() as %String
• classmethod GetGTMBodyCode() as %String
For use immediately after <body>
• classmethod GetGTMCode() as %String
for use in HTML head
• classmethod GetHomeDivAsFooter()
• classmethod GetLocatorDiv(locatorobject As %DynamicObject = "", classname="locatordiv") as %String
Given a locator object, returns the breadcrumbs/locator div.
• classmethod GetLogoDiv(useLocal As %Boolean = "")
• classmethod GetSitesMenu() as %String
For use at the top of a page
• classmethod GetSkipDivHTML() as %String
• classmethod GetSkipLinkHTML() as %String
• classmethod GetStyleSheet(useLocal As %Boolean = "") as %String
We use the useLocal argument to always get the local stylesheet (in the case of the PDF index)
• classmethod GetStylesheetName(useLocal As %Boolean = "")
• classmethod GetStylesheetNameForOldUI(useLocal As %Boolean = "")
• classmethod GetUniversalFooter(footerinfo As %DynamicObject = "", addID As %Boolean = 0) as %String
footerinfo is null or is a dynamic object as returned by GetFooterInfo in DocAPI.v1.Other, which can be used only in the DOCBOOK namespace. if addID is 1, then we add the id="searchfooter" to the
(for CSS purposes).