Customizing Table of Contents Icons in FrameMaker

Authoring Source Documents » Adobe FrameMaker » Customizing Table of Contents Icons in FrameMaker

By default, the Contents tab in a Microsoft HTML Help, Oracle Help, and WebWorks Help uses book and page icons to identify entries. By default, the Contents tab in Sun JavaHelp uses folder and page icons to identify entries. You can also customize the table of contents icons.

For example, if you want to make new topics stand out by using a unique icon specific to new books, pages, or folders, you can insert a marker into a topic and specify the icon you want to display for the book, page, or folder in your help system table of contents.

To customize a table of contents icon, your Stationery and template must have the following items configured:

TOCIconHTMLHelp for Microsoft HTML Help

TOCIconOracleHelp for Oracle Help

TOCIconJavaHelp for Sun JavaHelp

TOCIconWWHelp for WebWorks Help

You can customize the appearance of table of contents icons for topics in Microsoft HTML Help, Sun JavaHelp, Oracle Help, and WebWorks help.

The following procedure provides an example of how to customize table of contents icons for topics in Adobe FrameMaker source documents using unstructured Adobe FrameMaker 7.2. Steps for customizing table of contents icons for topics in Adobe FrameMaker may be different in other versions of Adobe FrameMaker.

To specify a custom table of contents icon in an Adobe FrameMaker source document

1. 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.

2. 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.

3. 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.

4. 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, where ProjectName is the name of your project.

5. In your Adobe FrameMaker source document, locate the topic where you want to use the custom table of contents icon.

6. Insert your cursor into the heading for the topic.

7. On the Special menu, click Marker.

8. In the Marker Type field, select the appropriate TOCIcon marker type from the drop-down list.

9. If the appropriate TOCIcon marker type is not on the list, check with the Stationery designer to obtain the name of the marker type the Stationery designer created to support this functionality and then use the marker type specified by the Stationery designer. For more information, refer to Implementing Online Features in FrameMaker.

10. In the Marker Text field, type the following text:

If you are generating Microsoft HTML Help, type the number of the icon that you want to use for the table of contents image.

For example, if you want to use a question mark icon with a red star for the table of contents icon for new topics, type 10.

If you are generating Oracle Help or Sun JavaHelp, type the following text:

images/TOCIcon.gif

where TOCIcon.gif is the name of the table of contents icon you want to display for the topic.

If you are generating WebWorks Help, type the following text:

c=”collapsed.gif” e=”expanded.gif”

where collapsed.gif is the name of the icon you want to use when the table of contents entry is collapsed, and expanded.gif is the name of the icon you want to use when the table of contents entry is expanded. If the table of contents entry is for a page instead of a book, the entry will never be expanded, so you can omit the e=”expanded.gif” portion of the entry for pages.

For example, you might create a special icon to highlight books that are new for a particular release of your WebWorks Help system. If you named these icons newbookopen.gif and newbookclosed.gif, you would type the following text into the Value field:

c=”newbookclosed.gif” e=”newbookopen.gif”

11. Click New Marker.

12. Save your Adobe FrameMaker source document.

13. Generate output for your project. For more information, see Generating Output.

14. In Output Explorer, verify ePublisher created the table of contents using the table of contents icon you specified for the topic. For more information about viewing output files in Output Explorer, see Viewing Output in Output Explorer.

Was this helpful?

Last modified date: 06/11/2024