ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º º
º HyperAct, Inc. º
º P.O.Box. 5517 º
º Coralville IA 52241 U.S.A º
º Compuserve - 76350,333 º
º Phone/Fax - (319) 351-8413 º
º º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
*******************************************************************************
* HLPDK- Help Engine Development Kit : helpEng Doc V11.0 *
* LAST UPDATE - Jan. 08, 1994. (c) 1992,94 - Loewy Ron. *
*******************************************************************************
HLPDK Sound & Vision Edition.
RL Help Engines.
Help Compiler, Run-Time help engines and docs.
Support for DOS, OS/2, DESQview/X, WWW & Windows.
Creates Documentation (Text, WP) from the same source.
Supported Formats :
Native(PX), Native(Mem), Win30, Win31, QuickHelp, MS Multimedia Viewer
THELP, TVHC, PopHelp, DESQview/X, OS/2, Text, RTF (Word Processors),
Sony MM Player (Via MM Viewer), WWW HTML (Supporting Windows,
Macintosh, Unix - Motif, VMS and probably some other platforms)
"Write Once, Help Many!"
*******************************************************************************
* File-List *
*******************************************************************************
This package contains the following files in the following archives :
Archive A :
-----------
READMEA.HDK - File List for Archive A.
HELPC.EXE - Help Compiler.
HLPDK.DOC - This file.
HELPC.DOC - Help Compiler documentation
HLPDK.REG - Registration file.
HLPDK.UPG - Upgrade instructions for registered users.
HLPDK.HLP - winHelp Version of the HLPDK hypertext source.
THANKS.WAV - WAV file used by HLPDK.HLP
HLPDK.INF - OS/2 IPF Version of the HLPDK hypertext source.
PROGRAMS.TXT - HyperAct, Inc. shareware products description.
HELPDEMO.HDF - Demo Help Project.
2NDDEMO.HDF - Demo Help Project - file 2.
RONP.BMP - Bitmap used in HLPDK.HDF
Archive B :
-----------
READMEB.HDK - File List for Archive B.
HELPENG.EXE - Help Engine (Native Paradox).
HE.EXE - Help Engine (Native Memory).
HLPDK.HDF - Help Development Kit hypertext help database source.
HELPDEMO.HLP - Demo Help Project file for Windows winHelp.
HLPDK.HDT - Help Development Kit help database file. (Native Paradox)
HLPDK.SET - Help Development Kit help database file.
HLPDKTOP.DB - Help Development Kit help database file.
HLPDKTOP.PX - Help Development Kit help database file.
HLPDKLNK.DB - Help Development Kit help database file.
HLPDKLNK.PX - Help Development Kit help database file.
HLPDKKEY.DB - Help Development Kit help database file.
HLPDKKEY.PX - Help Development Kit help database file.
MULTI1.HDF - Multiple file target database demo - 1.
MULTI2.HDF - Multiple file target database demo - 2.
MAKMULTI.BAT - Demo multiple file target database batch file.
Archive L :
-----------
READMEL.HDK - File List for Archive L.
HDKLIB.DOC - HLPDK System Library Documentation.
HDKLIB.HDF - HLPDK System Library main file.
RTFLIB.HDF - RTF common functions extension library.
VWRLIB.HDF - MMViewer Extension Library for 256 color bitmaps.
IPFLIB.HDF - System extension library component. (OS/2)
WWWLIB.HDF - HTML Extension Library.
TESTLIB.HDF - A Small test for the library - Source.
TESTLIB.HLP - A Small test for the library - WINHELP format.
PRS.BMP - A Bitmap used in the test.
RANCO.AVI - A Short Video Sequence featuring Ranco The Great.
CREDITS.WAV - Credits in vocal, for the MOVIE demo help database.
INTRO.WAV - Vocal introduction to the MOVIE demo help database.
MOVIE.HDF - A Multimedia Help Database demo source.
MOVIE.HLP - A Multimedia Help Database demo - winHelp version.
Note : In some cases all files may be in one archive.
The registered version is shipped in one archive and includes some additional
files.
*******************************************************************************
* Why Register and registration instructions *
*******************************************************************************
The Help Engine Development Kit (HLPDK) is a shareware product, if you
find this product valuable, please register it.
This section describes the reasons you should register.
By registering you will receive a complete discussion of the help engine
features, and many examples of usage. You will receive a diskette with the
latest HLPDK version, and DPMI (DOS protected mode) versions of the help
compiler and engines!. (The memory version of the help engine can display
huge databases only in the protected mode version).
With your registered version you will also receive a Registration Bonus
Certificate for one issue (or an additional issue if already a subscriber) of
the "JCSM Shareware Collection"tm CD-ROM at a cost of only $9.95 ! (plus S&H).
Offer valid through June 30, 1994. Only one certificate can be redeemed per
issue.
Your registration will help us to create the next versions of HLPDK, that
will include more options, and features, some of them might even be your
enhancement requests!
A point to consider - If you want to create Windows Help source files,
you will have to purchase a word processor that can output RTF files,
the WORD for Windows 2.0 package, for example, is listed at around $500!.
To order your registered copy of HLPDK please do one of the following:
1. Order from HyperAct, Inc.:
You can order directly from HyperAct, Inc.. Please refer to the supplied
HLPDK.REG file. Edit it, print it and mail it (with a check) to:
HyperAct, Inc.,
P.O.Box 5517
Coralville Iowa 52241, U.S.A
If you are outside the US and Canada, please note the following:
- the S&H fee
- wire-transfer payments can be arranged. Please contact HyperAct, Inc..
2. Order from PsL:
You can order from Public (software) Library with your MC, Visa, AmEx
or Discover card by calling 800-242-4PsL (from overseas: 713-524-6394)
or by FAX to 713-524-6398 or by Compuserve to 71355,470.
These numbers are for ordering only. HyperAct, Inc. can NOT be reached at
those numbers. Please contact HyperAct, Inc. directly for any other type of
problem (technical or other), information or request.
Registered users Upgrade note:
------------------------------
If you registered HLPDK version 9.x, you can receive this version free (you
pay only S&H fee). If you have an older version, you can get this version for
only $15 (plus S&H fee). Please refer to the supplied HLPDK.UPG file. Edit it,
print it and mail it (with a check) to HyperAct, Inc..
*******************************************************************************
* What's New *
*******************************************************************************
Version 11.0
- HDKLIB - The HLPDK system extension library is included with this
version of HLPDK. This version adds inter-paragraph text formatting
capabilities to RTF targets, Graphic links in WINHELP and MM Viewer
targets, The complete WINHELP macro API in WINHELP and MM Viewer,
256 color bitmap support in MM Viewer, Video, CDAudio and Multimedia
MCI interface in WINHELP and MM Viewer, Graphic Links in IPF and more.
This library adds more than a 100 new link types and enhancements to
the HLPDK package.
Please refer to the HDKLIB.DOC file for the library reference.
- Added HTML code generation, optimized for WWW access. With this new
and exciting feature HLPDK goes World Wide Web. HLPDK generates
HTML code ready to be used in a DISTRIBUTED hypertext database.
With HTML WWW readers available for Windows, Macintosh, Unix - Motif,
VMS and some other platforms, HLPDK sets the standard (yet again!)
for hypertext code portability!.
- Overview screen is defined as contents topic in Multimedia Viewer
from this version.
- Added .ACTION attributes to topics, in WINHELP and MULTIMEDIA VIEWER
targets. With these attributes an action can be performed when the
user enters the topic. You can for example start playing a WAV file
of narration, or music when the topic starts, or a Video AVI file
can be started.
- Added %n and %rX substitution operators to .USERLINK syntax. With
these new substitution operators, smarter and more complete HDF
extensions can be created.
- Fixed a small bug in the native help engines, that did not display the
last line of a short topic, unless it had a link in it.
- Added the .CONTENTS statement to the .HDF syntax. Use this statement to
change the initial (Overview) screen displayed by the help engines.
Because of this change the set file format has been expanded to include
the name of the contents screen.
- Topic Titles can have links in them, in WINHELP and Multimedia Viewer
targets. This can be used to have graphics, and formatted text in
topic titles in these targets.
- Added the .ROOTNODE and .ROOTPATH statements to the HDF syntax. Use these
commands to set attributes of the local node when creating distributed
hypertext databases. Please refer to the HELPC.DOC file for additional
information about these statements.
- Graphics with link modifiers will not create multiple bitmap references
in the project file of WINHELP and Multimedia Viewer from this version.
- Added conditional defines WWW and HTML when helpC is used with the
HTML target (/WWW).
- .USERLINK templates can now be enclosed in either double or single
quote characters. This way - multiple level quotes can be used in
WINHELP macro support.
- Added the .INSERT TOC statement to the .HDF syntax. With this command
it is easy to add an sorted Table Of Contents with hot-links to any
database. When you use this new feature, remember to use the new
helpC switch /TN+ . (If you do not, the compiler will terminate and
ask you to do that).
- Add OS/2 IPF paragraph text attributes support for bold, italic and
underline, using the :hpX tags.
*******************************************************************************
* Introduction *
*******************************************************************************
The Help Engine Development Kit is a system that allows you to create
hyper-text database help systems with topics and hot links, using a simple
text editor and the help compiler.
The help databases can be distributed (free of charge) with the HELPENG or
HE help engine display programs.
The help database format is release to the public domain, if you own the
Paradox Engine you can use the help databases with your own programs.
Borland Pascal Users can purchase the Help Engine Source Code even
for Applications that do not use the paradox engine, using the Native Mem
format.
The helpC compiler that is part of this development kit includes the
ability to create Windows Help source files from the same source the
DOS help sources are created!. Write your help once, and create help
databases for DOS, Windows, OS/2 and DESQview/X !
From the same source you created your hypertext database, you can create
a text document with automatic table of contents, glossary and index sections!
Using the RTF target you can prepare your professional documentation
by generating word processors documents, all from the same source!
Contact HyperAct, Inc. if you want to purchase the WINTEXT UI library for
Turbo Pascal programs, and use the help engine window in your PASCAL programs.
Features :
Topics, PopUps, Links, Keywords, Text Formats, Navigational and
Structural facilities, Target Code insertion, Multiple module files,
Automatic Pascal/C/C++ reference generation, Exception handling,
Multiple file target databases, Graphics, Sound, Groups, Application
Launch, Automatic exports creation, User defined link templates and more.
And from one source, You can create help databases to all the different
targets described above! "Write once, Help many!".
*******************************************************************************
* Setup *
*******************************************************************************
Copy the files in this package to a directory of your choice.
If you use windows, it is recommended to move the THANKS.WAV file to your
Windows directory. (Usually C:\WINDOWS or C:\OS2\MDOS\WINOS2).
*******************************************************************************
* Quick Start *
*******************************************************************************
From the command line enter HELPC HELPDEMO to compile the demo help database.
After the compilation process is ended, enter HELPENG HELPDEMO to browse the
demo help database.
If you want to compile for windows :
from the command line enter
HELPC HELPDEMO /W31
and after that
HC31 HELPDEMO
(HC31 is the Microsoft Help Compiler)
From windows, open the HELPDEMO.HLP file from the windows help engine.
Notice: if you do not have the HC help compiler from windows, we have
included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
able to feel the quality of the output that can be generated, and
decide if you want to purchase the HC31 program (Included with the
SDK, BC++, TPW, BP and probably some other packages), or download it
from one of the sites Microsoft had uploaded it to.
If you use windows 3.0, or want your help file to be compatible with
winHelp 3.0 use :
HELPC /W30 HELPDEMO
HC HELPDEMO
To compile for THELP use :
HELPC /TH+ HELPDEMO
HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
To compile for QuickHelp :
HELPC /QH+ HELPDEMO
HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
To compile for TVHC :
HELPC /TV+ HELPDEMO
TVHC HELPDEMO.TXT
To compile for POPHELP :
HELPC /PH+ HELPDEMO
MAKEHELP /Q HELPDEMO
To compile for DESQview/X :
HELPC /XD+ HELPDEMO
MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
COPY HELPDEMO.HLP d:\DVX\HELP
To compile for Native Mem Format :
HELPC /MT+ HELPDEMO
(Use HE HELPDEMO to view that database).
To compile for IPF (OS/2) format :
HELPC /OS2 HELPDEMO
Switch to an OS/2 session.
IPFC /INF HELPDEMO
(Use the VIEW Command to browse the database).
To compile for the Microsoft Multimedia Viewer 2.0 :
HELPC /MMV HELPDEMO
Open the MM VIEWER compiler (WMVC.EXE)
File|Open HELPDEMO.MVP
Compile (F5)
(Use the VIEWER2.EXE program to browse the database).
To create a HTML database for use with a WWW server :
Define the .ROOTNODE and .ROOTPATH of your server in the helpdemo source.
HELPC /WWW HELPDEMO
Copy the *.HTM files to the server's path.
To create a text document with table of contents, glossary and index :
HELPC /TXT HELPDEMO
To create a word processor document with table of contents, glossary and
index :
HELPC /RTF HELPDEMO
import helpdemo.rtf to your word-processor, and update fields.
(e.g. Microsoft WinWord : File|Open to open the document
Answer Yes to convert from Rich Text Format
Press F9 to update embedded format fields
somewhere in the first page (after the
Table Of Contents title), and in the last
page (after the index title).)
*******************************************************************************
* Operation *
*******************************************************************************
To start the help engine program enter HELPENG on the command line, and
choose the help database you want to view from the list box. Use the Tab key
to cycle between hot-link words, and press Enter to go to that link.
If you know the name of the SET file of the database you want to activate, you
can enter it on the command line, and the help engine will display it.
If you have a mouse, you can use it to point at the hi-lighted links, and
activate them by pressing the left mouse button.
Press the ALT-T key combination to choose from a list of TOPICS in the
database, Press ALT-B to go back to the previous displayed TOPIC, Press
ALT-X to exit the help engine.
The exit command can be given by pressing the right mouse button.
Use F10 to open the menu bar, and use the arrow keys to navigate the
options. When you find the option you are interested in, Use the Enter
key to execute it, or the Esc key to cancel. The menu bar can be navigated
using the mouse as well.
To create a new help database please refer to the helpC documentation
file.
If you want to use the Native Mem Format Databases, Please use the supplied
HE.EXE program.
*******************************************************************************
* Warranty *
*******************************************************************************
There is no warranty what so ever, The package is supplied as is,
The distributor (HyperAct, Inc.), or the author (Loewy Ron), are not,
and will not be responsible for any damages, lost profits,
or inconveniences caused by the use, or inability to use this package.
The use of the program is at your own risk.
By using (or attempting to use) the package you agree to this.
*******************************************************************************
* General *
*******************************************************************************
HLPDK is distributed by HyperAct, Inc., P.O.Box 5517 Coralville IA 52241, U.S.A.
HLPDK is (c) copyrighted by HyperAct, Inc., 1992, 93, 94.
HLPDK is a shareware program, please register your copy.
To register your copy of HLPDK please refer to the supplied HLPDK.REG file.
Other programs distributed by HyperAct, Inc. are described in the supplied
PROGRAMS.TXT file.
*******************************************************************************
* Contact *
*******************************************************************************
Please contact :
HyperAct, Inc.
P.O.Box 5517
Coralville IA 52241
U.S.A
E-Mail : Compuserve - 76350,333
Phone/Fax : (319) 351-8413
To contact the author directly please write to :
Loewy Ron
E-Mail : Compuserve - 100274,162
*******************************************************************************
* Trouble Shooting *
*******************************************************************************
If you receive some kind of an error message while using the help development
kit please refer to this section.
tableOps: xxxx error message :
This message is generated by the Paradox Engine if an internal error occurs,
if you receive a message that is not understood (e.g. Table is busy),
please try one of the following :
1. Try running the Help Compiler or the Help Engine with another input and
notice if the problem exists, if it does, turn to the next entry,
otherwise try to see what the difference between the inputs is.
2. Check your free memory, try to move some TSR's from memory, or use the
protected mode compiler/engine available with the registered version.
3. Check if you have loaded DOS SHARE program, it is advised to use SHARE
with programs that use the Paradox Engine. If you receive a table busy
error, try to see if you have another program that uses the same table
in another session (Windows/DESQview etc..).
4. PANIC - Please contact the distributor/author for additional help.
Microsoft's HC31 help compiler will generate a error in RTF file error :
1. Re-compile using helpC 4.0+. This should solve the problem, if the problem
still exists - please try steps 2 and 3, and notify the author.
2. Use a binary disk editor to look at the character at the position x - 1
in the RTF file (where x is the error position reported by HC31).
3. Try to replace that character from a special PC OEM character to a
"standard" ASCII character (such as *). If the problem still occurs,
please contact HyperAct, Inc./The author, otherwise - you probably came
across a character that HC31 can not handle. In that case - try using
HC300b (the one that generates winHelp 3.0 format), or delete these
characters from your source HDF file.
Borland's HL help linker will generate a FE02: Out Of Memory error :
1. Re-compile using helpC V3.0+, to include ;INDEX directives after the
screen's definitions.
Borland's HL help linker will complain about undefined context numbers :
1. You probably have a contents.h file in the current directory, that HL
tries to use to bind the help topics to Borland's IDE on-line help,
try renaming this file, and re-compile with HL.
helpC will not create the database when compiling to Native Mem (/MT+) :
1. Try compiling with report generation on (/R+) to Native Paradox
(/PX+) format. If there are errors, consult the HELPC.LST file, fix
them, and re-try.
2. If the database is BIG, you might not have enough memory - Remember that
Native Mem tables are generated in memory. You will have to use the
HelpCX protected mode compiler (Available with the registered version).
HelpEng/HE will complain on an old-database when trying to open a help
database with it :
1. Re-Compile the database using helpC.
HelpEng/HE will complain on un-supported database format, when trying to
open a database :
1. HelpEng can not display Native Mem databases, and HE can not display
Native PX databases. Use the other help engine supplied.
HE will not be able to open a Native Mem database :
1. Use the protected mode HEX help engine. (Available for registered users).
Where is HL - Borland's Help Linker :
1. HL is not included with Borland C++ or Borland Pascal, Borland sells an
additional package called Borland Open Architecture (and Borland OA for
Pascal) that include among other things - the THELP help linker.
We have encountered some users that ran into problems, because they did
not use the DOS SHARE program. We advise that you will always load the
SHARE program in your AUTOEXEC.BAT file.
*******************************************************************************
* Related Products *
*******************************************************************************
The following products/packages provide additional HLPDK functionality :
1. Name : IL2HDK - Interrupt List (Ralf Brown) 2 HLPDK convert program.
Version : 3.0, 3.1
Availability : IL2HDK30.ZIP. (Dos), IL2HDK31.ZIP. (OS/2)
Status : Free.
Author : Ron Loewy.
2. Name : HPCHDK - HelpPC 2 HLPDK convert program.
Version : 1.0
Availability : HPCHDK10.ZIP.
Status : Free.
Author : Yaniv Golan (s2942275@tech02.technion.ac.il)
3. Name : SCANHELP - Turbo Pascal Scanner to help.
Version : 3.13
Availability : SCANH313.ZIP (Contact Author)
Status : Shareware.
Author : Duncan J. Murdoch (dmurdoch@mast.QueensU.CA)
4. Name : NG2HDK - Norton Guides 2 HLPDK convert program.
Version : 1.0
Availability : NG2HDK10.ZIP
Status : Free.
Author : Ron Loewy.
5. Name : NEWSDB - usenet News Clips Hypertext generator.
Version : 1.0
Availability : NEWSDB10.ZIP.
Status : Shareware.
Author : Ron Loewy.
6. Name : POPHDK - POPHELP 2 HLPDK convert program.
Version : 1.0
Availability : POPHDK10.ZIP.
Status : Free.
Author : Yaniv Golan (s2942275@tech02.technion.ac.il)
7. Name : JARG2HDK - Jargon File to HLPDK convert program.
Version : 1.0
Availability : ? (Contact Author)
Status : ?
Author : Slren Pingel Dalsgaard (pingel@daimi.aau.dk)
8. Name : RC2HDK - Windows Resource File Help Template Generator.
Version : 1.0
Availability : RC2HDK10.ZIP.
Status : Shareware.
Author : Ron Loewy.
9. Name : CPFHDK - C++ FAQ 2 HLPDK convert program.
Version : 1.0
Availability : Contact author.
Status : Free ?
Author : Yaniv Golan (s2942275@tech02.technion.ac.il)
Currently under development : RTF2HDK, TPF2HDF, HDKEDIT and more ..
*******************************************************************************
* History *
*******************************************************************************
Version 1.0
- First Version, Written for TXS V3.0 help system,
as part of the WTGEN project, and generalized.
Version 1.1
- The Help Engine ALT-X (EXIT) command restores the screen
upon termination.
- Added /R switch for the helpC help compiler.
- From this version the helpC compiler can generate source
files for the Microsoft help compiler (HC) from the
SAME source .HDF). If the /w+ switch is specified,
the helpC compiler will create a .HPJ and .RTF files
to create the Windows .HLP file.
- Includes a compiled version of the help demo database for
Windows winHelp program. (View this if you do not have the
Microsoft HC Windows Help Compiler, to see the output that
can be generated with the helpC compiler, as a source to the
HC compiler).
Version 1.2
- Windows RTF files will now display special characters ({, }, \),
by prefixing them with the RTF over-ride character (\), when the
/W+ switch is given to the helpC compiler.
- helpC and helpEng were converted from TP6 to BP7.
- The help engine and help compiler use the Paradox Engine V3.0 from
this release. (No need to keep your old PXENGINE.OVL file anymore).
- Added the /W30 and /W31 switches to the helpC compiler. Use these
switches to set the output for the HC30 and HC31 Microsoft Windows
help compilers.
- The help window scroll bars are shown after a link is executed.
(A bug fix).
- Added "Trouble Shooting" section to this document.
- helpC and helpEng have DPMI versions to handle large projects.
(Available only with the registered version).
Version 2.0
- The help engine will display a new topic from the first line, and
not from the place that shows the current active link.
- The help window in the help engine program can now be scrolled to
regions of the help topic, that do not include the current, or
any link.
- A mouse click on a link, when the left-column is not 1 is recognized
as it should be.
- The helpC help compiler will recognize .TOPIC and .END-TOPIC as
topic declaration keywords, as well as the .ENTRY and .END-ENTRY
that were used until this version.
- The help topic table has a new field in it - the title field, using
this field you can specify the title of the help window, when it
displays a topic. Because of this field, databases created with
older versions of the help development kit will have to be
re-compiled. (Please refer to HELPC.DOC).
- The helpC help compiler will accept .TITLE keyword after the
.ENTRY (.TOPIC) line, to define a title to a topic window.
- Added support for Microsoft Quick Help sources, and Borland THELP
sources generation.
- The helpC compiler will translate ~~ in the source help definition
into a ~ sign in the help database. (In versions 1.x you could not
include the ~ sign in your help output text).
- The help engine will except ALT-B as the go-back short-cut - to
display the previous help screen.
Version 2.1
- I received several complaints that the HC31.EXE winHelp help compiler
does not work, and aborts at a specific place (byte 0x122) on the
RTF file created by running HELPC /W31 HLPDK. It seems that for some
reason the HC31 compiler is not able to process all of the ASCII
characters. The É character that appeared in byte offset 0x121
caused the HC31 compiler to abort. I do not know why this is
a problem, I will try to investigate, and if I can not come with an
answer - I will try to contact Microsoft (hey folks - they wrote it)
and find out. In the mean while - the HLPDK.HDF file provided with
this package - can be compiled by the HC31 compiler.
- I have noticed that not all of the .HL files generated for THELP
users work. I must admit I can not find the reason, I will continue
to investigate. I must admit it looks like a problem with the HL
documentation I have. In the mean while - please continue to
investigate the help development kit, and inform me of any
other problems you face with it.
- You can contact me (NEW NEW NEW) on my NEW (did I say that ..)
Compuserve Address : 100274,162
from Internet that is : 100274.162@compuserve.com .
Please send any enhancement requests, bug reports or other things -
I'm currently in the process of planning the next major version,
and any input will be helpful.
- QH (QuickHelp) files will now display backslash characters that
appear in the source file, by pre-fixing them with the over-ride
character (\), when the /QH+ switch is given to the helpC compiler.
- QH (QuickHelp) links will now be visible, even when they are not
hi-lighted. These links will appear in BOLD face, by using the \b
bold source command.
- For people interested in the HC help compiler - If you do not have
it in your development package (I was told that visual basic
standard edition does not include it), you can download the
3.0b version from CICA, in the WinWord directory.
- NEW - Added TVHC Support - Use the /TV+ switch to create TVHC sources,
that you can compile using your version of TVHC (PASCAL or C++).
Version 3.0
- The THELP code generation was improved to support HL v6.10 that
comes as part of the Borland Pascal Open Architecture package.
Because of this change the following things should be noted :
1. The source screens include a ;INDEX directive, so HL will
not abort on FE02: Out Of Memory errors.
2. A new dummy screen that is needed for Borland Pascal IDE
is generated as the first screen in the source .HL code.
You MUST compile the generate code using HL's -e switch,
specifying a number which is bigger then 1. HL will always
issue one error message - that screen DUMMY is not referenced,
this error should be ignored, the resulting .TPH/.TCH file
will be a valid THELP and IDE help file.
3. HL V6.0 should still work, with better results, because the
Out Of Memory errors should be eliminated as well. (Do remember
to use the -e switch with a value > 1).
- The .TITLE directive cause titles to be generated for THELP
source now.
- Added the .LINKCOLOR and .LINKHIGH commands in the Help Definition
File (.HDF) - that set the color of links in "normal" and
hi-lighted states. This feature is relevant only when compiling
to native paradox engine (Help Engine) format.
- Added the .INCLUDE commands to the .HDF specifications. Use this
help definition file command to create complex help projects that
are composed from multiple .HDF source files.
- The helpC program will abort with an error message if no .end-topic
command was supplied to the last topic in a .HDF file.
- Added the ALT-T Topic Index command to the Help Engine. Use ALT-T
to display and choose from a list of all the topics in the help
database. For ease of use the topics are displayed with their titles.
- Upon user's request - The ALT-X command will not have to be confirmed
by a TAB in order to exit the Help Engine.
- Added support for the Search facility of winHelp V3.x. From now on
the search button of windows help engine will display the list of
topic titles available in the help database.
- Added the .FIXEDFONT command to the HDF syntax - use this command
to set the font used in the generated RTF file for winHelp V3.x
to a fixed font. (By default a proportional font is used). If you
find that your help databases are not aligned after they are
converted to winHelp format, use this command and re-compile.
This command has no effect on targets that are different from
windows winHelp formats.
- The helpC compiler was converted to perform multiple passes on the
input data, if these passes are needed.
- The maximum topic name length was expanded to 40 characters - this
means that V2.x help databases will have to be re-compiled for
this version.
- Maximum Text displayed for a link was expanded to 60 characters.
- The ALT-B HelpEng command has been enhanced to return to the position
viewed last.
- Added PopHelp Source Generation. Use the helpC /PH+ parameter to
create source that can be used by TurboPower Software's makehelp
program - to create a PopHelp .HLP file.
- When generating code to winHelp source format, the helpC compiler
will issue a warning when an illegal HC link (topic) name is
found, and will automatically convert this identifier to a name
that is supported by the HC compilers.
Version 4.0
- Help Source Generation is much faster in this version, when the
target is NOT the native format, and no Report is generated.
In this case, helpC storage requirements will be much
smaller as well, because no paradox topic and link tables will
be created during the compile phase.
Please notice that if PopHelp is the target, a temporary paradox
table will still be created, during pass 1 pre-processing, pass 2
however, will be much faster than what it was before.
Compiling the HLPDK source on my 33MH 486 computer using
HELPC HLPDK /w30 /r-
takes 1.76 sec. in V3.1 Vs. 5.23 sec. in V3.0.
- Added the .PARAGRAPH .. .-END-PARAGRAPH paragraph markers in the
topic text section of the .HDF language. Use this feature to
create long paragraphs that will be wrapped as one paragraph when
the help window is re-sized by the user. This feature is currently
supported for winHelp code generation only.
Please refer to the HELPC.DOC file for further discussion of this
text formatting feature.
- Updated To Paradox Engine 3.01.
- For easier development the .TOP and .ENDTOP commands are equivalent
to the .TOPIC and .END-TOPIC commands.
- If no data file name is given to the helpC compiler, the set name
with target specific extension is given instead of the default
name given in previous versions.
- If the help topics and link names are not specified, names that are
derived from the set name are given in this version, instead of the
default names that were given in previous versions.
- Added support for long topic names, that include spaces in them.
Please refer to the HELPC.DOC file, regarding the /ST switch.
- Added DESQview/X code generation support. Please refer to the
HELPC.DOC File for the /XD+ helpC Switch. In order to compile
the generated source you will have to use MDVXHELP, by
Daniel J. Bodoh, that can be found in the file DVXHLP10.ZIP in
the DV-X directory on SIMTEL20, and probably some other places
on the Internet, and other networks.
- When generating code to THELP source format, the helpC compiler
will issue a warning when an illegal HL link (topic) name is
found, and will automatically convert this identifier to a name
that is supported by the HL compiler.
- Added the .PCFONT command to the HDF syntax - use this command
to set the font used in the generated RTF file for winHelp V3.x
to a terminal font. (By default a proportional font is used).
If you convert your help database that uses PC special characters,
and you want to preserve these characters in the windows version,
use this statement.
This command has no effect on targets that are different from
windows winHelp formats.
- When compiling to winHelp format, character with ordinal number
bigger than 127 will be translated using the RTF override
mechanism. The "Famous" HC31 problem is over.. . (This solution
was offered by Mr. Lars Fosdal.)
- When generating to winHelp Target, TAB characters are translated
to RTF \TAB commands. For other targets no TAB translation is
performed. It is advised that you set your editor to fill spaces
when a tab is inserted.
- Added the /CS switch to the helpC compiler. Using this switch
topics and links can be set to be case sensitive. It is not advised
to use this switch, unless you want to create lower case indexes
in a help engine such as PopHelp or THELP. Please notice - setting
this switch to ON (+) can break help databases that used to compile
fine. Use With Care!. (By default case sensitivity is set to off).
- The HELPENG help engine can now handle topics with up to 500 lines,
vs. 125 in the previous version.
Version 5.0
- The helpC compiler will convert illegal winHelp 3.1 (HC31) characters
in titles to spaces. The previous version corrected only body text,
but did not detect illegal titles.
- When THELP (HL) is the target, The OVERVIEW topic will be renamed to
Index - This is the name that MUST be attached to ;MainIndex screens
in THELP, if we want the IDE to display them as the main index.
- The helpC compiler will look for a configuration file called
HELPC.CFG in the current directory, and if it finds one will process
the switches in this file before any other command line switches.
- Control Characters (ASCII < 32) are not acceptable by HC31 as well,
helpC will now create the RTF over-ride for these characters as
well.
- Reports use virtual memory tables for cross reference manipulation,
so compile with report generation is faster. On my 486-33 computer
compiling HELPC HLPDK /W31 /R+ took 11 sec. in the previous version
Vs. 5 sec. only in this version.
As a side effect - the compiler will not create the helpct* temporary
tables.
- During Pass 1 of PopHelp and DV/X source generation - a temporary
memory table will be used instead of a paradox table in previous
versions. Code generation will be both faster, and will not require
disk space for these targets. On my computer HELPC /R- /PH+ HLPDK
takes 2.32 sec. Vs. 3.24 sec. on the previous version.
- Added the .TEXTCOLOR command to the HDF syntax. Use this command to
set the value of the text color. This command is supported only
in the Native help format target.
- Added The menu-bar to the helpEng help engine program.
- The helpEng program can display multiple help windows.
- Added the ability to save and print a help topic from within the
help engine.
- Fixed a bug in the cross reference report that was cutting long
link names, and report on errors that did not exist.
- A NEW Optimized Native help database format is introduced with this
version. The new Native Mem format uses Fast, Optimized code with
memory based indexes to display help faster, and with less
distribution overhead. The HE.EXE Help Engine supplied with this
version is smaller in size than HELPENG.EXE, because it does not have
the Paradox Engine in it. The Help Databases Generated are smaller,
because the format is simple RAW Binary representation of the
data structures handled in memory by the help engine.
- The helpC compiler now supports the /MT+ switch to generate the
new Native Mem Format.
- The Help Engine Source Code is now available to registered users,
(for additional cost) for the New Native Mem Format.
- The Native Paradox Based format is still supported in this version,
and should be used to handle Huge help databases that will not fit
into memory, or to support PAL/ObjectPAL help applications from
within Paradox/Paradox for Windows. Use the helpC /PX+ switch to
generate code to this target. The HelpEng.EXE help engine is supplied
with this package as well.
Version 6.0
- The helpEng and HE help engines will not terminate abnormally when
the Print or Save Topic commands are given with an empty desktop,
the help engine will issue a warning message and continue instead.
- The Help Engines will restore the initial text cursor size upon
termination. This was noticed by Prof. Timo Salmi of Vaasa, Finland.
- Added the Navigate menu to the help engines. Use this menu's entries
to navigate the help database - choose from the overview screen,
and index entries.
- Added keyword support to help databases using the .KEYWORDS help
definition file syntax. Use this command to add multiple indexes,
or search by keywords to your help databases.
In this version of the helpC compiler, Native (/PX+, /MT+), winHelp
(/W30, /W31) and THELP (/TH+) sources support the keywords defined
for topics.
Please refer to the HELPC.DOC file for a formal discussion of this
feature.
- The set format file has been changed to support the keyword
tables, old databases will have to be re-compiled for use with
the help engines.
- Added the ALT-S (Search command) to the help windows in the HELPENG
program. Use this command to search on the keywords defined in the
help database.
- Added OS/2 IPF source generation. Use the /OS2 switch of the helpC
compiler to generate code to the OS/2 IPFC compiler. Paragraph
support (.par .. .endpar/.paragraph .. .end-paragraph) is available
in this target as well.
- The number of input lines displayed as processed by the helpC compiler
include the actual number of input lines in the source HDF file, vs.
topic text lines only in the previous version.
- helpC error reporting has been improved to include the line number
the error occurred on.
Version 7.0
- The helpC compiler will perform RTF overrides in topic's names
from this version. In previous versions if you had a character that
had to be overridden in a topic name, hot links could not access it,
because hot-links were overridden with a prefix '\' character, while
topic names were not.
- Added the /WD switch to the helpC compiler. If you do not want to see
the information about topics and links that were translated in order
to be compatible with the target source, turn Warning Display to Off
using /WD-
- Added Conditional Defines to the compiler. Use the Conditional
define statements (.ifdef/.ifndef/.else/.endif) to compile different
parts of your source according to different defines. Please refer
to the HELPC.DOC file for a complete discussion of this important
feature.
- Added the /TXT switch to the helpC compiler. Use this switch to
create a text document with page breaks, headers and footers from
your input source .HDF file. With this option the helpC compiler
allows you to create both on-line help and printed documentation
from the same source!
- The /TXT format creates a Table Of Contents and Index files as
well that you might want to print with your text document.
- The Cross Reference Report format was improved to be displayed in
80 columns. Link Error lines have been improved to include the
link name for quick error diagnostic. D.J. Murdoch is the man
that suggested these enhancements.
- The title string in the topics table has been expanded to 70
characters. This was done to allow longer titles in /TXT /PX+ and
/MT+ targets. Old Native help databases will have to be re-compiled.
- The help engines will be able to display topics of up to 16K lines,
vs. 500 only in previous versions.
- The topic's title will be seen in winHelp's secondary (Go To) list
box of the search function, instead of the topic name that was used
in previous versions. Thanks for D.J Murdoch that noticed this
bug of mine.
- Added .PAGELENGTH and .PAGEWIDTH statements to the .HDF syntax.
Use these statements to set the printed page size in /TXT targets.
- A bug in winHelp's HCP that does not parse the RTF \tab statement has
been over-ridden by helpC that replaces TAB characters with a RTF
group that contains the \tab character.
Version 8.0
- Added the /RM switch to the helpC compiler. If you set this switch
off (/RM-) the cross reference temporary tables will be created on
disk instead of in memory. The disadvantage is that the report will
be much slower, the advantage - you will need less memory for the
compiler. When you try to compile huge databases, and do not have
enough memory, use this option. (By default /RM is set to on /RM+).
- Native format databases include a new field - tType of 1 character
in the topics table. This character is needed to support different
types of topics. Databases from previous versions will have to be
re-compiled.
- Added support for advanced word processors with the helpC /RTF
switch. Use this switch to create a version of documentation
that can be imported, with smart formatting options, by word
processors that support the RTF format. (Such as Microsoft Word
for Windows, Word Perfect for Windows and Lotus AMI PRO). With the
introduction of this option - you can create help database to
multiple platforms, formatted text for "readme" computerized
documentation and professional word processor documentation from
the same source!.
- Added the .POPUP and .END-POPUP (.ENDPOP) commands to the HDF syntax.
Use these commands to define PopUp definition topics. PopUp
definition topics are used as glossary entries that the user can
consult to see a definition without losing the current position
in the topic he is reading. POPUP entries are supported in the
winHelp, Native Paradox and Native Memory formats. In the other
targets, the PopUp entries are used as regular topics.
- In the Text and RTF targets the PopUp entries will be converted to
a glossary file/chapter, You can add this file as an appendix to your
document file.
- Added a conditional define (NATIVE) when helpC /PX+, /MT+ targets
are chosen.
Version 9.0
- Added support for automatic group menu generation. Use this feature
to associate sets of topics to groups, and create menus of these
groups in different places.
- To support the groups functions, the .GROUPS and .INSERT GROUP
statements were added to the HDF syntax. Please refer to the
HELPC.DOC documentation for discussion of these statements.
- Improved character format control. From this version you can specify
text attributes on the paragraph start statement, to choose the
font, size etc. .. of the paragraph text. This support is currently
available to winHelp and RTF targets, in the other targets, these
attributes are ignored. Please refer to helpC documentation for
further discussion of this feature.
- Added the .SETFONT command to the HDF syntax. Use this command to
change or add new fonts to the font palette.
- Added the .TITLEATTR topic attribute to the .HDF syntax, use this
statement to define text attributes to the topic title. Please refer
to the helpC documentation about this feature.
- Added the .TITLEDEFAULTS statement to the .HDF syntax. Use this
command to set default attributes to all the topic titles. These
defaults can be over-ridden with the .TITLEATTR statement described
above.
- Added the .INSERT CODE and .END-CODE statements, use these statements
to insert target code in your .HDF sources. Code inserted between
these 2 statements is sent to the output file with no translation
by helpC.
- Replaced the helpC /D, /L, /H and /K switches with /ND:, /NL:, /NT:
and /NK: - The new switches were needed because of the number of
options that should be specified on the command line, as well as
the fact that they are easier to remember now.
- Added the ability to define a conditional define on the command
line of the helpC compiler, using the /D: switch.
- Added the .ATTRDEDAULTS statement to the .HDF syntax. Use this
statement to set the default paragraph attributes. Please refer
to the HELPC.DOC file for documentation on this function.
- If no default font or attribute is set in the winHelp and RTF
targets Times New Roman is the default font vs. Tms Rmn in previous
version.
- Added the .EXT-TOPIC topic definition statement. This statement
defines a topic (like the other topics defined with .TOPIC/.ENTRY
etc..), and also creates an external reference to that topic to
be called from an external program.
- Added the /ED= switch to the helpC command line. /ED=P (Default)
creates the external definitions (if any) in a PASCAL unit format,
/ED=C creates the external definitions in a C/C++ header file.
- Added the DOCUMENT conditional define if /RTF or /TXT attributes
are set. This way you can easily set document text for both targets.
- In PopHelp (/PH+) target, the !INDEX directive is added, so topics
are ordered in the main index file in the order they appear in the
source HDF file.
Version 9.5
- helpC will ignore lines with Nulls in them from this version.
- Added C++ constants definition. Use the /ed=+ switch to create this
kind of external reference.
- helpC will notify of an error if a .PARAGRAPH is not closed at the
end of a topic.
- OS/2 IPF links are now generated with the res= attribute, instead of
the refid= attribute, so they can be compiled to .HLP and .INF files.
- Added error processing. Use the /EL=x switch, or the .ERRORLEVEL x
HDF command to set the error level. Using this feature the helpC
compiler can perform one of the following actions in cases of
non-existent links :
No Check - (Default) - No action is taken.
Trap - The link is replaced to a special topic named ERROR.
Strip - The link is replaced by the Text part only.
Delete - The text and link parts are deleted.
Abort - helpC will abort with an error message, indicating the
line number.
Please refer to the HELPC.DOC file for more discussion of this
feature.
- Added the .ALIAS command to the HDF syntax. Use this command to give
topics/PopUps alias names. This command can be very useful when
HLPDK is the target of an incremental compiler.
- Added PopUp support for the OS/2 IPF target. .POPUPs are translated
to :fn entries from this version.
- Added keywords support to the OS/2 IPF target. Topic Keywords appear
in the IPF index as level 1 indexes (:i1), with the topic titles as
level 2 indexes under them. (:i2).
- Group Names are 30 characters from this version, compared to 15 in
the previous versions.
- helpC handles long target lines better from this version. In previous
versions helpC could support only lines that were of 253 characters
long of target code. From this version helpC has a sliding output
buffer that allows longer target output lines.
- ALIGN text attribute command name fixed. (It was misspelled in
previous versions).
- The scroll box in the help engines was fixed to scroll correctly
when the downarrow and uparrow keys are used.
Version 10.0
- Multiple .KEYWORDS and .GROUPS lines are allowed from this version,
this is important when helpC has to compile files created by an
external program, such as NewsDB, that can create a lot of groups and
keywords for a topic.
- Added browse sequences support. Please refer to the HELPC.DOC
file that describes the .LIST attribute of topics that was added
to the .HDF syntax.
- Added Microsoft Multimedia Viewer support!, use the /MMV switch of
the HELPC compiler to create Viewer RTF and MVP sources. Please refer
to the Quick Start section in this document, and the HELPC.DOC file
provided, for additional Multimedia Viewer support documentation.
- Added the conditional define RTFBASE when compiling with one of the
following switches : /RTF, /W+, /W30, /W31, /MMV
- Fixed Line Spacing in OS/2 IPF target.
- Added Native Graphic support for winHelp, MM VIEWER and OS/2 targets.
Please refer to the Graphics Section of the HELPC.DOC document for
more information about graphic support.
- Added the .GRAPHIC statement to the .HDF syntax.
- Added multiple file target databases capabilities to HELPC. From this
version you can create links to external databases, and can create
huge projects with no size limit. Multiple file target databases are
currently supported in the winHelp, MM VIEWER and OS/2 IPF targets.
- Added the /FC+ switch to HELPC. Use this switch to force topic
collection even if error level is noChange (0).
- Added the /PP+ switch to the HELPC compiler. Use this switch to
pre process the file, and create an export file, to be used in a
multiple file target database.
- Added the .EXPORT topic attribute to the .HDF syntax. Use this
attribute to automatically create an export file, in a multiple
file target database (During a preprocess /PP+ target compile).
- Added the /EA+ (Export All) switch, use this switch to export all
the topics in the database, during a preProcess target compile
(/PP+ switch).
- Added the .EXTLINK statement to the HDF syntax. Use this statement
to define links in external databases. With this statement, You can
use HELPC to create multi file target database projects. .EXTLINK
statements can be automatically created by HELPC with the use of the
/PP+ switch. Please refer to the New Links section of the HELPC.DOC file.
- Added the PRP and PREPROCESS automatic conditional defines, when the
/PP+ switch is used with helpC (PreProcess target).
- Added the MULTI1.HDF and MULTI2.HDF multi file target database
example. You can compile with the demo MAKMULTI.BAT supplied.
- Added Native Sound support. Use the new .SOUND HDF command to define
sound objects, and create sound links. Sound support is currently
available in the winHelp and MM VIEWER targets.
- Added Native Application Launch links to the winHelp. MM VIEWER and
OS/2 IPF targets. With this feature help databases that start other
applications with a click of a mouse can be created easily.
- Added Conditional defines VIEWER and MM VIEWER when compiling for the
Microsoft Multimedia Viewer (/MMV).
- Add User Defined Links. With this important feature the HDF language
can be expanded without source code changes. This feature can be
used to create extension libraries to the HLPDK language and
compiler. Please refer to the HELPC.DOC file for additional
documentation on this feature.
- From this version Cross Reference reports are OFF by default, too
many people complained that helpC is very slow, and did not know that
using the /R- switch can speed helpC in a big way. If you want cross
reference reports, use the /R+ switch. If there is a need to use
the /R+ switch always, add it to the HELPC.CFG file in the current
directory.
- Add the .ROUTINE statement to the HDF syntax. Use this statement to
define external routines (in DLLs) to the help database. These
routines can be used with the User Links to extend the HDF syntax.
Please refer to the HELPC.DOC documentation for explanation of this
important feature.
- Added the .EMBEDD statement to the HDF syntax. Use this statement to
define files that will be embedded in the target help database. This
statement is supported in the winHelp and MMViewer targets.
*******************************************************************************
* Credits *
*******************************************************************************
HELPENG, helpC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
Paradox Engine 2.0, and Paradox Engine 3.0, 3.01 (Trademarks of Borland
International).
Windows, Microsoft, Multimedia Viewer, HC and Quick Help are trademarks or
copyrights of Microsoft Corp.
The HELPENG program was written using the WINTEXT UI library,
(c) 1991,93 Loewy Ron.
THELP, HL and TVHC are Trademarks or copyrights Borland International.
TVHC support, and other ideas were suggested by MunLeong Chan.
PopHelp is a copyright of TurboPower Software.
Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
CASE code generators.
Parts of the Help Compiler were generated using Ron Loewy's dbGen database
code generator.
Yaniv Golan helped me with beta-testing, debugging and suggestions.
He is also the programmer of the HPC2HDK program (available in an archive
site near you) that convert the HelpPC technical database to the Help
Development Kit format (The HelpPC database is a wonderful hypertext work by
David Jurgens).
John Murphy notified me of the paragraph formatting difficulties that lead to
the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
DESQview/X is a trademark of Quarterdeck Office Systems.
MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his excellent
documentation of DESQview/X help format to generate code to this environment.
The HC31 problem with characters with ordinal values bigger than 127
was solved thanks to Mr. Lars Fosdal of Norway.
OS/2 is a registered trademark of International Business Machines.
The Text Cursor restore problem in the help engines was reported by Prof.
Timo Salmi of the Univ. of VAASA, Finland.
D.J. Murdoch suggested the Cross Reference Report enhancements, and winHelp
Go To Search list box title problem.
Word for Windows is a trademark of Microsoft corp.
WordPerfect, WordPerfect for Windows are trademarks of WordPerfect corporation.
Lotus, AMI PRO are trademarks of Lotus corp.
Reuben Halevi from HyperAct, Inc. did a lot to make this product real.
Slren Pingel Dalsgaard notified me of the small scroll box bug in HELPENG, as
well as some spelling mistakes in helpC.