The Project File (1)
There are six main parts to a HTML Project File:
|
Options
|
This section contains the basic information about the Help file. |
|
Windows
|
This section contains information about the different Help Windows you
are using |
|
Files
|
This is simply a list of all the files in your HTML Help Project |
|
Alias
|
Here, we're aliasing each required topic file to a topic ID. This will
be explained later. |
|
Map
|
This section assigns the values to each Alias, that we can use when we
call the help file from VB |
|
Text Popup
|
This file contains all of the text-based topics for What's This help |
As an example, here is a (very small) HTML Project File:
[OPTIONS]
Auto Index=Yes
Compatibility=1.1
Compiled file=DevPadHelp.chm
Contents file=Contents.hhc
Default Window=Main
Default topic=htmlwelcome.htm
Display compile progress=Yes
Full-text search=Yes
Index file=Index.hhk
Language=0x809 English (United Kingdom)
Title=Developers Pad Help
[WINDOWS]
Main="Developers Pad 1 BETA 1 Help","Contents.hhc","Index.hhk","html
welcome.htm","htmlwelcome.htm",,,,,0x520,,0x206e,[512,5,1153,496],,,,0,,,
[FILES]
htmlwelcome.htm
htmlcomments_suggestions.htm
htmlcopyright.htm
htmlcredits.htm
htmlfeatures.htm
html
eport_bug.htm
[ALIAS]
IDH_DLG_FIND=htmlfind_dialog.htm
IDH_DLG_INSERT_SYMBOLS=htmlinsert_symbols.htm
IDH_WELCOME=htmlwelcome.htm
[MAP]
#define IDH_DLG_FIND 1010
#define IDH_DLG_INSERT 1020
#define IDH_WELCOME 1000
[TEXT POPUP]
popups.txt
First, lets create a new project. Run the HTML Help Workshop, and click New.
Select, Project and click OK.
A wizard will then appear.
This gives you the option to convert a WinHelp project. We will ignore this
option for the moment. Click next. Then, specify a location for your new project
file. We will refer to this folder as the root folder
from now on. Now, go into explorer, and create two subfolders in that folder
named html and images. You are then given the option to specify
any files you have already created. As we are going to start from scratch, don't
specify any. Click Finish. This is the first stage completed. You will now see
screen looking something like this:
