Publish.RelInfo

Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.

Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Used when we generate the tables for cachensemble.html and for cachensemblej.html.

Used when we generate the tables for cachensemble.html and for cachensemblej.html.

Publish.Utils::SetGlobals() puts this into ^Settings("origclassrefurl") and ^Settings("classreflink"), We use this when we make links to the class reference.

Not displayed anywhere. Safe to use for actual comments.

For releases for which we set up combined HealthShare class reference, the location of the relevant .DAT and mapping files

Publish.Utils::SetGlobals() puts this into ^Settings("DRAFTHEADER")

Publish.Utils::SetGlobals() puts the location of the source files into ^DocBook.Config("SOURCE",n). This specifies where we will find the .xml files and view definition files to load, the image files to copy, and the PDF files to copy.

To be used on home page of DocBook

Used when we generate the catalog pages for docs.intersystems.com.

Used when we generate the tables for cachensemble.html and for cachensemblej.html.

Used when we generate the tables for cachensemble.html and for cachensemblej.html.

Additional external directories to copy into $$$DEFAULTWEBAPPDIR

Used when we generate the catalog pages for docs.intersystems.com.

"sections" to indicate home page with sections. Otherwise leave null.

KEY/DocBookId of the supported platforms guide for this version of the doc.

Override title for the ISP links, to use when you want something other than "Supported Platforms" Used when we generate the tables for cachensemble.html and for cachensemblej.html. Also used by SetGlobals();

Used when we generate the website static HTML Also used by SetGlobals(); We will use this ONLY if ISPKEY is null.

Used when we generate the website static HTML

Used only on website index.html; we added this because HealthShare needed it for version 2023.1.1

Ignore short titles: If this property is set to 1, any short titles specified are ignored, and the default/"long" titles are used in all contexts. Added for DOCS-11092.

Specifies the locale of the documentation -- either en-us or ja-jp. We use this to specify which %Text classes the search should use.

Publish.Utils::SetGlobals() puts this into ^Settings("Locale"); use $$$LOCALE to refer to this global setting. Also used when we generate the tables for cachensemble.html and for cachensemblej.html.

Perforce filename for changes-ReleaseID.html

Perforce filename for changes-ReleaseID.html

A note to be displayed before the list of links for this release on, for example, catalog pages.

can be NOUPDATES, OLDHOMEPAGE, NEWHOMEPAGE

We use this to figure out whether we should suppress the class reference. Affects home page link or not to the class reference; also affects whether we create other links to the class reference.)

Publish.Utils::SetGlobals() puts this into ^Settings("Product"); use $$$PRODUCT to refer to this global setting. Also used when we generate the tables for cachensemble.html and for cachensemblej.html.

Controls whether this release gets included in the website landing pages.

Directory in which we found this relinfo file (and where we'll export it again, if need be)

Unique identifier for one version of the doc. (not displayed anywhere). This usually has the form Corexxxx.x--has to match the filename.

Publish.Utils::SetGlobals() puts this into ^Settings("ReleaseID"); use $$$RELEASEID to refer to this global setting.

We use this to figure out whether we should suppress the class reference. Affects home page link or not to the class reference; also affects whether we create other links to the class reference.)

Publish.Utils::SetGlobals() puts this into ^Settings("ReleaseNumber"); use $$$RELEASENUMBER to refer to this global setting. Also used when we generate the tables for cachensemble.html and for cachensemblej.html.

This can be null, EM, or CD. Affects landing pages.

Used to sort relinfo items by year. Fractional years are OK.

If this is 1, we won't display the Download All PDFs button. This is useful when there is only 1 PDF, as in the case of SAM.

Used only if LOCKEDDOWN=1. This is the url to set as the referrer when redirecting back to SSO if HTTP referrer header doesn't match. This needs to match the launch page in Totara that we use to get to the documentation.

Used only if LOCKEDDOWN=1. This is the domain to check against the HTTP referrer header.

Used when we generate the catalog pages for docs.intersystems.com.

Used when we generate the tables for cachensemble.html and for cacheensemblej.html. This determines which of the "All Versions" index pages must include this release. Also used elsewhere to access WebsiteGroup properties, like CanonicalBaseURL in Publish.SiteMap. Allowed values in file = "ce", "iris", "irisforhealth","healthconnect" or "none" or "" (later... maybe "hs"). To access original string value like above, use WebsiteGroup.GroupID. XMLIO="OUT" makes it so the WebsiteGroup object for this property opened in XMLNew method is not overwritten by the XML reader, which would import the GroupID as string instead of the object.

Let's assume the clone is DRAFT and not published.

Returns ReleaseID of latest relinfo for the group

Returns ReleaseID of latest relinfo for the group to which the input ReleaseID belongs

Return a $LIST of DocBook source directories specified for the given list ($LIST) of release IDs.

Returns true if the given relinfo is the latest of the website group to which it belongs

This method is used by the XML reader and should not be called directly. It sets up a new RelInfo object with the WebsiteGroup property set to the WebsiteGroup object corresponding to the ID stored in the XML file, and returns this new object to the XML reader, which sets the rest of the properties according to the file. The WebsiteGroup property must specify XMLIO="OUT" in order for this object property not to be overwritten by the XML reader (which causes errors).