Table of Contents

Previous

Next


Understanding HTML Help Workshop

HTML Help Workshop is a help authoring tool that allows you to create and manage Microsoft HTML Help projects and their related files. You can use this tool, which is installed with ePublisher, to further customize your help, such as changing the appearance of the Contents and Search tabs. You can also create an override for your project .hhp file in your ePublisher project, which allows you to implement the custom HTML Help Viewer window you need. For more information about Microsoft HTML Help and its related files and customization options, see the help for HTML Help Workshop.

HTML Help Project File (.hhp)

The HTML Help project .hhp file identifies all the elements of an HTML Help project. This project file is separate from the ePublisher project. The HTML Help project file contains the information HTML Help Workshop needs to combine the source files, images, index, and table of contents into a single, compiled help .chm file.

The HTML Help project file also defines the appearance and behavior of the HTML Help Viewer window. ePublisher creates the HTML Help project file based on the template.hhp file and the settings in your ePublisher project. You can override the default template.hhp file to adjust the default appearance of your HTML Help, such as the default size and position of the HTML Help Viewer window or the buttons displayed in the toolbar pane. You can also define additional windows in the template.hhp file, such as a window without the navigation pane. For more information, see “Adjusting the HTML Help Viewer Window Size and Toolbar Buttons” on page 205 and “Creating an Additional HTML Help Window Definition” on page 206.

HTML Help Contents File (.hhc)

The HTML Help contents .hhc file defines the table of contents for the help. This file includes entries for each occurrence of the paragraph styles for which you assigned a TOC level in your ePublisher project. HTML Help displays the contents of this file on the Contents tab of the navigation pane. ePublisher generates the toc.hhc file for your project using the template.hhc file.

HTML Help Index File (.hhk)

The HTML Help index .hhk file defines the index for the help. This file includes entries based on the index markers and field codes in your source documents. HTML Help displays the contents of this file on the Index tab of the navigation pane. ePublisher generates the index.hhk file for your project using the template.hhk file.

HTML Help Mapping File (.h)

The HTML Help mapping .h file identifies the mapping information for context-sensitive help links. This file includes an entry for each TopicAlias marker or field code in your source documents. Application developers build this file with their project and use the defined aliases to display the appropriate topic in the help. This file is linked in the MAP section of the .hhp file, and its entries coordinate with the entries in the ALIAS section of the .hhp file.

ePublisher/2009.1/Help/02.Designing_Templates_and_Stationery/01.023.Selecting_Formats (last edited 2009-05-01 02:12:12 by TonyMcDow)