Glossary Element

Author-it XML

Platform_KC
On Premises

Description

The Glossary element represents an Author-it Glossary object, and contains all of its properties.

Glossary Icon
The Glossary object represents a glossary of terms in the printed and online documentation. It takes care of things like sorting terms, help definition pop-ups, and how the glossary is represented in both print and online documentation.

Any Topic objects placed one level below a Glossary object are considered to be glossary terms, and as such will be sorted alphabetically. You may have additional levels under the Glossary object. However, only the topics on the first level are treated as glossary terms.

When glossary terms are published to a printed document, they are automatically assigned Heading 5 style, regardless of what you have entered in the Document Heading Style property. Also, super header and section break information is ignored.

Attributes

Attribute Name

Optional

Data Type

Values

wordcount

Yes

Integer

>= 0

Parent Element

Objects

Children

Element

Optional

Object

No

PrintAddLetterHeadings

Yes

PrintMedia

Yes

PrintSortTerms

Yes

PrintTitle

Yes

HelpPopUpColor

Yes

HelpPopUpColorType

Yes

HelpTitle

Yes

WebLinkType

Yes

WebMedia

Yes

WebTitle

Yes

Sample XML

<Glossary>
+ <Object>
<PrintAddLetterHeadings>false</PrintAddLetterHeadings>
<PrintMedia>299</PrintMedia>
<PrintSortTerms>false</PrintSortTerms>
<PrintTitle>Glossary</PrintTitle>
<HelpPopUpColor>14876671</HelpPopUpColor>
<HelpPopUpColorType>1</HelpPopUpColorType>
<HelpPopUpType>1</HelpPopUpType>
<HelpTitle>Glossary</HelpTitle>
<WebLinkType>1</WebLinkType>
<WebMedia>299</WebMedia>
<WebTitle>Glossary</WebTitle>
</Glossary>