Help with MSWorkshop - Help tool.

[delphiman]

Help with MSWorkshop - Help tool.

I am using the above from Delphi6/Tools to develop a Help file
for an Application but find the guide-instructions somewhat lacking.

Problem 1.
Having developed a .rtf file with MSWord7 and having compiled a .hpj
file with MSWorkshop it works along with the browse buttons. But I am
unable to get the "jumps" to work. Meanwhile I don't understand the
purpose of the .cnt file in the Grand Plan!

The following is an extract from the .rtf file:

$ # K A + Getting Started
Blah blah blah and rhuburb.

You should .(Having clicked here I expect to end up below. But I don't.)

$ # K A + You should.

Problem 2.
I can't get F1 key support to work.
I have assigned the help filename to the HelpFile Property of the
Application Class via the Application page of Project Options.
I have also set the HelpKeyWord Property to {You should}.
But I don't know what to do with the HelpContext property nor can I
find a sensible explanation as to how one creates one.

Problem 3.
I need the code to be able to trigger my Help file from a button
created on a menu. To be able to get the Help (little book) icon
onto the button would also be nice!

Anyone?

 

[sggaunt]

Hello Delphiman

Helpworkshop has it's own forum on this site (much under and inappropriatly used) you might get some clues there,
On major consideration is that Helpworkshop is now considered to be old hat and most new application have HTML style help, this is compiled with a different free tool (downloadable from Microsoft) called HTML Help workshop.

The reason I point this out is because There are some differences in how these work that are related to the problems you are having, so there may not be much point in you trying to solve problems only to find they are irrelevant later.

Anyway to try and answer your question here is a line from one of my own rtf files.

'To set up Flash see Setting up IDH_Setting_up'

Whats important here is the (now dissapered) text formating
The First 'setting up' is double underlined and is what the user sees in green as the link the 'IDH_setting up' is hidden text and is the jump address.
You should have a table of these stored as footnotes. That refer to the heading on each 'Topic page' The ones with a # are the imporantant ones

You can create a Table of contents by selecting new/ help contents. This creates a contents tree that the user uses to navigate through your help system each contents label is mapped to a # tag of your topics.
e.g. a content entry 'setting up' will have a link to IDH_setting_up.

You need to create a [MAP] section in the main help project file to get your context jumps to work.
giving a numeric value to each #footnote assigned.

I think the help with helpworkshop is pretty poor and most of it is overcomplex and irrelevant especially the stuff relating to all the diffrent keywords $,K,# etc
The only important one when starting out is '#' as this is what make your links work it also provides the reference for context jumps.
Also help workshop is full of bugs, unfortunatly 'HTMLHelp workshop' is not much better but it does have some advantages.

1. You dont end up with Huge RTF files. Just loads of fairly small HTM files.

2. HTMLHelp workshop is still being supported my MIcrosoft (In that we might get occational upgrades and bug fixes)

3. Everyone else will be providing this sort of help system if you dont want to look dated you need to as well.

4. The interface (though bugged) is easier to use than the old system. the contents system is intergrated with the rest rarther than being edited seperatly.


You will find some problems with Delphi context sensitive intergration, have a look in the Helpworkshop Forum for the ways around this.

I have rambled on a bit here hope some of it helps

Steve.

 

[Dooda]

You asked about the cnt file - it holds the contents page for a help file. So if it is not present then help runs with no contents page. Sorry I cannot help more - I use a tool from

http://www.danish-shareware.dk/soft/shelpm/

which is easy to use but not up-to-date html style.

 

[delphiman]

Thanks Steve!

I have taken your advice and have downloaded HTML Help workshop which seems more appropriate to-day.

I am making better progress now.

But even here I am pulling my hair out trying to establish WHEN and HOW one gets to use the little BOOKS (instead of folders) and the little question-mark goodies (instead of files). I find myself oscillating between the two - and don't even know how I did it.

How do I control this?

I find it so common that this type of thing (almost without fail) doesn't come with a step-by-step (tested!!) working model (or tutorial) - together with all the valuable rocket science!

Thanks in advance.

 

[sggaunt]

Hi Delphiman

Click the Contents tab, then click the Top Icon at the side of the Contents list.
You should see some tabbed pages,
The general page allows you to select Folders or Books.
The Styles page allows you to select lines between items and Plus minus boxes that sort of thing.

You will have to recompile your project for the changes to take effect.

What you always have to bear in mind is that HTML Help Workshop is a program that Microsoft are giving away for free!!.

Steve.

 

[delphiman]

Many thanks Steve!

You've really got me going!!

Can you (anyone) please tell me how to change the back-ground colour of the "Contents" payne? (Assuming you know how! )

Thanks in advance.

Terry