Online Help  


Html Help Workshop

Overview

A. Introduction
B. Making Use of the MS HTMLHelp-Workshop
C. Changing and Adding HTML Files

A. Introduction

Create your own Xtremes help system, e.g., in a different language, within the given set-up!

Xtremes requires two files for the html-help, namely,

1. xtrhelp.chm (compiled html-help of Xtremes, see Part B)
2. xtrhelp.hhk (index file, see Part C)
Both files are in the working directory (as xtremes.exe) after the installation. We describe in detail how the user can change the installed help files and, thus, the html-help system of Xtremes.

B. Making Use of the MS HTMLHelp-Workshop

1. Installation of the HTMLHelp-Workshop

The html-help of Xtremes is created by means of the MS HTMLHelp-Workshop. For that purpose install the HTMLHelp-Workshop which can be freely downloaded from, e.g.,

http//www.microsoft.com/
2. Installation of HTM and GIF Files

Create a subdirectory html\ from the working directory and copy the required *.htm, *.gif and xtrhelp.* files from the CD-ROM (stored in the directory \xtremes\html) or from the Xtremes website into that subdirectory. Changes must be done in the htm files (e.g., in datamenu.htm or in helpworkshop.htm, where the latter file contains the present htm page). For further details we refer to Part C.

3. Compiling the HTML Help of Xtremes

The MS HTMLHelp-Workshop creates the file xtrhelp.chm by using the HTMLHelp project file xtrhelp.hhp.
Start the HTMLHelp-Workshop

(a) by clicking within the Windows-Explorer onto the project file xtrhelp.hhp within the subdirectory html\ or
(b) via the start-button "start -> programs -> HTMLHelp Workshop" and select xtrhelp.hhp by means of "File -> Open" in the subdirectory html\ .
At the left-hand side of the HTMLHelp Workshop window there appears information about the actual project. Now compile xtrhelp.chm by "File -> Compile".
After a successful compilation copy xtrhelp.chm from the subdirectory html\ into the working directory.

C. Changing and Adding HTML Files

As already mention the two files xtrhelp.chm and xtrhelp.hhk are included in the working directory. Make sure that a copy of xtrhelp.hhk is also in the subdirectory html\ if a new version of xtrhelp.chm is compiled.

1. Files of the Xtremes HTML-Help System in HTML

*.htm html-files of Xtremes html-help system
*.gif pertaining GIF-files
xtrhelp.hhp HTMLHelp project file
xtrhelp.hhk index file (contains keywords and attached menu id's)
xtrhelp.hhc contents file (contains table of contents)

Take care that that the file-names in the project file xtrhelp.hhp are written in the same manner - w.r.t. lower and capital letters - as the file-names of the existing files.

2. Changing the Given HTML-Files

Use one of the usual editors or a html-editor. Add new links, yet leave the existing links unchanged as far as possible.

3. Adding New HTML-Files

Create a new html page in the usual manner. Include an entry in the project file xtrhelp.hhp.

4. Testing the New Compiled Version

For testing the new html\xtrhelp.chm file directly after the compilation employ a double-click onto that file within MS Windows-Explorer.

© 2005
Xtremes Group · updated Jun 21, 2005