Add Topics to the Table of Contents

As part of adding a new topic, add it to the correct table of contents.

It's easier to add topics to the TOC if you change a default Flare setting, which sets links to cross-references by default. You can update this setting so that hyperlinks instead of cross-references are inserted by default.

  1. Click the File menu, and select the Options button in the lower right of the menu.

  2. Click the XML Editor tab.

  3. Under Defaults, select Hyperlink from the Link list box.

  4. Click Save.

To add a topic to a TOC in Flare

  1. Open the appropriate TOC.

  2. Drag and drop the topic from the Content Explorer pane to the appropriate location in the TOC.

  3. Right-click the topic in the TOC and select Properties from the drop-down menu.

  4. On the Conditional Text tab select the appropriate conditions for the topic in the TOC. Refer to Use Condition Tags for more information about how condition tags are used to generate output.

SST TOCs

A typical TOC has three sections:

  • Setup and Configuration

  • Page Descriptions

  • the rest of it (what we call use cases)

 

To add a new Page Description topic to a TOC:

  1. In the Content Explorer, open the topic componentname/Page_Desc/Componentname_Page_Descriptions

  2. Add a hyperlink to the new topic in the alphabetized, bulleted list.

To add a new Setup and Config type topic to the TOCs:

  1. Open the component Overview topic and scroll down to the Setup and Configuration section.

  2. Add a link to the new topic to the bulleted list.

  3. Add a link to the Set Up and Configuration section in the component TOC that displays in the right panel.

Add use case topic links below the Page Descriptions topic link. .

SKT TOCs

There are three types of topics in the SKT help.

  • Configuration and technical documentation

  • Release notes

  • Other topics, usually use cases

Each has a different TOC.

Add a new menu item for a new Configuration or Technical topic to two TOCs:

  1. In the Project Organizer, select TOCs > To TopNav.

  2. Expand the Config Docs menu item.

  3. Add the new menu beneath the Config Docs menu item.

    NOTE: This adds the new topic to the menu in the TopNav.

  4. In the Project Organizer, select TOCs > Config Docs.

  5. Expand the Config Docs menu item

  6. Add the new menu beneath the Config Docs menu item.

    NOTE:This adds the new topic to the right side menu that displays on all topics of this type (controlled through the master page).

A new Release Notes topic must be added for each month. Refer to Add Month to the Drop-down List on the What's New Page for updating this TOC.

When you add any other type of topic, add a new menu item to the SKT TOC.

Install Manual TOCs

TOCs in the Installation manual project are based on the manual type. Add a new menu item for new topics to the correct TOC.

If you are adding a supplemental section, add the new menu item beneath the Supplemental Sections heading for both the InstallHTML5 and UpgradeHTML5 TOCs. Add a new men item to the Appendices TOC as well.