HTML Help - HTML Help table of contents editor

The table of contents is the main part of the HTML Help navigation panel. With its help we navigate through the sometimes very complicated system of pages. The editor allows you to make the table of contents in such a way that, on the one hand, it corresponds to the logic of the project, on the other hand, it is visually interesting.
The table of contents is presented in the form of a tree of topics. Thus, it can be formulated as main topics and sub-topics, which in turn can contain their own branches. We can equip each item with its own icon, choosing from a long list the ones that best suit the topic. We can also choose the most appropriate font typeface, and background colors.

Launching

You can launch the described tool using the button marked with the icon shown above. The button to launch this window can be found, for example, in the HTML Help menu and on the HTML Help toolbar, as well as in the HTML Help project editor window.

Main table of contents window

In the main window of the editor, on its right side, there is a set of buttons, allowing you to organize topics by: placing them in the appropriate hierarchy in the topic tree (positioning buttons: up, down, level higher, level lower), deciding on the type of topic (main, subordinate), deleting items, sorting topics in alphabetical order, and creating new topics based on existing ones.
On the right side of the main window, there is also a field in which to enter the project directory.

Element settings

In this tab we decide the parameters of each individual element of the table of contents. The changes made will apply only to that element. Note: It is imperative that after any change in the settings you accept them by clicking on the "Update element data" button.

Name
Enter the name that will appear in the table of contents in this field.

Update name with title or file name
If you check this option, you don't have to type anything in the field above, because the name will be taken from the header of the HTML document appearing in the tag, and if this tag is empty, the file name of the document will be inserted.

Link to
This field provides a space for the reference to which this entry in the table of contents should lead. To select a file, you can use the buttons next to it, which allows you to select a file from the disk, or browse to an internal file located in another HTML Help project.

Local labels
When the "Search" switch next to it is checked, the editor will search for local labels found in the document (e.g., those marked as ). The found labels will be added to the list of labels, from which it will be possible to select them and thus create a link to a specific label.

Alternative link
There is space in this field to enter an alternative link to which this table of contents item should lead, which will be activated when the main link does not work for some reason. To select a file, you can use the buttons next to it, which will allow you to select a file from disk, or point to an internal file located in another HTML Help project.

Local labels
When the "Search" switch next to it is checked, the editor will search for local labels found in the document (e.g., those marked as ). The found labels will be added to the list of labels, from which it will be possible to select them and thus create a link to a specific label. These labels refer to alternative links.

Window
This field is for entering the name of the HTML Help window into which the document indicated by this table of contents item is to be loaded. HTML Help windows are defined in the project editor.

Frame
The purpose of this field is to enter the name of the window, or to select one of the predefined names from the drop-down list. This is to open this item in a window other than the default one.

Item icon
From the drop-down list, you can select 42 custom icons that each table of contents item can have. If there is no selection, standard icons will be added, i.e. booklets for the main topic and cards for the other items.

Change category
By checking this switch and clicking the item update button below, you can cause the current inventory item to be converted to a category (if it is a regular item), or to an item (if it is a category without sub-elements)

Update element data
Using this button is necessary if you want to accept changes to the settings for an item. If you do not confirm the changes and move to another item, the settings will be lost.

Table of Contents properties

This tab is for defining the general settings of the table of contents. Selected or typed options will apply to all items. The changes made are saved along with the entire table of contents.

Default window
In this field we enter the name of the HTML Help window that will be used to display the content when you click on any element that does not have its own window definition.

Default frame
The purpose of this field is to enter the name of the window, or select one of the predefined names from the drop-down list. This is to open this item in a window other than the default window.

Font
This field provides a place to enter the font that will be used for the table of contents. Clicking on the icon next to the field opens a system window for selecting the font including its type and size.

Character set
From the drop-down list of the field, select the font script to be used by HTML Help. If you are using any of the system fonts, the default setting that is displayed in this field by default, which is "001 DEFAULT", will suffice.

Use folder icons instead of books
When this option is checked, folder icons will be used instead of the standard book icons in the main topics.

Color of the elements
This field is used to select the color of the table of contents text. The drop-down list contains a defined list of primary colors, and a color palette switch. The default color is black. To the right of the field is a button to restore the default color.

Background color
This field is used to select the background color of the table of contents. The drop-down list contains a defined list of primary colors, and a color palette switch. The default color is white. To the right of the field is a button to restore the default color.

Appearance
This field lists the minor appearance options for the HTML Help table of contents. You should select the ones you need to change the appearance. Below the box is a button to restore the default settings of this window. Here is the list of options:

  • Border
    When this option is selected, the table of contents pane gets a border.

  • Plus and minus buttons
    When this option is selected, plus signs for undeveloped branches will appear at node points in the topic tree, while minus signs will appear for developed branches.

  • Leave selection
    If you select this option, the selection of this item will remain even though you have moved to the window presenting this item, which allows for better control.

  • Line to the root
    After selecting this option, expanding a branch will show a vertical line connecting the branch's elements with its main position.

  • Sunken frames
    When this option is selected, the table of contents border will have a concave appearance.

  • Auto-tracking selection
    When this option is checked, selections will be automatically tracked.

  • Dialogue framing
    If you check this option, you will get an additional border.

  • Lines connecting the elements
    When this option is selected, individual elements will gain additional vertical lines connecting them.

  • Expand one category
    If you select this option, only the category expands.

  • Raised frames
    If you select this option, the table of contents will have a convex border.

  • Reading order from right to left
    This option is a convenience for nationalities whose writing is of the Hebrew type and reads from right to left.

  • Scrollbar on the left
    When this option is selected, the vertical scrollbar will appear on the left side. This is a convenience for those using Hebrew type.

  • Select whole line
    When this option is selected, the selection will expand to the full width of the table of contents if there are subtitles on several lines.

Preview of the selected object

This tab is used entirely for previewing the selected object. The HTML page assigned to the item can be viewed as in a regular web browser window.


Related topics

To top