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.
parameter XMLIGNORENULL = 1;
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.
property ClassReferenceURL as %String (MAXLEN = 5000);
Publish.Utils::SetGlobals() puts this into ^Settings("origclassrefurl")
and ^Settings("classreflink"),
We use this when we make links to the class reference.
relationship DocBookDetails as array of Publish.DocBook [ InitialExpression = $listbuild("Publish.DocBook","Release",+$this,"children",1,1) , Transient , Inverse = Release , Cardinality = children ];
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.
property ISPOverrideTitle as %String (MAXLEN = 500);
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();
property IgnoreShortTitles as %Boolean [ InitialExpression = 0 ];
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.
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.
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.
property TOTARAREFERRER as %String (MAXLEN = 5000);
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.
property WebsiteGroup as Publish.WebsiteGroup (XMLIO = "OUT", XMLREFERENCE = "ID");
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.
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).
Indexes
index (MainIDX on ReleaseID) [IdKey, Type = key, Unique];
Index methods: MainIDXCheck(), MainIDXDelete(), MainIDXExists(), MainIDXOpen(), MainIDXSQLCheckUnique(), MainIDXSQLExists(), MainIDXSQLFindPKeyByConstraint(), MainIDXSQLFindRowIDByConstraint()