Document! X and HelpStudio 2019
Project Fundamentals / Designing the Table of Contents
In This Topic
    Designing the Table of Contents
    In This Topic

    The Table of Contents is a tree based navigation mechanism that allows users to explore your Help System. You can add Topics and internet urls as Table of Contents nodes. You can also add a Document! X and HelpStudio placeholder node to the Table of Contents under which any reference documentation items will be generated when you build the Help System.

    Movies

    Table of Contents Fundamentals

    Open the Table of Contents editor in a Document Window

    If you are doing extensive work in the Table of Contents, you may find it beneficial to open the Table of Contents in a Document Window. Opening the editor in a Document Window makes it easier to drag and drop items from the Project Explorer to add them to the Table of Contents and shows a full properties editor for the selected item side by side with the Table of Contents Explorer.

     

    Adding Items to the Table of Contents

    You can add items to the Table of Contents in several different ways:

    1. Add new child or sibling nodes using the  New Child Node or  New Sibling Node button on the Table of Contents Explorer toolbar;
    2. Add a new Topic and a Table of Contents node that points to it with one click using the  New Child Topic Node or  New Sibling topic Node button on the Table of Contents Explorer toolbar;
    3. Create a copy of an existing Table of Contents node or nodes using the  Clone command on the Table of Contents Explorer toolbar;
    4. Add an existing Topic or Topics to the Table of Contents by dragging and dropping from the Project Explorer.

     

    Setting node properties (icon, caption etc.)

    1. Select the node or nodes on the Table of Contents editor that you want to set properties for;
    2. In the Properties window, edit the required properties;
    3. The changes applied in the Properties window will be immediately applied to the selected node(s).
    You can open an individual editor for a particular Table of Contents node by selecting it in the Table of Contents editor and clicking the  Table of Contents Editor toolbar button. An editor window will then be opened for that node.

     

    Arranging Items on the Table of Contents

    1. Arrange one or more nodes by selecting them and using the Move buttons on the Table of Contents Editor toolbar;
    2. Arrange nodes by dragging and dropping them to the desired location on the Table of Contents.

     

    Removing a Table of Contents Node

    1. Select the node or nodes on the Table of Contents editor that you want to remove;
    2. Click the  Table of Contents Explorer toolbar button;
    3. The selected nodes will be removed from the Table of Contents.

     

    Selecting Multiple Items

    Multiple items can be selected on the Project Explorer and Table of Contents Editor in Document! X and HelpStudio. Once selected, you can set properties for the multiple items in the Properties window, drag and drop them and use the toolbar or context menu to perform actions on the selected items.

    To select a range of items

    1. Click on the first node.
    2. Hold down the Shift key.
    3. Click on the last items you wish to select.
    4. All items from the first to the last, including those in between, will be selected.

     

    To select multiple items one by one

    1. Click on the first item.
    2. Hold down the Ctrl key.
    3. Click on another item. Both items will now be selected.
    4. Repeat for any further items you wish to select.