Copyright: ® Nic Barnes 1993 - Written with CreateHelp!


Auto Page Building

Use the Build Page feature to automatically build an index type page - the Features page was built using this function.

Pick the topic titles from a list gathered either from the DOC file or the DFN file or use a browse sequence range to define the group of topics then decide to create the page in the DOC or DFN files.


Summary Reports

Use the Summary Report feature to produce a list of each topic's tile, context Id, browse sequence number, keywords and Id number.  This is VERY useful for debugging or just keeping track of large project files.

Sample:

Title	Context ID	Sequence	Keywords	Macro	ID Number
WinHelp Macros	WINHELP_MACROS	050	WinHelp Macros; Macros		0008
User Macros	USER_MACROS	060	User Macros; Macros		0012


Compile Current Page

Use this feature to have a preview of what the page will look like in the compiled help file.  If the page to be defined is a pop-up then a page with the text 'Click Here' is created and clicking on this will display the selected pop-up.


Compile Project

With just one click on the toolbar or by selecting Tools Compile Project from the menus you can launch the help compiler to compiler the current project's HPJ file.

If a Contents page has not been set then you are prompted to select one from a list of available Context Ids.

On completion of compilation you are given the option to open the errorlog or to view your newly created masterpiece.


Inserting Definitions

Select some text and INSERT DEFINITION.  A context is guessed for the term selected, and you can enter the definition into the Input Box provided.

If the term has already been defined you can type the Context Id (if the guess is wrong) or search from a list of all available Context Ids.

If a reference already exist for the selected text you can delete the reference, change it, delete the referenced Context Id or both.


Inserting Graphics

This uses the common dialog box to select a graphic file to be inserted.  Takes you to the directory specified in the BMROOT section of the HPJ file.  The default filter shows MRB and SHG files, alternately BMP and WMF can be used as a filter or all files can be displayed.

Once a graphic file has been selected it can be inserted as a referenced file (left, right or with text justified) or as a Bitmap.

Sample:

Inserted Bitmap	Referenced Hypergraphic	Referenced Bitmap (Not MRB)

Note WinWord cannot import MRB or SHG files so these can only be referenced. Also that a referenced BMP file can be distorted at different resolutions.


Viewing the Error File

After compilation you are given the opportunity to open the error file defined in the ERRORLOG setting of the HPJ file.

If after compilation you wish to view the error file you may do so by using VIEW ERRORFILE from the menus.


Inserting Jumps

Select some text and click on the toolbar or select INSERT JUMP from the menus.

A Context Id is guessed for the link or you are given the option to search from all available Context Ids.


Inserting New Context
Inserting New Contexts

Click on the toolbar or INSERT NEW CONTEXT from the menus.

You are presented with a dialog box to enter all the options for a new context.  Options such as Auto Context, Non-scrolling title are presented as check boxes and are on/off as defined in Default Context Formats.

All the context details can be entered; Title, Context Id, Browse Sequence number, Keywords, Macros.  These can be entered here or added later using the EDIT CURRENT CONTEXT function.


WinHelp Macros

Build complex WinHelp macros by point-and-click selection of all built in macros.

Example:

Select some text

Click Insert Macro

Select CreateButton from the list

In the macro edit window enter the following

`ButtonId'=`HA_Btn'

`Name'=`&About'

"Macro" Click on the Insert Macro button and select About from the list or type About()

Click done and check that the macro reads CreateButton (`HA_Btn',`About',"About ()")

Click OK

Your macro is now referenced to the selected text.  You can create a DestroyButton macro in a similar manner

Demo	Creates a button that displays the HELP ABOUT box

Undo Demo	Destroys the  button


User Macros

Use RegisterRoutine to register external DLL's and then define a user macro to correspond to the new function.

Example:

Use Insert Macro to insert the following into the CONFIG section of the HPJ file

RegisterRoutine("MMSYSTEM","mciExecute","S")

Use Define User Macro to define the macro

mciExecute("Command")

Select the text required and Insert Macro - mciExecute("Sound SystemStart")

or if no text is selected the macro will be added to the CONFIG section of the HPJ file

Demo	Plays the sound file associated with System start up

This will play the system sound associated with System Start (This will not work unless you have a suitable driver installed)


Secondary Windows

Use the Edit HPJ [Windows] function to create a secondary window, use the default settings or set your own.

Example:

Edit HPJ [Windows]

Window Name=W2_WND

Caption=Secondary Window

accept the defaults

Select some text

Insert Jump

SW_DEMO>W2_WND

Demo	Creates a secondary window

Undo Demo	Reopens features window


CreateHelp! v2 Features

Auto Page Building

Compiling the Project

Context Editing

Default Context Formats

Finding and referencing Jumps and Definitions

HPJ Config Section

HPJ Files Section

HPJ Map Section (Header File)

HPJ Options

Inserting Definitions

Inserting Graphics

Inserting Jumps

Inserting Macros

Inserting New Contexts

Printing Source Files

Project Pre-Compilation

Secondary Windows

Summary Reports

User Macros

Viewing the Current Page

Viewing the Error File

WinHelp Macros


Obtaining CreateHelp! v2

CreateHelp! version 2 will be available from May 4th 1993

After this date it should be available from the following sources as CH2xx.ZIP

CompuServe:	MSBASIC

WINSDK

MSWORD

UKSHARE

Public Software Library

Compulink Information eXchange

and most respectable BBSs and Shareware libraries.

CreateHelp! is shareware.  You are given a 30 day evaluation period.  Thereafter if you continue to use it you must register.

Registration is $40, available by

On CompuServe, GO SWREG, product 791

Cheque or Postal Order to the author

Visa/Master Card by arrangement


Contacting the Author

If you have problems obtaining your copy of CreateHelp! or have any other queries, contact:

Nic Barnes

CHC Software

27 West Park

London SE9 4RZ

ENGLAND

or by eMail to

Nic Barnes @ CompuServe 100111,3452


Contents

CreateHelp! was born out of the need for a good, easy to use help file authoring tool.  There are other tools available, but the good ones are very expensive, and the cheap ones aren't very good.  CreateHelp! is intended to fill that gap.

The initial release of CreateHelp! enjoyed a very favourable response, and because of support from its users has now evolved into a much more powerful second version.

CreateHelp! v2 features

Obtaining CreateHelp! v2

Contacting the Author

This file contains a demo of all the features supported in CreateHelp! v2.  The source files are included in CH2xx.ZIP

CreateHelp! is Copyright © Nic Barnes 1993


This is some text displayed in a secondary window

Close Window


 Context Editing - Use the toolbar button or EDIT CURRENT CONTEXT to change the Context Id, Browse Sequence number, keywords and more


Default Context Formats - Use this to set the preferences for INSERT NEW CONTEXT - Auto Context guessing, Non-Scrolling Title, Auto Keywords, Use Styles for formatting and more


Finding and referencing Jumps and Definitions - Use this extended EDIT FIND to reference a Jump or Pop-up the found text


HPJ Map Section (Header File) - Easily see the context mapping (contained in the header file) and edit or add new Id Numbers (if not already done with INSERT NEW CONTEXT)


HPJ Options - Set all the project options in a clear and simple dialog box


HPJ Config Section - View, edit or delete macros in the Config section.  Macros are added using the INSERT MACRO function


HPJ Files Section - Add or delete files from the Files section


Inserting Macros - See WinHelp Macros


Project Pre-Compilation - Use this to export project files as RTF for addition to another project


Printing Source Files - If you wish to print your source files you are given the option to remove the hard page breaks temporarily whilst printing - thus saving paper.


MRB - Multiple Resolution Bitmaps, generated with the Microsoft MRBC


SHG - Hypergraphics bitmaps, created with Microsoft's SHED


HPJ - the project file containing all the compilation options


DOC - this is WinWord format document used by CreateHelp! to store all the main topics.  It is converted to RTF at compilation time


DFN - this is a WinWord format document used by CreateHelp! for storing all the definitions referenced in the main DOC file.  It is converted to RTF with the extension DEF at compilation time


CreateHelp! - HLP file authoring tool © Nic Barnes 1993


CH2xx.ZIP - the CreateHelp! v2 distribution archive where xx is the minor version number


Rich Text Format - the file format required for the Microsoft help compiler