Learn how to work with Table of Contents in RoboHelp.

A Table of Contents provides a hierarchy of the books (folders) and pages (topics) that you have in the output of your project. The Table of Contents gives the reader an ability to view the Help system as a whole and its individual topics. With a Table of Contents, the reader can quickly select and view a topic of their choice.

You can have multiple Tables of Contents in a single project, depending on the type of output that you want for your readers. For example, you can have a Table of Contents to cater to a specific audience (say, Developers) and another Table of Contents for a different audience (say, End users). You can simultaneously maintain the two Table of Contents files in the Table of Contents panel.

At the time of publishing your project, the entire project is not included in the output generated. Only the topics (and the referenced files inside these topics) in the Table of Contents file selected are included.

Create a Table of Contents

To create a Table of Contents:

  1. In the Author toolbar, select Table of Contents. The Table of Contents panel opens.

  2. In the Table of Contents panel, click  to create a Table of Contents.

  3. In the New Table of Contents dialog box, in the Name field, specify the name of the Table of Contents file.

  4. Click Done.

    The Table of Contents is created in the Table of Contents panel. You can add multiple Table of Contents files in a project. You can expand a Table of Contents file by clicking  against it. 

Edit a Table of Contents

You can edit a Table of Contents file in two modes–quick edit mode and comprehensive edit mode.

Quick edit mode is accessible as a context menu in the Table of Contents panel after you expand a Table of Contents file. This mode does not launch the Table of Contents editor or display the Table of Contents toolbar.

Comprehensive edit mode launches the Table of Contents editor and displays the Table of Contents toolbar at the center of the standard toolbar. To edit a Table of Contents file in the comprehensive edit mode:

  1. In the Author toolbar, select Table of Contents. The Table of Contents panel opens.

  2. Launch the Table of Contents editor by doing one of the following in the Table of Contents panel:

    • Double-click a Table of Contents file.
    • Right-click a Table of Contents file and then click Edit.
    • Against a Table of Contents file, choose Options () > Edit.

    The Table of Contents editor opens as a tab and RoboHelp displays the Table of Contents toolbar at the center of the standard toolbar.

    In edit mode, you can do the following:

Auto-create a Table of Contents

Quickly create a Table of Contents using Auto-create TOC. This feature uses the hierarchy of the folders and topics in your project to create a Table of Contents file.

To auto-create a Table of Contents:

  1. Do one of the following:

    • In the Table of Contents toolbar, click .
    • Right-click in the Table of Contents editor and click Auto-create TOC
  2. In the Confirm dialog box, you can select one or both of the following:

    • Delete current TOC before creating new Deletes existing Table of Contents, if any, before auto-creating.
    • Create TOC pages for bookmarks If your topics include bookmarks, selecting this field creates an additional page for each bookmark.

    Click Ok

    Примечание.

    If a Table of Contents already exists, and you do not select any option in the Confirm dialog box, the new Table of Contents is appended at the end of the existing Table of Contents.

Insert a topic

Quickly insert a topic in the TOC by dragging it from the Contents panel and dropping it in the Table of Contents.

Or, follow these steps:

  1. Do one of the following:

    • In the Table of Contents toolbar, click .
    • Right-click in the Table of Contents editor and choose New > Page
  2. In the Insert Page dialog box, do the following:

    • Project Files Select this option to insert a topic from your project. 
    • Title Use to modify the display title of the topic in the Table of Contents without changing the actual topic title.
    • Search Use to search for a topic. You can also use the Recently Used panel or the Contents panel to select a topic of your choice.
    • Click Insert.

    If you insert a topic in an existing Table of Contents, it is inserted after the currently selected topic. If a folder is selected at the time of insertion, the topic is inserted at the end of the list of topics inside the selected folder.

Insert a folder

Quickly insert a folder in the TOC by dragging it from the Contents panel and dropping it in the Table of Contents. RoboHelp retains the original hierarchy of the folder in the Table of Contents panel.

Or, follow these steps:

  1. Do one of the following:

    • In the Table of Contents toolbar, click .
    • Right-click in the Table of Contents editor and choose New > Book
  2. In the Insert Book dialog box, do the following:

    • Project Files Select this option to insert a folder from your project. 
    • Title Use to modify the display title of the folder in the Table of Contents without changing the actual folder title.
    • Search Use to search for a folder. You can also use the Recently Used panel or the Contents panel to select a folder of your choice.
    • Click Insert.

    If you insert a folder in an existing Table of Contents, it is inserted after the currently selected topic. If another folder is selected at the time of insertion, the new folder is inserted at the end of the list of topics in the selected folder.

Insert a Table of Contents placeholder

You can achieve collaborative authoring in RoboHelp where multiple writers can work on their individual books. Using Table of Contents placeholders, you can create a merged output from individual books. To do so, you can insert a Table of Contents placeholder in your current Table of Contents. RoboHelp retains the original hierarchy of topics and folders in a placeholder, which is expanded as a complete Table of Contents in the output generated.

Quickly insert a Table of Contents placeholder by dragging it from the Table of Contents panel and dropping it in the current Table of Contents. 

Or, follow these steps:

  1. Do one of the following:

    • In the Table of Contents toolbar, click .
    • Right-click in the Table of Contents editor and choose New > TOC Placeholder
  2. In the Insert TOC dialog box, from the list of Table of Contents, select one and click Insert

    The Table of Contents is inserted as a placeholder. If you insert a placeholder in an existing Table of Contents, it is inserted after the currently selected topic. If a folder is selected at the time of insertion, the placeholder is inserted at the end of the list of topics in the selected folder.

Reorder items in a Table of Contents

To quickly reorder the items (topics, folders, and Table of Contents placeholders) inside a Table of Contents file, do one of the following:

  • Use drag-and-drop
  • Click the following icons in the Table of Contents toolbar or from the Move context menu in the Table of Contents editor:
    •  Changes the hierarchy of the topic/folder by moving it one level above the original level
    •  Changes the hierarchy of the topic/folder by moving it one level below the original level
    •  Changes the order of the topic/folder by moving it above the previous topic/folder
    •  Changes the order of the topic/folder by moving it below the next topic/folder

Delete items in a Table of Contents

To delete an item (a topic, a folder, or a Table of Contents placeholder) inside a Table of Contents file, do one of the following:

  • Select the item and press Delete
  • Right-click the item and click Delete
  • Against the item, choose Options () > Delete.

Work with a Table of Contents' properties

The Table of Contents editor displays the Properties panel at the right side of the screen. The Type field displays the type of the currently selected item–Book (a folder), Page (a topic), or TOC (a Table of Contents placeholder). For each item, you can set the following:

  • Title Use this field to specify the display title of a folder, topic, or a Table of Contents placeholder, which can be different from the original title. 

Примечание.

The display title is visible only in the Table of Contents file. The original title of the topic remains unchanged. If you do not specify a display title, the topic title in the Table of Contents file gets synced with the original topic title.

  • Source [Applicable only to topics] Displays the URL of the selected topic file along with its original title (not the display title if modified). You can replace the selected topic with a different topic from your project by clicking , choosing the topic, and clicking Update

Примечание.

If the linked topic does not exist, RoboHelp displays a red x mark against the topic in the TOC.

  • Hide in output Select to hide the topic from the Table of Contents in the output.

Примечание.

This feature is useful if you want to publish supplementary files, for example, PDF and DOC, but do not want to show it in the Table of Contents in the output. To do so, add supplementary files to the TOC and against each file, select Hide in output

  • Apply Tags Click to apply condition tags to the Table of Contents file. From the Apply Condition Tags dialog box, select the condition tags you want to apply. The selected tags appear at the right side of the dialog box. Click Apply. The applied tags are displayed in the Properties panel below the Condition Tags drop-down section. In the Properties panel or in the Apply Condition Tags dialog box, you can click  against a tag to remove it.

Use a desired Table of Contents in your output

To use a Table of Contents in the output:

  1. Click the Output tab at the left side of the Standard toolbar.

    The Output view opens.

  2. In the Output toolbar, click Output Presets

  3. In the Output Presets panel, select your desired output preset from the given options. You can choose output presets from among Responsive HTML5, Mobile App, WebHelp, eBook, and more.

  4. Select the Content tab.

  5. The Table of Contents field displays all your created Table of Contents files in the project. Use the drop-down list to select your desired Table of Contents file. 

    The selected Table of Contents is then included in your output. See Generate output for details on how to generate the output.

Rename a Table of Contents

To rename a Table of Contents:

  1. In an open project, select Table of Contents in the Author toolbar. The Table of Contents panel opens.

  2. In the Table of Contents panel, against the Table of Contents that you want to rename, choose Options () > Rename.

  3. In the Rename Table of Contents dialog box, modify the current name. Click Done.

Delete a Table of Contents

To delete a Table of Contents:

  1. In an open project, select Table of Contents in the Author toolbar. The Table of Contents panel opens.

  2. In the Table of Contents panel, against the Table of Contents that you want to delete, choose Options () > Delete.

  3. In the Confirm dialog box, click Yes to confirm the deletion.

Эта работа лицензируется в соответствии с лицензией Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported  На посты, размещаемые в Twitter™ и Facebook, условия Creative Commons не распространяются.

Правовые уведомления   |   Политика конфиденциальности в сети Интернет