Publish.SiteMap

class Publish.SiteMap

Method Inventory

GenOtherXML()
GenSiteMapIndex()
GetExternalItems()
WriteSiteMapAdditions()

Methods

classmethod GenOtherXML(verbose As %Integer = 1, overrideDir As %String = $$$WEBSITEOVERRIDE)

Generates SiteMap-other.xml from Sitemap-other-parts.txt

classmethod GenSiteMapIndex(verbose As %Boolean = 1, outputDir As %String = $$$WEBSITEOVERRIDE)

Method for generating the SiteMapIndex.xml file. The sitemap index file lists the SiteMap file locations for all WebsiteGroups with the property IncludeInSiteMapIndex=true, as well as the SiteMap-other.xml file.

classmethod GetExternalItems(verbose As %Boolean = 1) as %DynamicArray

Return an array of the external HTML files associated with the loaded content (apart from relnotes), along with the URLs for those files.

classmethod WriteSiteMapAdditions(verbose As %Integer = 0, overrideDir As %String = "")

This method generates the sitemap for the release currently loaded and includes the DocBook content, release notes and other external files (if applicable).

Before running this method, load the content for which we want to create a sitemap. The sitemap that this method will generate is determined by what content is currently loaded, through $$$RELEASEID.

Unless an overrideDir is specified, the file generated will be located in /csp/docbook The overrideDir argument is used by (Utils.Postload).PostProcess() to auto-generate sitemap additions in the instance's DocBookMgr directory when all content is loaded.