Contents
 HelpIT 1.1b

 HelpIT 1.1b

Copyright © 1994 by Mike Audleman

All Rights Reserved

** WARNING **

This is a BETA release and as such may contain bugs.  Although I have made every effort to find any bugs before making this release, it is impossible for me to personally test it under every possible operating configuration.

Please report any bugs or problems to me.  See the ABOUT page for addresses and phone numbers.  Thank you for trying HelpIT 1.1b!

Contents:

Overview

Command Buttons

Editing the Project File

Project File Sections

How to Map HelpContextIDs

About

Registration Form


Command Buttons
 HelpIT 1.1b

Click on the Buttons you would like information about:

Open a HPJ File

Save the HPJ File

Open a MAK File

Open  a RTF File

Run Compiler

Re-Order Help Context IDs

Window Size & Position

Copy a File


About
 HelpIT 1.1b

 HelpIT 1.1b

Copyright © 1994 by Mike Audleman

All Rights Reserved

Written and Conceived by Mike Audleman

This program is Shareware!

If you use past the 30 day trial period, you are REQUIRED to register it!

Registration is simple.  Send $25 us to:

Mike Audleman

P.O. Box 7732

Milwaukee, WI 53207

Contacting the Author

Registration Form

Contents


Contacting the Author
 HelpIT 1.1b

I am a registered user on Exec-Pc BBS and you may leave Email addressed to Mike Audleman.

To contact me via the FIDO net: address Mail to Mike Audleman at 1:154/280

Over Internet, send Email to wolfie@execpc.com


Help Project File Sections
 HelpIT 1.1b

HPJ File Section: OPTIONS

The HPJ file that is used by the Microsoft Help Compiler (HC31.EXE) is sectioned off similar to sections in an .INI file.  Each section begins with a section name enclosed in square brackets ( [ ] ).  The names of the sections are OPTIONS, FILES, BUILDTAGS, CONFIG, BITMAPS, MAP, ALIAS, WINDOWS, & BAGGAGE.  Of these sections, OPTIONS, FILES, BITMAPS, MAP, & WINDOWS are directly used by HelpIT.  The remaining sections are not modified or added by HelpIT and are purely optional.  None of the section names or entry member names are case sensitive ([FILES] is the same as [files] and [Files]).  The only case sensitive text in the file is text that is directly displayed like the Copyright notice or Title in the OPTIONS section.  The following is a list of the sections that HelpIT directly modifies:

1.	OPTIONS

2.	FILES

3.	MAP

4.	BITMAPS

5.	WINDOWS


Help Project File Sections:OPTIONS
 HelpIT 1.1b

HPJ File Section: OPTIONS

This section is automatically generated by a File, New command.

Modified or added OPTIONS:

ROOT	The Root directory to search for RTF files

BMROOT	Root Directory to search for Bitmaps included by reference

COMPRESS	Specifies the compression rate, NO, MEDIUM, HIGH

COPYRIGHT	Copyright notice placed in the ABOUT box

ERRORLOG	The filename to place error messages into at compile time

ICON	The filename that help displays when it is minimized

TITLE	The text that is placed on the title bar

HPJ File Sections


Help Project File Sections:FILES
 HelpIT 1.1b

HPJ File Section: FILES

This section is automatically generated by a File, New command.  This section contains the list of files that will be included in the finished HLP file.  The files in this section MUST be in RTF format.  Each file should be listed on a single line.  Each line should include a drive and path if the ROOT is not specified or if the file is in a different location than ROOT.  This section MUST contain at least one file but may contain more than one.

HPJ File Sections


Help Project File Sections:MAP
 HelpIT 1.1b

HPJ File Section: MAP

This section is automatically generated by a File, New command.  This section contains the list of  context mapping strings.  These strings specify a Topic Context and a numeric value that is the HelpContextID property of a VB Form or Control.  This section tells HELP what to display if the user of a program presses F1 when a control that has the HelpContextID value set.  This section is optional if no HelpContextIDs are set, however, if there are any, it is required.  A typical line might look like the following:

cmdRunCompiler	 10060 ; Menu mnuFileCompile

In this line, the Topic context "cmdRunCompiler" will be displayed if the user presses F1 while the File, Compile menu item is highlighted.  This assumed the programmer set the HelpContextID property to 10060.

HPJ File Sections


Help Project File Sections:BITMAPS
 HelpIT 1.1b

HPJ File Section: BITMAPS

This section is automatically generated by a File, New command.  This section contains the list of files that will be included in the finished HLP file.  The files in this section MUST be in one of the formats recognized by HC (BMP, DIB, WMF, SHG, MRB).  Each file should be listed on a single line.  Each line should include a drive and path if the BMROOT is not specified or if the file is in a different location than BMROOT.  This section is optional but may contain more than one file.

HPJ File Sections


Help Project File Sections:WINDOWS
 HelpIT 1.1b

HPJ File Section: WINDOWS

This section is automatically generated by a File, New command.  This section contains the list of  windows used in the help file.  This section is optional if only one window is used.  The lines in this section specify the location, Size, Non scrolling Area Color, and Client Area Color.  The format of the line is:

typename="caption",(horpos,vertpos,width,height),sizing,(clientR,G,B),(NonscrollingR,G,B),topmost

The sections sizing and topmost are NOT provided by HelpIT but may be edited by the user.  The remaining sections are provided by HelpIT and are completely adjustable by using the Window Size button.

HPJ File Sections


Overview
 HelpIT 1.1b

HelpIT is an interface or shell to the Microsoft Help Compiler (HC31.EXE).   Since I first started using the compiler, I was baffled as to the reason behind producing a DOS program that turns out Windows help files and I still am.  I always hated having to have WinWord open in one window, a DOS session open in another and notepad open in a third for the HPJ file and that cumbersome arrangement was the genesis for HelpIT.  No longer do you need to have a DOS session or Notepad, HelpIT does it all.  HelpIT allows you to directly edit a HPJ file, read and scan your VB MAK files, and even scans your source RTF files for subject contexts and bitmaps included by reference.   After scanning your files, all your resources are available in drop down combo boxes.  These boxes place the selected item into the clipboard for an easy paste into the HPJ text window.  A simple click of a button and the help compiler is called and it runs in the background so you can do other things including printing the resources or HPJ inside HelpIT.


Mapping HelpContextIDs
 HelpIT 1.1b

Mapping the HelpContextIDs has always been a pain for me but I think HelpIT really simplified matters.  HelpIT will format the lines correctly and even include the control/form type and name as a comment.  The following steps assume you have loaded or started a new HPJ file, have opened your VB MAK file and opened at least one RTF file.  Here are the general steps:

1.	Using the "RTF Contexts" combo box, select a context you wish to map to.

2. 	Position your cursor in the [map] section in the HPJ edit window and click once.

3. 	Either press Control-V or click the Paste button

 	Your context will appear in the HPJ edit window.

4. 	Using the "Help IDs" combo box, select the HelpContextID you want to map to this section.

5. 	Either press Control-V or click the Paste button

 	Your HelpContextID number will appear in the line and the description will be included as a remark

Repeat the above steps for each context and ID combination you wish to map.


Help Compiler
HC is a DOS program that produces a .HLP file that is usable by the Windows help engine.


Visual Basic MAK Files
MAK files are generated by many Microsoft language products.  Since I only have Visual Basic,  HelpIT  is designed to read that format.  If you would like further compatibility, please send me a MAK file and a TEXT FORM file for your language product and I will try to add it to the scan format.  HelpIT scans the MAK file for names of the forms (.FRM) and then looks in each of them for forms and controls that have HelpContextID set.


Rich Text File
.RTF or Rich Text Files are the source code for the help compiler.  There are several word processors that are capable of producing this format.  The file contains ONLY text hence it's name.


Help Compiler Project File
HPJ files are a collection of  commands and settings that the help compiler uses to produce the HLP file.  These settings tell the compiler what colors to use, where to place the window, the compression level, what bitmaps to include and what the text files are.  This can equate to the MAK file for VB or VC.


HPJ Text Edit Area
Enter the text of the HPJ file here.  The standard editing keys are available (Ctrl-C, Ctrl-X, Ctrl-V) or you may use the Cut, Copy & Paste buttons just above this window.  Also the print button will print the current text to the printer.  Instant access to the Insert Item menu is available by pressing the RIGHT mouse button while over this window.  When File, New is selected from the menu, this area is cleared to the basic headers.  For more information on what to place here, see the Microsoft Help Compiler (HC31.EXE) documentation.


Open RTF

  Open RTF opens a RTF file and scans it for various items including bitmap references and Topic Contexts.  The contexts are loaded into a combo box for instant access.  This function is accessed through the File menu and by clicking the Open RTF button on the toolbar.  If the selected file has already been opened, it is re-opened and re-scanned thus allowing you to actively edit the RTF file in your word processor and to access it here also.


Open MAK

  Open MAK opens a MAK file and scans it for .FRM files.  It then looks through all the .FRM files for any forms and controls that have the HelpContextID set.  These items are then loaded into a combo box for instant access.  This function is accessed through the File menu and by clicking the Open MAK button on the toolbar.


Open HPJ

  Open HPJ opens a HPJ file and places the text into the edit HPJ window.  This function is accessed through the File menu and by clicking the Open HPJ button on the toolbar.  If any text in the edit window is modified, the status bar at the lower right will have a yellow background and you will be prompted to save before opening a new file.


Save HPJ

  Save HPJ saves a HPJ file.  The text in the edit HPJ window is saved into the file.  This function is access through the File menu and by clicking the Save HPJ button on the toolbar.  If any text in the edit window is modified, the status bar at the lower right will have a yellow background.  This function clears this background.


Set Window Size

  This button loads an additional form for you to move around and to size.  The size and position of this form determines the location and size of the help window.  Additional buttons on the form include color settings for the client area & non-scrolling area, the name of the window and a window title.


Run Compiler

  This command calls  the Microsoft Help Compiler (HC31.EXE) to compile your help file.  The compiler will start in a minimized DOS icon and run there until finished.  During this time, you may continue to edit your files here or in other applications.  These changes, however, will not be accepted into the current compile session.  If you have not saved your current HPJ text, you will be prompted to do so before running the compiler.  This function is accessed through the File menu and by clicking the Run Compiler button on the toolbar.  HelpIT relies on you to have edited the HC31.PIF file to set the location of your HC31.EXE file.


Re-Order Context IDs

  This command brings up another window to automatically renumber all HelpContextId lines in your MAK and FRM files.  You may select an individual form or renumber them all.  You also may choose the starting number and the increment.  Using this command, you can put ANYTHING on the HelpContextID in VB and not worry about it.  For instance, you could number every one of them with the number 100 and then use the Re-Order to sequence them automatically.


Copy Files

  This command allows you to copy files around.  Since the help compiler puts the compiled HLP file in it's own directory, this will allow you to copy it to another directory.  Currently this command DOES NOT warn you about overwrites (future modification)


HelpContextID Property
The HelpContextID is a property provided by Visual Basic for each form and control.  It is a long integer and it's value is used in the MAP section of the HPJ file to reference a Topic Context for context sensitive help.


Editing the HPJ file
 HelpIT 1.1b

 Clipboard Keys & Print Button

Once you open or create a new HPJ file, the text is displayed in the HPJ text area.  Using cursor keys or mouse, you are free to move around the area Edit, type over, delete, cut, copy, paste etc.   The clipboard keys pictured above can also be accessed by using the keyboard.  The following keys are available for editing the text:

Editing:

Control-X	Cut Text to Clipboard {Cut Button}

Control-C	Copy Text to Clipboard {Copy Button}

Control-V	Paste From Clipboard {Paste Button}

INS	Toggle Insert/Overstrike

DEL	Delete text (not to clipboard)

SHIFT	Holding SHIFT while pressing a movement key highlights text

Movement:

PageUp	Move up one page

PageDown	Move down one page

Arrow Keys	Move cursor in respective direction

Home	Move to beginning of line

Control-Home	Move to beginning of file

End	Move to end of line

Control-End	Move to end of file


Registration Form
                 HelpIT 1.1b Registration Form

Name:_______________________________________________________

Address:____________________________________________________

City:____________________________ St:_______ Zip:___________

Country of other than US:___________________________________

Telephone Number (_____)-_____-________

Language Product you are using:_____________________________

     Version:_____________________________

Version of Windows:_________________________________________

Computer Make & Model:______________________________________

____________________________________________________________

Size of Hard Drive:_________mb     Modem Baud:______________

Your email address and network:_____________________________

Where did you get this Shareware copy of HelpIT?

____________________________________________________________

Suggestions & Comments:

____________________________________________________________

____________________________________________________________

To receive a disk with the latest version of HelpIT please

include an additional $5 for shipping and handling and check

the appropriate format box.

HelpIT 1.1b Registration(Site:10 copies)   $175__ X $_______

HelpIT 1.1b Registration	       $25 __ X $_______

HelpIT Latest Version   	       $ 5 __ X $_______

Diskette Format: 3.5:720k:__ 1.44m:__

Check one       5.25:360k:__ 1.20m:__

Sub-Total     	 	    $_______

___________________________________________________

Wisconsin Tax (WI Only) 5.5%	                $_______

Total Enclosed	 	    $_______

___________________________________________________

Send Check, Cash or Money Order to:

Mike Audleman

P.O. Box 7732

Milwaukee, Wi, 53207

Sorry, no Credit Cards or foreign money transactions.  All

checks, cash and money orders must be in U.S. funds or drawn

on a U.S. bank.

Bulk rate for site registration is available, write for details.