Topic Element

Description

A Topic object represents a concise chunk of text, usually no more than a few paragraphs. In a traditional document this would be the text under a specific heading or sub-heading in the document hierarchy.

Topic objects will make up the vast majority of all objects in a Book, and as such contain many properties defining how the Topic will be represented in both the printed and on-line documentation. Topics can mark the beginning of a new chapter and automatically create a mini table of contents. The heading of the Topic can be automatically formatted depending on its level in the hierarchy of the Book.

A Topic object contains its own GUI text editing environment, which allows enforcement of standards and conventions and embeds enhanced hypertext-linking information.

The Topic element represents an AuthorIT Topic object, and contains all of its properties.

Attributes

Attribute Name	Optional	Data Type	Values
wordcount	Yes	Integer	>= 0

Parent Element

Objects

Children

Element	Optional
Object	No
Headings	Yes
RelatedGroups	Yes
Text	Yes
VariableAssignments	Yes
PrintAutoNumber	Yes
PrintBreakType	Yes
PrintHeadingStyle	Yes
PrintMedia	Yes
PrintSuperHeading	Yes
HelpAlias	Yes
HelpContextID	Yes
HelpContextString	Yes
HelpCustomFootnotes	Yes
HelpHeadingStyle	Yes
HelpIncludeInSequence	Yes
HelpJumpMacro	Yes
HelpJumpType	Yes
HelpJumpWindow	Yes
HelpNewSequence	Yes
HelpNonScrolling	Yes
HelpTopicMacro	Yes
WebFilename	Yes
WebMedia	Yes
WebStartNewPage	Yes
WebTitle	Yes
WebTOCImage	Yes

Sample XML

<Topic>
+ <Object>
- <Headings>
    <All>Run Modes</All>
  </Headings>
- <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>
  + <RelatedGroup inherited="true">
  + <RelatedGroup inherited="true">
  + <RelatedGroup inherited="true">
  + <RelatedGroup inherited="true">
  + <RelatedGroup inherited="true">
  + <RelatedGroup inherited="true">
  </RelatedGroups>
- <Text>
  - <table rows="4" cols="3" width="8370">
    - <tr rowheight="0">
      - <td width="1710" borders="15" bordercolors="65793">
        - <p id="3">
            <cs id="5">Mode</cs>
          </p>
        </td>
      - <td width="3900" borders="15" bordercolors="65793">
        - <p id="3">
            <cs id="5">Messages</cs>
          </p>
        </td>
      - <td width="2760" borders="15" bordercolors="65793">
        - <p id="3">
            <cs id="5">Logging</cs>
          </p>
        </td>
      </tr>
    - <tr rowheight="0">
      - <td width="1710" borders="15" bordercolors="65793">
          <p id="3">silent - default mode</p>
        </td>
      - <td width="3900" borders="15" bordercolors="65793">
          <p id="3">only fatal error messages displayed no recoverable messages displayed</p>
        </td>
      - <td width="2760" borders="15" bordercolors="65793">
          <p id="3">only errors logged</p>
        </td>
      </tr>
    </table>
    <p id="3">Verbose mode is turned on/off via the debug logging item on the Help drop down menu. This is in the same place in all modules.</p>
  </Text>
  <VariableAssignments />
  <PrintAutoNumber inherited="true">0</PrintAutoNumber>
  <PrintBreakType inherited="true">0</PrintBreakType>
  <PrintHeadingStyle inherited="true">0</PrintHeadingStyle>
  <PrintMedia inherited="true">0</PrintMedia>
  <PrintSuperHeading inherited="true" />
  <HelpAlias />
  <HelpContextID inherited="true">0</HelpContextID>
  <HelpContextString />
  <HelpCustomFootnotes />
  <HelpHeadingStyle inherited="true">18</HelpHeadingStyle>
  <HelpIncludeInSequence inherited="true">true</HelpIncludeInSequence>
  <HelpJumpMacro inherited="true">0</HelpJumpMacro>
  <HelpJumpType inherited="true">2</HelpJumpType>
  <HelpJumpWindow inherited="true">35</HelpJumpWindow>
  <HelpNewSequence inherited="true">false</HelpNewSequence>
  <HelpNonScrolling inherited="true">true</HelpNonScrolling>
  <HelpTopicMacro>0</HelpTopicMacro>
  <WebFilename />
  <WebMedia inherited="true">36</WebMedia>
  <WebStartNewPage inherited="true">true</WebStartNewPage>
  <WebTitle />
  <WebTOCImage inherited="true">(auto)</WebTOCImage>
</Topic>