Copyright: ® Nic Barnes 1993 - Written with CreateHelp!


Overview

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.

The features available include:

Automatic 'See Also' Button	*new*
Automatic outline building	*new*
Automatic page building	*new*
Automatic search and referencing	*enhanced*
Compilation of current page	*new*
Context name guessing	*enhanced*
Context Numbering	*new*
Default Context Formatting	*enhanced*
Full editing of HPJ file	*enhanced*
Multiple file support	*enhanced*
Report Generation	*new*
Secondary window definition	*new*
Support of WinHelp macros	*new*
User definable macros	*new*

A full demonstration of these features are available in the CH_DEMO.HLP file.  The source files are also included as CH_DEMO.*

CreateHelp! is distributed as Shareware.  You are entitled to use it for evaluation purposes for a period not exceeding 30 days.  Thereafter you MUST register or delete it and all associated files.


Installation

The CH2xx.ZIP archive should contain the following files:

C_HELP!.DOT	The CreateHelp! template
C_HELP!.HLP	The help file (this file)
INSTALL.DOC	The installation routine
CH_DEMO.HLP	The help file which demonstrates the features
CH_DEMO.HPJ	The project file for above
CH_DEMO.DOC	The DOC source file for the above
CH_DEMO.DFN	The DFN source file for the above
CH_DEMO.H	The header file for above
CH_DEMO.BMP	Sample bitmap file required for above
CH_DEMO.SHG	Sample hypergraphic file required for above
README.TXT	Release history, last minute release notes etc.

To install CreateHelp! - Open the INSTALL.DOC file contained in the CH2xx.ZIP archive.  This gives the full installation details.  Click on the INSTALL button and this will guide you through the installation process.


The Menus

File Edit View Insert Format Tools Table Window Help

File	Close Project	Closes all the open project files
	Print	Gives the option of removing the hard page breaks from the file.
Edit	Find...	Creates a jump or definition reference for found text
	HPJ [Options]	Edits the [Options] section of project.HPJ
	HPJ [Files]	Adds or deletes files from the [Files] section of project.HPJ
	HPJ [Windows]	Edits the [Windows] section of project.HPJ
	HPJ [Config]	Edits the [Config] section of project.HPJ
	Header File	Edits project.H
	Current Context	Edits most of the settings for the current context
View	Error File	Opens the errorlog defined in the [Options] section of project.HPJ  for viewing
Insert	Picture	Inserts a graphics file as a reference, or as a bitmap
	New Context	Inserts a new context
	Definition	Inserts a definition reference to the selected text and definition if it doesn't already exist
	Jump	Inserts a jump reference to the selected text
	Macro	Inserts a referenced macro if text is selected or adds a macro to the [Config] section of project.HPJ
Format	Context Defaults	Set the options for Insert New Context and definition separator character
Tools	Pre-Compile	Exports the current project as rich text formatted files.
	Compile Current Page	Compiles the page containing the insertion point and loads it into WinHelp
	Compile Project	Compiles the entire project
	Define User Macro	Defines a user macro for inclusion in the Insert Macro list
	Build Page	Builds an 'index' type page from a pick list or a browse sequence range
	Summary Report	Generates a report of all the context IDs in the project.DOC file
	Launch SHED	Launches the MS Hypergraphics Editor
	Launch Help File	Launches the HLP file associated with the current project
	Setup CreateHelp!	Main setup options
Help	CreateHelp! Index	Shows the index page of the CreateHelp! help file
	Register	Enter registration details to disable 'nag' screens
	About CreateHelp!	Displays the version number, registration status etc.


The Toolbar

	Insert New Context	Inserts a new context
	Edit Current Context	Edits most of the settings for the current context
	Build Page	Creates a contents type page from the options selected.
	Insert Definition	Inserts a definition reference to the selected text and definition if it doesn't already exist
	Insert Jump	Inserts a jump reference to the selected text
	Insert Macro	Inserts a referenced macro if text is selected or adds a macro to the [Config] section of project.HPJ
	Insert Picture	Inserts a graphics file as a reference, or as a bitmap
	Launch Shed	Launches the MS Hypergraphics editor
	Launch Help	Launches the HLP file associated with the current project.
	Compile Current Page	Compiles the page containing the insertion point and loads it into WinHelp
	Compile Project	Compiles the entire project


File Close Project

Closes both the project.DOC and project.DFN files


File Print

After setting the print options from the standard File Print dialog box the user is given the option to remove the hard page breaks from the file.  This is useful for conserving paper.

If YES is selected then the file is saved, the hard page breaks are removed and then the file is re-opened.  Thus preserving the original formatting.


Edit HPJ Options

Allows direct editing of the [Options] section of project.HPJ


Edit HPJ Windows

Enables a secondary window to be defined or an existing window to be edited.


Define Window

Sets secondary window characteristics


Edit HPJ Files

Allows the selection of files to be added or deleted from the [Files] section of the HPJ file.

Files must be in the project directory and already in rich text format.  To convert a pair of project files use the TOOLS PRE-COMPILE function.


Edit HPJ Config

Edits the lines in the project.HPJ [Config] section.

Use this to delete start-up macros. To add start-up macros use the INSERT MACRO function with no text selected.


Edit Header File

Adds or deletes context numbers from the project.H file.


 Edit Current Context

Gets the contexts details for the page containing the insertion point and allows editing of most of the details.

Context Number must be edited with EDIT HEADER FILE

Macros must be edited with INSERT MACRO


View Error File

Opens the file defined in the ERRORLOG line of project.HPJ [Options].  This will generate an error if the project has yet to be compiled.


 Insert New Context

Inserts a hard page break followed by the footnote references for the details that have entered.


 Insert Definition

References a pop-up to the selected text.  A context is given for the selected text or one can be selected from a list of available contexts.  The user is prompted to enter the definition which is then inserted into the DFN file using the fonts selected with definition titles and definition body and the separator defined.

If there is already a definition associated with the selected text then either the reference, the definition or both of these can be deleted.


 Insert Jump

References a jump to the selected text.  A context ID can be entered or all contexts can be listed for selection.

If a jump reference already exists then this can be edited or deleted.


 Insert Macro

If text is selected then a macro can be referenced to the selected text.

If text is not selected the user is given the option to insert a macro in the [Config] section of project.HPJ or to edit a footnote macro.

Macros are built from a list of internal macros and user defined macros.  If required parameters must be entered in the textboxes provided.  Where the parameter is a context or macro then buttons are provided to select these from a pick list.

Note no syntax checking is done.  Inserting macros more that 5 deep will cause an 'Out of Memory' error.


Format Context Defaults

These options set the defaults for all New Contexts.


Tools Pre-Compile

Saves the current project in rich text format.  This is necessary before files can be added to another project.


 Tools Compile Current Page

Compiles the page containing the insertion point and loads it into the WinHelp engine.

If the insertion point is in a definition then a page is created with the text "Click here" and clicking on this will display the selected pop-up.

Note If there are jumps or definitions defined on the page then compilation errors will be generated as these pages are not compiled.  The feature is provided to give an idea of what the page will look like in the finished help file.


 Tools Compile Project

Compiles the current project using the selected compiler.

When compilation is complete the error file may be viewed or the help file loaded into the help engine.


Tools Define User Macro

Allows the user to define custom macros, these can be either frequently used macros or external functions defined with RegisterRoutine.

Each parameter must be entered into the text boxes provided to a maximum of six.  If the parameter contains the text 'ContextId' or 'Macro' a button will be provided in the insert macro dialog box.


Tools Setup CreateHelp!


Tools Summary Report

This is SLOW but VERY useful.  It generates a report of the current project listing Title, Context ID, Browse Sequence, Keywords, Macros and ID number.

Once the report is generated the user can manipulate it as wished.

Note The report is based on the NORMAL template and the CreateHelp! functions are not available until a project file is switched to.


Help CreateHelp! Index

Takes you to the contents page of this file.


Help Register

Use this to enter your registration details - as provided by CHC Software


Help About

Displays a dialog box containing the version number and registration details


Shareware Agreement

You are hereby licensed to:  Use this software for a 30 day evaluation period; make as many copies of this software and documentation as you wish; give exact copies of the original to anyone; and distribute the software and documentation in its unmodified form via electronic means.  There is no charge for any of the above.

You are specifically prohibited from charging, or requesting donations, for any such copies, however made; and from distributing the software and/or documentation with other products (commercial or otherwise) without prior written permission.


Registration

This product is Shareware and its continued development can only be supported by YOU!  This license allows you to use this software for evaluation purposes without charge for a period of 30 days.  If you use this software after the 30 day evaluation period a registration fee is required. One registered copy of CreateHelp! may be used by a single person who uses the software on one or more computers or to a single workstation used by multiple people.

The Benefits

The 10 minute Nag messages will be removed immediately upon registration

You will be advised of updates and other products available

The Cost

UK£20.00

US$40.00

The Methods

Snail Mail by Cheque or banker's draft.

GO SWREG on CompuServe, Product 791

VISA/Master Card by arrangement


Contacting the Author

By eMail @ CompuServe 100111,3452

By Snail Mail:

Nic Barnes

CHC Software

27 West Park

London SE9 4RZ

ENGLAND


Disclaimer

This product is provided "as is" without representation of warranty, either expressed or implied.

The entire risk as to the use of this product is assumed by the user.  In no event will Nic Barnes or his estate be liable for any damages direct, indirect, incidental or consequential resulting from any defect in the product.

If you do not accept these terms you must cease using this product forthwith and destroy the program, the documentation and all copies thereof.


Copyright

These programs and the related documentation are copyright. The sole owner is Nic Barnes. All rights reserved. You may not use, copy, modify, or transfer the programs, documentation, or any copy except as expressly provided in the shareware agreement.

© Copyright Nic Barnes 1993.


The Shareware Concept

Shareware is copyrighted software that is distributed by authors through bulletin boards, on-line services and disk vendors.

Shareware allows you to try the software for a reasonable limited period.  If you decide not to continue using it, you throw it away and forget about it. You only pay for it if you continue to use it. Shareware is a distribution method, not a type of software. You benefit because you get to use the software to determine whether it meets your needs, before you pay for it.

The shareware system and the continued availability of quality shareware products depend on your willingness to register and pay for the shareware you use. It's the registration fees you pay which allow authors to support and continue to develop our products. Please show your support for shareware by registering those programs you actually use.


Registration Form

Print Form

I have found CreateHelp! v2 useful and wish to continue to use it.

I enclose payment of  UK£20.00 / US$40.00* made payable to Nic Barnes

*delete as applicable

Name:
Title:
Company:
Address:
City, State
Zip/Post Code
Country
eMail address
Where did you obtain this product from?
Please send to:	Nic Barnes

CHC Software

27 West Park

London SE9 4RZ

ENGLAND


Contents
CreateHelp! Contents

Overview Installation Starting a New Project The Menus The Toolbar Keyboard Shortcuts	Shareware Agreement The Shareware Concept Disclaimer Copyright Registration Registration Form Contacting the Author
Acknowledgements


The Keyboard
Keyboard Shortcuts

Edit	HPJ [Options]	CTRL+SHIFT+O
	HPJ [Files]	CTRL+SHIFT+F
	HPJ [Windows]	CTRL+SHIFT+W
	HPJ [Config]	CTRL+SHIFT+G
	Header File	CTRL+SHIFT+H
	Current Context	CTRL+SHIFT+X
View	Error File	CTRL+SHIFT+V
Format	Context Defaults	CTRL+SHIFT+E
Insert	Picture	CTRL+SHIFT+P
	New Context	CTRL+SHIFT+C
	Definition	CTRL+SHIFT+D
	Jump	CTRL+SHIFT+J
	Macro	CTRL+SHIFT+M
Tools	Pre-Compile	CTRL+SHIRT+L
	Compile Current Project	CTRL+SHIFT+C
	Compile Project	CTRL+SHIFT+P
	Define User Macro	CTRL+SHIFT+U
	Build Page	CTRL+SHIFT+B
	Summary Report	CTRL+SHIFT+R
	Launch SHED	CTRL+SHIFT+N
	Launch Help File	CTRL+SHIFT+I
	Setup CreateHelp!	CTRL+SHIFT+S


 Build Page

Enables the user to build a contents type page from the project.DOC and project.DFN files


 Launch Current Help File

Launches the HLP file associated with the current project.  This will generate an error unless the project has been compiled or if the file has been re-compiled since last loaded by WinHelp


 Launch SHED

Launches the MS Hypergraphics editor - SHED.EXE If installed.


 Insert Picture

Uses the common dialog box to select a graphic file for insertion.  This can be as a referenced file or as a bitmap.


Edit Find

Similar to Edit Find normally used in WinWord, however you are given the option to reference a jump or definition reference to the found text.  This is useful for referencing multiple occurrences of a certain word or phrase


Starting a New Project

A new project is started by selecting FILE NEW C_HELP! from within WinWord. You are then presented with the following dialog box.


Build From CSV File

This feature builds the shell of a project file automatically.  You are presented with a dialog box to select a CSV file which is used to build the outline of the project.  All project files are given the same name as the CSV file

The CSV file should be a plain text document with the topics listed as follows:

Title, Context Id, Context Number, Browse Sequence, Keywords

If Context Id is blank then the Auto Context feature is used, any other fields that are blank are ignored.  Trailing commas are not required.


Acknowlegements
Acknowledgements

Many thanks to those users who have supported CreateHelp! from its inception and to the team of beta testers who provided the necessary feedback to produce a stable product.

Thanks to Tony Linde for providing code for accessing the COMMDLG.DLL which has been invaluable.

And thank you to Vince, Woody, Guy and all the regulars of WINSDK and PROGMSA who provide a constant source of help and ideas.

CreateHelp! has only become what it is today because of user support.  Many thanks to you all.


Title - The title of the current context


project.DOC - the file that contains the main body of the help source. In WinWord format


project.RTF - the main help source file in Rich Text Format.  This is saved from the project.DOC file at compilation time.


project.DFN - the pop-up help source file in WinWord format.


project.DEF - the pop-up help source file in Rich Text Format.  This is saved from the project.DFN file at compilation time.


project.HPJ - the project file governing compilation options etc.


project.ERR - the error file written by HCxx during compilation


project.H - the header file containing the context numbers


Project Path - the path where all the project files reside


Graphics Path - the path where the graphics files reside, this sets the BMRoot option of the HPJ file


Help Compiler - the path to HCxx and the version being used


MS Hypergraphics Editor - the path to SHED.EXE if installed


Insert Title Text - if selected inserts the Context title into the main document, using the Main Titles font


Non-Scrolling Title - formats the title and one line following as a non-scrolling region


Auto Context - creates a context name based on the first two words of the title


Use Title as Keyword - adds the title to the list of keywords


See Also Button - when starting a new project this creates a 'See Also' button which can be enabled/disabled for every context in the project


Definition Separator - defines the separator used for definitions, either a user defined string or a new paragraph


Name - a name which uniquely identifies the window


Caption - the text displayed in the window's title bar


Window State - whether the window is the size defined in windows size or maximised when first opened


Window Dimensions - the x,y,width,height size and position of the window when first opened.  These must be in the range 0-1023


Scrolling RGB - Red, Green, Blue values for the scrolling region of the window.  These must be in the range 0-255


Non-Scrolling RGB - Red, Green, Blue values for the non-scrolling region of the window.  These must be in the range 0-255


On Top State - whether the window is 'Always on Top' or not when first opened


Root - the location of the project files, as defined in Setup - Project Path


BMRoot - the location of the graphics files, as set in Setup - Graphics Path


ErrorLog - the name of the error file created by HCxx during compilation


Contents - the context Id of the contents page


Icon - the file containing the ICO format icon for the compiled file


Warning - the level of warning HCxx reports during compilation


Report - whether HCxx reports compilation errors or not


Compress - the level of compression used by HCxx


HCxx - the help compiler; HC30, HC31 or HCP


Rich Text Format - the format required by HCxx


CreateHelp! - Help file authoring tool © Nic Barnes 1993


Title - The title associated with the context.  This is inserted into the document if Insert Title Text has been selected


Context ID - A name that uniquely identifies the current context.


Browse Sequence - A number defining the sequence in which the topic is viewed when using the << and >> buttons


Context Number - a number written to the project.H file for use with context sensitive topics


Keywords - these appear in the search dialog box, separated by semi-colons.  The title will be appended to this list if Use Title of Keyword is selected.


Macro - enables the building of topic macros which automatically execute when the page is opened.  See Also if available will also append  macros depending on enabled/disabled


See Also - Enabled will prompt for a context to associate with the See Also button and Build a macro accordingly.  Disabled will insert a DiableButton macro.


Add Button - adds a line to the file


OK Button - accepts the contents of the dialog box.  Same as pressing return


CANCEL Button - cancels the current operation.  Same as pressing ESCape


Help Button - opens the help file and takes you to the page associated with the dialog box (this page)


Select the line to Add, Edit or Delete


Edit Button - edits the selected line


The registration details of the registered user of this software


How to contact the author


The major and minor version number of this release


Done Button - writes the changes to the HPJ file and closes the dialog box


Context Id - the topic's Context Id


Context Number - the number used by the calling application to define the page


Current Files - the files currently listed.  Must include the full path if the files are not found in the ROOT directory specified in Edit HPJ Options


Project Name - this name is given to all the project files with the extensions HPJ DOC DFN H RTF DEF


Setup Button - presents the Setup CreateHelp! dialog box to change any setup options before starting the new project


CSV - Comma Separated Variable file


Delete Button - deletes the selected line


Macro Button - uses the Insert Macro routine to define a macro


Find DOC Button - provides a list of all available context Ids in the DOC file


Find DFN Button - provides a list of all available context Ids in the DFN file


Get Titles from - choose to select the Context Ids from the DOC or DFN file


Shed Path - the path to SHED.EXE (if installed)


Main Titles font - the font used for the DOC file titles if Format Context Defaults - Use Character Formatting has been selected


Definition Body font - the font used for the DFN file body if Format Context Defaults - Use Character Formatting has been selected


Definition Titles font - the font used for the DFN file titles if Format Context Defaults - Use Character Formatting has been selected


Main Body font - the font used for the DOC file body if Format Context Defaults - Use Character Formatting has been selected


Macro Name - the name of the user macro you wish to define


Macro Parameters - the parameters required by the macro


Create Page in - where to create the page once built, in the DOC or DFN file


Use Browse Sequence Range - whether or not to use a range to build the page from.  If selected all pages between these numbers will be listed in the order found.

Note:  Topics without a sequence number or with an alphanumeric sequence are assumed to have sequence number of zero


Compiler Path - the path to HCxx


Shed Installed - Yes or No as to whether SHED.EXE is installed.  If Yes then a path must be provided


Browse Sequence Number - the order in which pages are viewed when using the << and >> buttons


Insert Term - inserts the text of the definition followed by the separator if selected


Formatting - either use character formatting as defined in Tools Setup CreateHelp! or use styles.  The styles used are:  Main Titles and Definition Titles, these may be redefined in the normal manner.


Insert Line After - if selected then a blank line is inserted after the title.  This is a non-scrolling region if Non-Scrolling Title has been selected


Edit HPJ [Options]

Edit HPJ [Files]

Edit HPJ [Windows]

Edit HPJ [Config]

Edit Header File