Topic files without TOC entries

Navigation:  Basic Working Procedures > Managing the TOC & Topic Files >

Topic files without TOC entries

Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

Most topics have entries in the Table of Contents (TOC). However, sometimes you also need topics that are not included in the TOC. For example, topic files without TOC entries are required for popup topics, and they are recommended for topics that are displayed in external windows in HTML Help. You can also use them for topics that are only displayed when the user clicks on a link.

To create a topic file without a TOC entry you just create the file in the Topic Files section of the Project Explorer instead of in the Table of Contents section.

Click to expand/collapseHow to create a topic file without a TOC entry

1.In the Project Explorer open the Project Files > Topic Files section.

2.Select Add File > Add New File in Project > Manage Topics.

3.Enter the name of the topic you want to create. You can create multiple files by entering multiple names, one on each line.

4.Click on More Options and select a folder in Create in: to create the topic file in a sub-folder that you have created in the Topic Files section.

5.Select any other relevant settings for the topic.

Click to expand/collapseOrganizing topic files in folders

You can create sub-folders in the Topic Files section to organize your files. It is a good idea to use separate folders for the various different types of topics files that are not included in the TOC to keep them separate from your TOC topic files.

1.Open the Topic Files section in the Project Explorer and select the folder that you want to add a new sub-folder to.

2.Select Add File > Add New Folder in Project > Manage Topics and enter a name for the new folder.

When you create new topics you can then click on More Options and select Create in: to create the topic file for the new topic in a specific folder.

Click to expand/collapseUsing status options and include options topic files

You can apply both topic status and include options to topic files in the Project Files section of the Project Explorer. Just right-click on the file in the Explorer and select the options in the context menu, or select the options in the Change menu in Project > Manage Topics.

Click to expand/collapseHow to add a TOC entry to a topic file

Sometimes you may decide that you would like to add a TOC entry to a topic file that does not yet have one. To do this you just need to create a new entry in the TOC and specify the Topic ID of the topic file.

1.Select the topic file you want to create a TOC item for and open the tab behind the editor.

2.Copy the Topic ID to the Windows clipboard.

3.Move to the Table of Contents section in the Project Explorer, click where you want to insert the new TOC item and select Add Topic in Project > Manage Topics.

4.Select Topic/Chapter on the left and enter a heading for the topic.

5.Paste the topic ID you copied in step 2 In the Topic ID: field and then click on OK.

You will be asked if you want to create a new item for an existing topic. Confirm to create the new TOC item.

See also:

Creating new topics

Promoting and demoting topics

Conditions and Customized Output.