Creating TOC Entries

You can add a topic or a book to a table of contents. A topic is a direct link to a topic, bookmark, file, project, or external file. A book is a "container" in a table of contents or browse sequence used to organize and hold links to topics or external files.

How to Create a TOC Entry

  1. Open the TOC.
  2. Select the location in the TOC where you want to add the new entry.
  3. Do one of the following:

    To Create a New Topic and Simultaneously Link It to a New Entry

    1. In the local toolbar of the TOC Editor, click Create a new topic and link to it.. The Add File dialog opens.
    2. Complete the options in the Add File dialog.

      1. In the Source area, choose to create the new file based on a template or an existing file.

        • New From Template Choose either a factory template file or one of your own custom template files as a starting point. The new file will take on all of the settings contained in the template. If you want to use the factory template provided by Flare, expand the Factory Templates folder and click on a template file. If you want to use your own custom template file, expand the appropriate folder and click on a file. See Templates.
        • New From Existing Choose an existing file of the same type as a starting point for your new file. As with template files, your new file will take on all of the settings contained in the file you select. To use this option, click The browse ellipsis button opens to more options., use the Open File dialog to find a file, and double-click it.
      2. (Optional) The Folder field is automatically populated with the folder that has focus in the Content Explorer. If you want to place the file into a folder that you previously created in the Content Explorer, in the Folder field click The browse ellipsis button opens to more options. and select the subfolder. Otherwise, keep the default location. See Creating Subfolders.
      3. In the File Name field, type a new name for the topic.

        Note Spaces are allowed in the file name. However, if you are publishing output to a UNIX system, avoiding spaces in the file name is recommended. You can use underscores in place of spaces.

      4. If you want the heading for the topic to use the same text that you provide for the file name, leave the 1st Heading field blank. Otherwise, enter the text that you want to use for the heading in the topic.
      5. In the Title field, you can give the topic a title for the file. This does not refer to the visual title (or heading) at the top of the topic. Rather, it refers to the properties title for the topic. See Changing Topic Titles.

        If you leave this field blank, the text from the "1st Heading" field will automatically be used for the title.

      6. If you want the heading for the topic to use the default h1 style, leave the Style field blank. Otherwise, select a style to apply to the heading in the topic.
      7. In the Stylesheet field, select a stylesheet to associate with the new topic. If you do not have a stylesheet in your project, this field remains blank.
      8. (Optional) If you want to apply condition tags to the file, expand the Attributes section at the bottom of the dialog. Next to the Condition Tags field, click The browse ellipsis button opens to more options. and select the conditions you want to apply. Click OK. See Applying Conditions to Content.
      9. (Optional) If you want to apply file tags, expand the Attributes section at the bottom of the dialog. Next to the File Tags field, click The browse ellipsis button opens to more options. and select the file tags you want to apply. Click OK. See Associating Tags With Files.
    3. Click Add. The topic is added to the Content Explorer and opens in its own page in the XML Editor, and it is linked to a new entry (with the same name) in the TOC.

    4. (Optional) You may want to adjust the placement of the TOC entry in the TOC Editor.

      Click the tab for the TOC to return to the TOC Editor. If you want to adjust the position of the topic TOC entry, select it and use the arrow buttons in the local toolbar (, , , ). You can also drag and drop the topic entry to the location you want in the TOC.

    To Create a New Entry

    1. In the local toolbar of the TOC Editor, click . An entry called "New entry" is added to the TOC.
    2. Click once on the selected new entry and press F2 on your keyboard. The text for the entry is now highlighted.
    3. Type a new name for the entry (just as you want it to appear in the TOC output) and press ENTER. The new entry is now ready to be linked to a topic, an external file, another TOC, a browse sequence, or another Help system. See Linking TOC Entries.

      Note If the text is not highlighted, you may need to click once on the selected new entry and press F2 on your keyboard.

      Note Use the arrow buttons to move the entry to the left, right, up, or down as needed.

    To Create a New Book

    1. In the local toolbar of the editor, click or (if you want the book to be placed at the far left side). A node called "New book" is added. Also, a new entry is added under the book because a book must contain at least one entry in order to be seen in the output.
    2. Type a new name for the book (just as you want it to appear in the output) and press ENTER. You can leave the book as it is, or you can link it to a topic, an external file, a TOC, a browse sequence, or another Help system. You can also rename the entry contained under the book and link it to something.

      Note If the text is not highlighted, you may need to click once on the selected new entry and press F2 on your keyboard.