Creating help files

Hello,

I am up to the stage of creating help files - I have alot of text in a *.txt format already.

Q.Where do I start? How do I do it?What is the best and most efficient way to start writing help files? Can you give an outline
Q. Can you recommend any components out there to give me an advantage?
Thankyou. Ham.
HamAsked:
Who is Participating?
 
alona041797Connect With a Mentor Commented:
Help files consist of two major parts. A HPJ (Help Project) file, and RTF (Rich Text Format) files. The RTF files may be created using Word or any other word proccessor, and the HPJ files may be created using the HPJ editor bundled with Delphi.

For more information, read the help file:
Windows API Help File | Tools | Creating WinHelp databases
0
 
ronit051397Commented:
The hcw.exe which comes with delphi 2/3 compiles the hpj files and creates help files
(after you built the rtf's using word or any other suitable application).
Also, you can buy the 'RoboHelp', an application which creates rtf's and help files and is more convenient then the word processor.

0
 
HamAuthor Commented:
Hello,

I couldnt see a HPJ Editior in Delphi! (so where is it hiding)
I now have my *.rtf file and what do I do next? hcw.exe or hcrtf.exe do not open *.rtf files. So how do I get my *.rtf to a *.hjp file? I couldnt find: Windows API Help File | Tools | Creating WinHelp databases - for that matter either!

Ham.
0
Cloud Class® Course: Microsoft Azure 2017

Azure has a changed a lot since it was originally introduce by adding new services and features. Do you know everything you need to about Azure? This course will teach you about the Azure App Service, monitoring and application insights, DevOps, and Team Services.

 
alona041797Commented:
hcw.exe is the HPJ editor/compiler. A windows API help file is available. In its contents, select Tools and then Creating WinHelp Databases.

The RTFs should be added in the [FILES] section of the HPJ file as explained in the help file.
0
 
HamAuthor Commented:
Hello again, everythings fine on the *.hlp frontier.
My 'fixit95.hlp' is now written. Further to my original question is how do I access the *.hlp from a program that Ive written.

I would like to know how to bring up the help(Contents/Index) screen and or bring up keywords/topics as a response to a button click.

Thankyou, Ham.

0
 
HamAuthor Commented:
Hi,

Can you help here? Why do I constantly get this error message?

Text taken from hcw.exe:

Creating the help file .\Fixit95.hlp.

Processing .\Fixit95.rtf
    HC4013: Warning:
      Invalid default font number in .\Fixit95.rtf. Using MS Sans Serif as the default font.
    HC4002: Warning:
      The RTF file .\Fixit95.rtf is corrupted at offset 280.
    HC4005: Warning:
      The .\Fixit95.hlp help file has not been created.

This file Fixit95.rft was a file that I renamed from a working sample file. but it refuses to work after the name change.

Thankyou, Ham.
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

All Courses

From novice to tech pro — start learning today.