HOW TO CREATE HELP (.HLP) FILES by hand, i.e. without paying for special tools.
This is derived from something Peter Hill wrote in comp.lang.pascal.delphi
on 15 Mar 1997 ...
You need the following to write .HLP files:
1. An RTF-capable (Rich Text Format) word processor.
MS Word for Windows is an example. Ami Pro and
Word Pro are okay, too. Write isn't.
2. A help compiler. Delphi version 1 (and following,
as far as I know) supplies one. On my system the
help compiler is called HC31.EXE, in C:\delphi\bin.
If you don't have Delphi, I'm sure the help compiler
is available over the net, free, from someone.
(See libraries, below)
3. 2-3 hours to understand the Windows Help markup
language. I think you'll find it takes less. 2-3 hrs
to produce your first file, maybe.
I found the help I needed on point three in the 'help on making help
files' help file that came with the help file compiler that came with
Delphi. That help file also covers how to run the help compiler.
On my system it is called helpref.hlp, and is in C:\delphi\bin
So... writing help files can cost you very little... not even
inordinate time or hassle. It is a little like writing html code
in Notepad, and then instead of a publishing step, as on the
net, there's a compiling step.... and the code is less complex.
All of the above is fine... in theory. However, I would recommend using something like HelpScribble (see next section). I think you will save much time (=money) in the long run. Managing the hyperlink tags in your RTF document can be tedious. There's even a free trial version of HelpScribble, so what have you got to lose? (No, I have no connection with JGSoft, other than happy customer!)
If you still think you'd like to write your helpfiles by hand, you'll need to find help with RTF creation.
Software for generating Helpfiles...
I've been a happy user of "HelpScribble" for some time now. You can download a free evaluation version from JGSoft's site.
The install process is a little tedious, because JGSoft do not "reinvent the wheel" of the actual help compiler that you use, and, as that belongs to someone else, they can't distribute it bundled with what they do provide, which is a splendid editor for preparing the RTF document that the help file compiler acts upon. The JGSoft program, once set up, passes the RTF to the compiler with a simple click of a button.
HelpScribble has two main panes: On the left is a list of all of the pages in your helpfile. On the right is a nearly wysiwyg image of one of the pages. I said "nearly"... it isn't imperfect, but it helpfully displays some details of links that the end user won't need or see. You use the list on the left to navigate between pages as you build the helpfile.
You can produce Windows 95 (and higher, I believe) or Windows
3.1 help files. HelpScribble has a Contents Editor, a Segmented
Hypergraphics Editor, a Window Editor, etc, etc.
You may be interested in the fact that HelpScribble can be interfaced directly with
the Delphi IDE. You install the Help Context editor into the Delphi
component library. Then when you want to fill in the help context
property for a form or component you just click on the "..." button that
now appears in the Help Context edit box in the Object Inspector. A
dialog opens which allows you to visually plug in Context IDs from the
help project you created.
HelpScribble may not be the last word in helpfile authoring packages, but it has been everything I have ever wanted, so I didn't look any farther after finding it. The rest of this page mentions some things I heard about, but never explored.
The following items have been recommended in various internet usergroup
postings. I cannot vouch for them myself, and the posts are from a while ago, but maybe you'll find something you want with these starts. If you find one of these, or have another to recommend, please don't hesitate to email me. (Button below. Plain text only, please.)
If the software has become freeware, you might find it at www.freewarefilez.com... if youy can find that! It seemed to be gone when I looked in June 06. I'd also always pay a visit to the Tucows and ZDNet download centers if looking for something off the net... their search engines are good.
===
An editor apparently called HelpEd20 was recommended. ('Help Editor, ver 2.0', I presume) I was told it had no nags, markings or other restrictions, and registration was only US$15.
===
A while ago, HelpMatic was recommended, described as shareware, around $15. Said to come from www.helpmaster.com, but at 6/06, that site was in German, and I didn't see anything about HelpMatic. Maybe you can find HelpMatic elsewhere.
===
Someone said he was looking for a shareware RTF word processor, for
creating help files for Delphi.
Someone else said check out...
Windows Help Designer V2.0 Pre Release, copyright 1997 Nick Ameladiotis
===
Someone was looking for a program to convert .hlp files to printable documentation. He disliked directly printing from the help system as many .hlp pages only contain one or two lines.
Someone recommended "help2doc". (If you are creating your own help files with HelpScribble, you can easily prepare printed copies of the help file.)
=== www.danish-shareware.dk/soft/shelpm/: I haven't tried the product, but i have checked that the site appears legitimate. Here you should find Shalom Help Maker, which was freeware when I looked.
Ad from page's editor: Yes.. I do enjoy compiling these things for you...
hope they are helpful. However.. this doesn't pay my bills!!! If you find
this stuff useful, (and you run an MS-DOS or Windows PC) please visit my Sheepdog Software (tm)
freeware and shareware page, download something, and circulate it for me?
At least (please) send an 'I liked the parallel port use page, and I'm
from (country / state)' email? (No... I don't do spam)
Links on your page to this page would also be appreciated!
Here is how you can contact this page's editor.
Why does this site cause a script to run? I have my web-traffic monitored for me by eXTReMe tracker. They offer a free tracker. If you want to try it, check out their site. Be sure you know all you need to about spyware.
Why does this site cause a script to run? I have my web-traffic monitored for me by eXTReMe tracker. They offer a free tracker. If you want to try it, check out their site. Be sure you know all you need to about spyware.