RelatedGroups Element

Author-it XML

Platform_KC
On Premises

Description

This is a list of all the related topic groups in this topic. If the word "(inherited)" appears at the end of the group name then that group is inherited from the template that this topic is based on. This list contains two columns:

  • Group Heading: displays the name of the group. This name cannot be changed. You must delete the group and create a new group to change the name.
  • Sequence: determines the order that one group has to others.

Click on a group to display its properties.

The RelatedGroups element corresponds to the Related Topics tab, of the Topic object. This element contains a number of RelatedGroup elements.

Attributes

None

Parent Element

Topic

Children

Element

Optional

Occurs

RelatedGroup

Yes

Zero to many times

Sample XML

<RelatedGroups>
- <RelatedGroup inherited="true">
<Alignment>2</Alignment>
<Children>false</Children>
<ColumnWidth>56 px</ColumnWidth>
<Contents>true</Contents>
<ExcludeHeadingText>true</ExcludeHeadingText>
<Heading>Contents</Heading>
<HeadingFile>1350</HeadingFile>
<HeadingStyle>3</HeadingStyle>
<IncludeInHelp>false</IncludeInHelp>
<IncludeInPrint>false</IncludeInPrint>
<IncludeInWeb>true</IncludeInWeb>
<Index>false</Index>
<ItemStyle>0</ItemStyle>
<NextTopic>false</NextTopic>
<ParentTopic>false</ParentTopic>
<PopUp>false</PopUp>
1</Position>
<PreviousTopic>false</PreviousTopic>
<RelatedGroupID>Contents</RelatedGroupID>
<Sequence>6</Sequence>
<Siblings>false</Siblings>
</RelatedGroup>
</RelatedGroups>