Richard Hendricks'
Windows Help File Authoring
Web Site
In Association with Amazon.com
In Affiliation with Beyond.com
HTML Help
HTML Help Authoring
Microsoft announced that it is abandoning the current Windows Help (WinHelp)
for a Help system based on HTML. The following sites contains the latest
information about the new help system. Internet Explorer Version
3.x\+ is required to use the HTML Help Software.
- HTML Help Microsoft's Site about HTML Help containing information, latest software, supporting vendors, etc.
- Redistributing HTML Help by Microsoft
- HTML Help FAQ by Microsoft
- HTML Help Documentation by Microsoft
- HTML Help Center HTML Help Techniques for Developers and Authors by VB Explorer
- Help Master - HelpMaster's WinHelp, HTML Help, HyperText and Animation Site by Josef Becker
- VFPHTML.EXE Demonstrates HTML Help in Visual FoxPro 3.0 and 5.0 Microsoft Knowledge Base Article
- The New HTML Help Standard by Keith Bugg, C/C++ Users Journal, Aug '98
- FAR Home Page HTML Help Tools by Robert Chandler (FAR and HHServer) **Free Utilities**
- KeyTools KeyTools is a set of utilities for managing the HTML Help and WinHelp systems **Free Utilities**
- WexTech Systems The Help Experts
- WexTech Knowledge Base Articles Homepage
- The Official Microsoft HTML Help Authoring Kit : Understanding, Creating, and Migrating to Microsoft HTML Help by Steve Wexler, Brett Foster; Paperback - 300 pages; Book with CD ROM edition (February 1998) Microsoft Press;
[Buy It]
WinHelp
Help Authoring Guidelines (HAG)
Microsoft has created a document to assist in the Authoring of Windows Help
Files. There is a version that is in the WinHelp format and a set that is in
the Word for Windows format. The HLP formatted file is
HAG.ZIP
(requires WINHELP Version 3 to work properly WINHELP3.ZIP)
and the DOC formatted version is contained in two files
WHAG-TOC.ZIP
and
WHAG.ZIP.
I haven't found these file on any of the Microsoft's FTP sites, but they are
available on many other FTP sites. If you have trouble with the FTP Site
that I used, go to FileZ and
search for the files.
Help Authoring Guideline Files...
- HAG.ZIP Help Authoring Guidelines in HLP format
- WINHELP3.ZIP WINHELP Version 3 is required for HAG.ZIP
- WHAG-TOC.ZIP Help Authoring Guidelines Table of Contents in DOC format
- WHAG.ZIP Help Authoring Guidelines Table of Contents in DOC format
- Search for these files on FileZ or one of the other search engines if you have trouble with the FTP Site that I linked.
Authoring Windows Help files: RTFGEN - ASCII Text file to Windows Help File Format
One way to create Windows Help files easily and cheaply is to use your favorite
text editor or one of the ones that comes with Windows and a program called RTFGEN.
RTFGEN is a Windows based Freeware program that accepts an ASCII file, called a Topic Source File (TPC),
that contains text and RTFGEN commands. These commands identify Headings, Cross References, Definitions,
Bitmaps, Fonts, Paragraphs and other attributes of the resulting Help File. Currently, the latest version of
RTFGEN.ZIP is Version 2.0.
This archive contains RTFGEN, a help file and some sample Topic Source File. You will also have to
have a copy of HC.EXE and HC.ERR. These are contained in
VBHC505.EXE
The author is requesting $10.00 for the Turbo Pascal Source, but is not charging for the
use of RTFGEN.
Basic steps...
- Create the Topic Source (TPC) file with your favorite text editor. Along with the text of the
help file you will include the RTFGEN Commands to identify the Headings, Cross References, etc.
- Run RTFGEN
- For a new Help file. Do the following...
- Select "Project | Topic Files... | Add File". From the dialog, select all
the files that are required for the Help File.
- When you've finished selecting your files, click on "OK"
- Select "File | Save As". This is where you set the name for the Help Project Source (HPS) file.
- For an existing Help Project, select "File | Open" and select the the appropriate HPS file.
- To create the Help File from the TPC file, "Compile | Full Compile, Display". This will convert
your TPC file into an RTF and then compile the RTF to a HLP file. After this has been done, then
RTFGEN will open the newly created HLP file. There are other options on this menu; "RTF Only", "Help Compile"
and "Display Help".
- If all goes well you should have a Windows Compatible Help file. The name of
the help file is the name you gave to the HPS file.
- Additional attributes can be set for the Project under "Project | Options". One attribute you will
probably want to set is the "Title". This determines what is displayed on the Title of the Help Window.
Note: RTFGEN is expecting to use the HC30.EXE or HC31.EXE Help Compilers. I'm using HC.EXE, so I
made a copy of my HC.EXE and HC.ERR and called them HC31.EXE and HC31.ERR. This then allowed me to
let RTFGEN to produce the Windows Help File in one step. Kind of a Compile, Link and Go selection.
RTFGEN Related Files and Links...
- RTFGEN.ZIP Converts ASCII files to Rich Text Format (RTF) files to Produce WinHelp (HLP) Files.
- VBHC505.EXE Updated Help Compilers.
- Search for RTFGEN.ZIP on FileZ or one of the other search engines if you have trouble with the FTP Site that I linked.
- RTFGEN Windows Help Authoring Homepage by Lemoore High School. (Not the author's Homepage, but contains useful information)
![up]()
Authoring Windows Help files: RTF (Rich Text Format) to HLP (Help File Format)
Windows HELP files can be created easily and cheaply with any
word processor or text editor that can create Rich Text Format (RTF) files.
The results may not be as professional as some you've seen, but this is a
good approach to start with. Some of the alternatives can be quite
expensive.
Word for Windows as well as other word processors can save files in the RTF
format. Microsoft has a DOS utility called the 'Help Compiler' and it is
available for downloading from Microsoft's FTP site. Currently, the filename
is VBHC505.EXE.
After you have created your document and saved a copy in the RTF format. You
are ready to create your HELP file. This is done by running the 'Help Compiler' (HC or HCP).
HC converts the RTF file into a Windows Help File (HLP).
The HC compiler is for Windows Standard Mode and the HCP compiler is for
Protected Mode (uses expanded memory). The HC compiler consists of HC.EXE
and HC.ERR. The HCP compiler consists of HCP.EXE and HCP.ERR.
Basic steps...
- Create the text for your help file with your favorite word processor or text editor
- Save a copy of it in the RTF file format
- From 'Start | Run' or a DOS Prompt, type HC <rtf_filename> [cr] ; include paths as required
- If all goes well you should have a Windows Compatible Help file. The name of
the help file is the original filename of the RTF file (ie, myapp.rtf to myapp.hlp)
Help Compiler...
- VBHC505.EXE Updated Help Compilers for Word 6.0 This is all you NEED.
- HC505.EXE Version of 3.1 Help Compiler. (Same as above, except VBHC505 has a little larger HC505.TXT file)
- Microsoft's Software Library FTP Directory (/Softlib)
- Index.txt file for the /Softlib/MSLFILES subdirectory. Use this file find the files that you need. They are stored in /Softlib/MSLFILES. There are lots of files here, not just the Help Compiler. Look around...
- Microsoft's Software Library File FTP Directory (/Softlib/MSLFILES)
Note: if you have Visual Basic 3, then you have Help Compiler (HC31.EXE) Version .504.
If you have Visual Basic 4, then you have Help Compiler (HC.EXE) Version .505.
In both cases the compilers are found in the \hc directory. I'm not sure about Visual Basic 5 or
any other Microsoft language products. Both of the above compilers create WinHelp Version 3.0 Help files
whereas, Windows 95 uses WinHelp Version 4 files. Fortunately, Windows 95 also supports the WinHelp Version 3.0 files.
![up]()
Authoring Windows Help files: Help Compiler Work Shop RTF (Rich Text Format) to HLP (Help File Format)
Microsoft has released the Help Compiler Work Shop, version 4.03. This is a Windows
application that makes it a little easier to manage the development on
the Help files. This version still relies on the use of Rich Text Format (RTF) files.
Word for Windows as well as other word processors can save files in the RTF
format. The Help Compiler Work Shop is available for downloading from Microsoft's
FTP site. Currently, the filename is HCWSETUP.EXE.
Basic steps...
With your text editor or Word processor...
- Create/Maintain the text for your help file
- Add to the text special Named Footnotes that identify the Topic ID, Topic Title, Keywords, etc
- The # footnote identifies the Topic ID
- The $ footnote identifies the Topic Title
- The K footnote identifies the Keywords for the Topic
- (There are other footnote types, but these are the basic ones)
- Add to the text special tags or markers for graphics, etc
- Save in the Rich Text Format (RTF) file format
Through the Help Work Shop...
- Create/Maintain a Help Project (.HLJ) file. This is the file that
maintains the list of elements that make up the help file along with
other settings
- Create/Maintain a Content (.CNT) file. This is the Table of contents
and links the text (via Topic IDs) with the Table Contents entries
- Save and Compile the Help File
- Test your Help File. If all goes well you should have a Windows
Compatible Help file. Normally, the name of the help file is the name
of the Project file
Help Work Shop...
- HCWSETUP.EXE Current Version of Help Compiler Work Shop is 4.03.
- Microsoft's Software Library FTP Directory (/Softlib)
- Index.txt file for the /Softlib/MSLFILES subdirectory. Use this file find the files that you need. They are stored in /Softlib/MSLFILES. There are lots of files here, not just the Help Compiler. Look around...
- Microsoft's Software Library File FTP Directory (/Softlib/MSLFILES)
Note: As I understand it, if you have Visual Basic 5, then you have
the Help Compiler Work Shop and it is located in the \Tools\HCW folder on the
CDROM. The version on the FTP site is a little newer, but not significantly
better.
Authoring Windows Help files: Windows Help Authoring Tool (WHAT)
If you own Word for Windows Version 1.1 or 2.0 or a text editor like notepad,
you can create Windows Help files using the unsupported Windows Help Authoring
Tool called WHAT. Microsoft wrote WHAT for internal use and released it to the
public. Currently, this tool is in WHAT.ZIP.
I haven't found this on a Microsoft site, but I found it on lots of other FTP sites.
If the site I have linked is busy or the file is missing, go to FileZ
and search on WHAT.ZIP and any of the ones that are 1.2 Megs and dated July 28th, 1993 are what you want.
According to the documentation you can use this utility with Word for Window
Version 1.1 or 2.0 or with a text editor like notepad. The documentation
describes how to install the utility to use with Word or without Word.
Windows Help Authoring Tool...
- WHAT.ZIP Windows Help Authoring Tool for Word for Windows Version 1.1 or 2.0. It can be used with Word.
- Check FileZ (or one of the other search engines) if you have trouble with the above site. Search on WHAT.ZIP and the one you want is 1.2 Megs, July 28th, 1993.
Authoring Windows Help files: Windows Help Authoring Tool (WHAT6)
If you own Word for Windows Version 6, you can create Windows Help files using
the unsupported Windows Help Authoring Tool called WHAT (Version 6). Microsoft wrote WHAT6
for internal use and released it to the public. Currently, this tool is
in WHAT6.EXE.
The WHAT6 utility consists of a template (.DOT) and related tools specifically
designed to work with Word for Windows Version 6.
The Help Authoring Template (WHAT6.DOT) makes it easier for you to:
- Create and edit topic files.
- Insert and edit topics, graphics and hot spots.
- Format topic text and graphics.
- Save topic files in RTF format.
- View partial or complete builds of the topic file in Windows Help.
- Insert bitmaps into your help file.
- Apply help styles.
- Format Lists.
Windows Help Authoring Tool...
- WHAT6.EXE Windows Help Authoring Tool for Word for Windows Version 6.0 (WHAT6).
- Microsoft's Software Library FTP Directory (/Softlib)
- Index.txt file for the /Softlib/MSLFILES subdirectory. Use this file find the files that you need. They are stored in /Softlib/MSLFILES. There are lots of files here, not just the Help Compiler. Look around...
- Microsoft's Software Library File FTP Directory (/Softlib/MSLFILES)
Windows Help File Decompiler
This is a DOS based Freeware utility that will decompile the WinHelp File into it's components. This program
supports the Windows 3.1 version as well as the Windows 95 version of WinHelp. The decompiler is
contained in
HELPDC21.ZIP.
The author has included some documentation, the executable and the C source code.
After you decompile the help file, you can then reassemble it with the Help Compiler (HC).
Help File Decompiler File...
Other Windows Help Authoring Links and Products...
- Help Master - HelpMaster's WinHelp, HTML Help, HyperText and Animation Site by Josef Becker
- EC Software - makers of Help & Manual. It is a stand alone WYSIWYG authoring tool for creating HTMLhelp, HTML, WinHelp and ready-to-distribute printed and electronic manuals from one single source.
- Guy Software - HELLLP! WinHelp file author tool for WinWord 2, 6 and 7
- Blue Sky Software - Help Authoring solutions for all Windows platforms and HTML based Help. Authors of RoboHELP as well as other products
- Help Magician Pro extremely complete, standalone (no MS Word needed) help authoring solution
- Winhlp-L archive (WinHelp mailing list searchable database)
- HelpMaster Hypertext Site by Josef Becker
- HyperAct's WinHelp Resources
- The Story Teller's Home Page Jim Hiller - VB WinHelp Programming, WinHelp Authoring, Visual Basic and other subjects
- PDR Automated Systems and Publications
- Paul Arnote's WinHelp World Home of MiniHelp Plus along with links to other WinHelp resources and software
- Gregory Hirsh's Book List Books on WinHelp Development and Technical Writing
- WinHelp Development Services - Gregory Hirsh
- HelpScribble Homepage. HelpScribe a program to create Windows Help files, without the need of a word processor. Requires Windows 95.
- The Windows Help Universe by Weisner Associates, Inc. - Authors of HARK; Help Author's Resource Kit
- WexTech Systems Homepage. Authors of Doc-To-Help as well as other products
- Work Write User Assistance from WinHelp to the Web
- HelpMaster Homepage. Useful resource for WinHelp and HTML Help
Books about Windows Help Authoring...
- Building Windows 95 Help By Nancy Hickman, CDROM included, Published by M&T Press
[Buy It]
- Designing Windows 95 Help - A Guide to Online Documents By Mary Deaton and Cheryl Lockett Zuback, Published by QUE, 1996
[Buy It]
- Developing Online Help for Windows 3.1, 1st Edition for Windows 3.1 By Scott Boggan, Dave Farkas, and Joe Welinske, Published by International Thompson Computer Press, 1995,
[Buy It]
- Developing Online Help, 2nd Edition for Windows 95 By Scott Boggan, Dave Farkas, and Joe Welinske, Published by International Thompson Computer Press.
[Buy It]
- The Developers Guide to WINHELP.EXE By Jim Mischel, Published by John Wiley & Sons.
[Buy It]
- Windows '95 Help Authoring Kit : Guide to Creating Help Files for Windows 95 (Microsoft Professional Edition)
[Buy It]
- The Official Microsoft HTML Help Authoring Kit : Understanding, Creating, and Migrating to Microsoft HTML Help, by Steve Wexler, Brett Foster
[Buy It]
- Mastering HTML for Help Authors, by Debbie Wilimek
[Buy It]
