Specifying Custom Table of Contents Icons in DITA Source Documents
For more information about custom table of contents icons, see Requirements for Specifying Custom Table of Contents Icons in DITA Source Documents.
To specify a Custom Table of Contents Icon for a topic in a DITA source document:
1. In your DITA source document, locate your topic’s meta information container element.
2. For this element, you use the <othermeta> element to define the Page Style, for example: <othermeta name="TOCIcon" content="blue.png"/>.
Note: You can also use the <data> element, for example: <data name="TOCIcon" value="blue.png"/>.
3. Save the DITA document
4. Generate output for your target. For more information, see Generating Output
Steps for customizing table of contents icons for topics in DITA may be different in other versions of DITA.
To specify a custom table of contents icon in a DITA source document
5. If you want to specify a custom table of contents icon for Microsoft HTML Help, identify the number of the image you want to use for the table of contents image for the topic in the .hhp file for your Microsoft HTML Help project by completing the following steps:
a. On the View menu, click Output Directory.
b. Open the ProjectName folder, where ProjectName is the name of your project.
c. Open the ProjectName.hhp file where ProjectName is the name of your project.
d. On the Contents tab, select a table of contents entry, and then click the Pencil icon.
e. On the Advanced tab, in the Image index field, use the up and down arrows to identify the table of contents image you want to use for the topic.
f. Note the number of the image you want to use for the table of contents image for the topic.
For example, if you want to use a question mark icon with a red star for the table of contents icon for new topics, note that the number for this icon is 10.
g. Close HTML Help Workshop.
6. If you want to specify a custom table of contents icon for Oracle Help or Sun JavaHelp, create the graphic file for the custom table of contents icon in .gif format. The default graphics used as Sun JavaHelp or Oracle Help table of contents icons are 17 x 17 pixels. The custom graphics you create for Sun JavaHelp or Oracle Help table of contents icons should also be 17 x 17 pixels. You can assign any name to the graphic files.
7. If you want to specify a custom table of content icon for WebWorks help, create graphics files containing the collapsed and expanded versions of the icons you want to use, then save the graphic files in .gif format. The default graphics used as WebWorks Help table of contents icons are 17 x 17 pixels. The custom graphics you create for WebWorks Help table of contents icons should also be 17 x 17 pixels. You can assign any name to the graphic files.
8. Copy the graphic files you want to use as icons in the table of contents into the following folder:
Note: If the folder does not exist, first create the folder using the specified folder structure and then copy the graphic files you want to use as icons into the folder. You do not need to perform this step when specifying custom table of contents icons for Microsoft HTML Help.
If you are generating Oracle Help, copy the graphic files you want to use into the following folder:ProjectName\Formats\Oracle Help\Files\images folder, where ProjectName is the name of your project.
If you are generating Sun JavaHelp 1.1.3, copy the graphic files you want to use into the following folder:ProjectName\Formats\Sun Java Help 1.1.3\Files\images folder, where ProjectName is the name of your project.
If you are generating Sun JavaHelp 2.0, copy the graphic files you want to use into the following folder:ProjectName\Formats\Sun Java Help 2.0\Files\images folder, where ProjectName is the name of your project.
If you are generating WebWorks Help, in your ProjectName\Files folder, where ProjectName is the name of your project, create a wwhelp\images subfolder and copy the graphic files you want to use into this folder. Your project file structure should be similar to the following structure:ProjectName\Files\wwhelp\images
Last modified date: 02/10/2023