Board index » delphi » How to create a help file for a custom control.

How to create a help file for a custom control.

Hi folks,

As I stated in a previos posint, I have created a custom control which
analyzes PDF files.  The custom control is nearly finished, and now I would
like to write a help file which explains how to use the control, the
properties and the methods (just like the other controls in Delphi have a
help file).

Now I wanted to know if there is an easy way of doing this and how I should
do it, and what programs I can use for it.

If anybody can help me out with thatm please send your repliest to my
e-mail adress too,\

Greetings and thanks in advance,

        Stefaam

--

Stefaan Lesage
Fotek nv; Belgium
Stef...@fotek.com

 

Re:How to create a help file for a custom control.


Hello again.

The best way I've found for writing help files is with HCRTF.EXE in the
..\Delphi2.0\Help\Tools directory.  This compiles a project help file
and any topic files you list for it.  The topic files are best written
with MS Word using Rich Text Format (.rtf).  Footnotes are used to
designate the topic's name, keywords, and title.  Other formating, such
as bold, underline, italic, font type/size, etc., are automatically
translated from the .RTF file.

Start by checking out the Help Author's Guide (HCW.HLP).  It explains
everything in detail.

Good luck.
Matt

Re:How to create a help file for a custom control.


Yes, but what is the best tool for writing the RTF files?  Trying to write
them in Ms word and applying loads of weird formatting styles and trying to
remember what footnotes of $, *, # or whatever else mean is a nightmare :-)

Nigel.

Quote
> The best way I've found for writing help files is with HCRTF.EXE in the
> ..\Delphi2.0\Help\Tools directory.  This compiles a project help file
> and any topic files you list for it.  The topic files are best written
> with MS Word using Rich Text Format (.rtf).  Footnotes are used to
> designate the topic's name, keywords, and title.  Other formating, such
> as bold, underline, italic, font type/size, etc., are automatically
> translated from the .RTF file.

Re:How to create a help file for a custom control.


Nigel Gay <impl...@itl.net> wrote in article
<01bc733a$eaf42ee0$720c9...@hades.www.itl.net>...

Quote
> Yes, but what is the best tool for writing the RTF files?  Trying to
write
> them in Ms word and applying loads of weird formatting styles and trying
to
> remember what footnotes of $, *, # or whatever else mean is a nightmare

:-)

Check out this website. I've seen the tool demoed, & it is cool.
It's called "AutoHelp". It reads your code, writes the rtf, then
it writes the help file. Pretty fast, too.  Still in beta...

http://ourworld.compuserve.com/homepages/dinobyte

--
Grace + Peace   *   Peter N Roth  *   Engineering Objects International
Author of "C++ Jump Start" ISBN 0-9655862-2-7.
Tools for Developers: ClassBuilder 4 for Delphi, ClassBuilder++ for C++
Visit our website at http://www.inconresearch.com/eoi

Re:How to create a help file for a custom control.


I use HelpScribble which is written especially for Delphi users and has a
tool to analyze a unit and provide a format that covers all properties and
methods. It can be found at the Delphi Superpage. It is shareware and I
registered.

Jack
 Stefaan Lesage wrote in article <01bc7263$34cb51c0$34ac2ac0@pcwim>...

Quote
>Hi folks,

>As I stated in a previos posint, I have created a custom control which
>analyzes PDF files.  The custom control is nearly finished, and now I
would
>like to write a help file which explains how to use the control, the
>properties and the methods (just like the other controls in Delphi have a
>help file).

>Now I wanted to know if there is an easy way of doing this and how I
should
>do it, and what programs I can use for it.

>If anybody can help me out with thatm please send your repliest to my
>e-mail adress too,\

>Greetings and thanks in advance,

> Stefaam

>--

>Stefaan Lesage
>Fotek nv; Belgium
>Stef...@fotek.com

Other Threads