CreateHelp! v1.02

CreateHelp! is an authoring tool for writing MS Windows help files.
It requires MS Word for Windows v2.0x and HCxx - the MS Help compiler.

For quick install copy C_HELP!.DOT & C_HELP!.HLP to your WinWord directory,
else See the installation page in MANUAL.DOC or C_HELP!.HLP

Release History

v1.02 - Fixes registration routine

v1.01 - Fixes minor bug in EDIT SEARCH function

v1.00 - Initial Release

CreateHelp! v1.02

CreateHelp! is an authoring tool for writing MS Windows help files.
It requires MS Word for Windows v2.0x and HCxx - the MS Help compiler.

For quick install copy C_HELP!.DOT & C_HELP!.HLP to your WinWord directory,
else See the installation page in MANUAL.DOC or C_HELP!.HLP

Release History

v1.02 - Fixes registration routine

v1.01 - Fixes minor bug in EDIT SEARCH function

v1.00 - Initial Release
-1@-V7O@TTable of Contents

Overview2
TOC \oInstallation3
Getting Started3
Setup Options4
The Toolbar5
The Menus6
The HPJ File7
Obtaining the Tools7
Writing help files8
The Shareware Concept10
Disclaimer10
Shareware Agreement10
Copyright11
Registration11
Contacting the Author11
Registration Form12
XE "Overview"Overview

Having developed a few in-house windows applications I found the need to write associated help files. Writing these is nothing short of a pain, so I looked around for third party solutions to simplify this process and found none suitable, hence CreateHelp! was written.

CreateHelp! automates all the laborious cross referencing of hypertext jumps and allows for easy conversion of a 'text' document to a hypertext document.

To write HLP files you need a rich text formatted document that uses special footnote references to identify each topic or 'page' and hidden text to reference hypertext jumps and pop-ups (definitions).

The special footnotes and character formatting used are as follows:

footnote#Context stringA name (containing no spaces) which uniquely identifies the 'page', allowing for hypertext jumps and definitions

footnote$TitleA title for the 'page'

footnote+Browse Sequence no.Sets the order in which 'pages' are viewed when using the << and >> buttons

footnoteKKeywordSets the keywords that are listed in the search dialog box (when the Show Topics button is pressed the titles of related 'pages' are shown)

Double Underlined TextIndicates a 'page' that can be jumped to

Single Underlined TextIndicates a definition or pop-up (these are generally further explanations of terms used)

Hidden TextThe context ID name of a 'page' that is to be referenced by a definition or jump

CreateHelp! allows for all this information to be entered into dialog boxes that then automatically formats the text appropriately and references the necessary jumps etc.

This is done using two WinWord documents, the first is the main body of the HLP file and has the standard DOC extension and the second contains all the definition context IDs that are use for the pop-ups, this has the extension DFN. At compilation time these two files are saved as rich text format documents with the extensions RTF and DEF respectively.

The final file created and maintained by CreateHelp! is the HPJ file. This is a text file (similar to an INI file) which is used by the help compiler (HCxx) to determine all the compilation options etc.

XE "Installation"Installation

The archive CHxxx.ZIP should contain the following files:

C_HELP!.DOT
MANUAL.DOC

C_HELP!.HLP
README.TXT


C_HELP!.DOT should be unpacked into your WinWord directory, or the directory in which your templates are stored, C_HELP!.HLP can be placed in either your Windows or WinWord directory. MANUAL.DOC and README.TXT can be anywhere you wish, but you are strongly advised to take a peek at README.TXT as it contains the last minute release notes.

Getting Started

To setup CreateHelp! for the first time: From WinWord select FILE NEW then the template C_HELP! which should appear in your list of available templates (if not see Installation above). You are then prompted for the setup options (see below) which determine the location of all the project files etc.

On starting any new project (i.e. by FILE NEW, C_HELP!) you are asked for a project name, and your first project is no exception. The project name must be a DOS standard file name with no extension. CreateHelp! gives all the project files the same name with their own various extensions (explained later)

That's it you ready to start writing your first help file.

Select INSERT NEW CONTEXT from the menus or from the toolbar. You are presented with a dialog box prompting you for a Title, Context ID, Browse Sequence Number and associated Keywords with options of Auto Context, Auto Insert Title and Use Title as Keyword.

Auto Context will automatically set a context ID based on the first two words of the Title (thus Table of Contents would become TABLE_OF).

Auto Insert Title will insert the Title into the document using the font set in setup options.

Use Title as Keyword will add the Title to the list of Keywords.

Having completed this dialog box the footnotes are then inserted and you are returned to the main editing window of your document. You will then be asked if this is the contents page, this then sets the CONTENTS section of the HPJ file. (If you answer NO you will be asked again after every new context ID until the contents page is defined.)

That's basically it! The sections The Toolbar and The Menus will explain further all the features available with CreateHelp!
XE "Setup Options"Setup Options
The following options must be set:

Project Path is where all the project files are stored; DOCDOC_DEF, DFNDFN_DEF, HPJHPJ_DEF and RTFRTF_DEF & DEF

Graphics Pathsets the BMROOT option in the HPJHPJ_DEF file. It is where most of you graphics files are stored, if they are not then INSERT PICTURE, REFERENCED PICTURE will insert the full path to the graphic.

Help Compiler gives you the choice of using HC30HCXX_DEF, HC31HCXX_DEF or HCP

Compiler Path the path where HCxxHCXX_DEF resides

SHED Installed YES/NO as to whether SHED.EXESHED_DEF is installed

SHED Path the path to SHED.EXE







(the MS hypergraphics editor)

Title Fontthe font used for all the new 'page' titlesOnly supports font, points, bold, italic and color

Body Textthe font used for the main body of the fileOnly supports font, points, bold, italic and color

Definition Titles the font used for the definition (pop-up) titleOnly supports font, points, bold, italic and color

Definition Bodythe font used for the main body of the definitionOnly supports font, points, bold, italic and color


XE "The ToolBar"The Toolbar



Insert New Context inserts a page beak followed by footnote references for context IDCONTEXT_DEF, title, browse sequence and keywords, though context ID is all that MUST be provided




Insert Titleinserts a footnote reference for the context IDCONTEXT_DEF's title, the cursor can be in any part of the section for this to work. This is unnecessary if the title has set in with Insert New Context

Insert Browse Sequence inserts a footnote reference for the context IDCONTEXT_DEF's browse sequence. The cursor can be in any part of the section for this to work. This is unnecessary if the browse sequence number has been set with Insert New Context

Insert Keyword inserts a footnote reference for the context IDCONTEXT_DEF's keywords. The cursor can be in any part of the section for this to work. This is unnecessary if the keywords have been set with Insert New Context

Insert Definition enables a definition to be entered into the DFNDFN_DEF file and referenced to the selected text. Text must be selected for this to work

Insert Jump enables a jump to be referenced to the selected text. Text must be selected for this to work

Insert Picture as per regular Insert Picture however after the file has been selected options are given to insert it as a bitmap or an opaque reference; either justified left, right or with text. Selecting the latter allows for the insertion of hypergraphics and makes for a smaller HLP file size
EMBED MSDraw \* mergeformat Launch SHED launches SHED.EXESHED_DEF (the Microsoft Hypergraphics editor - if installed)

Tools Spelling as per usual

Launch Help launches the HLP files 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
Compile Help uses HCxxHCXX_DEF to compile your current project into a HLPHLP_DEF file
XE "The Menus"The Menus

The menus that are changed or added in CreateHelp! are as follows:

File Close projectcloses both the DOC file (prompting you to save changes) and the DFN file (again prompting you to save changes) for the current project

Edit Find & Insert Jump or Defsimilar 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

Edit HPJsets the HPJ file options

View Errorlogopens the Errorlog as defined in the ERRORLOG section of the HPJ file. Generates an error unless the file has been compiled

Insert Pictureas per regular Insert Picture however after the file has been selected options are given to insert as a bitmap or an opaque reference. Selecting the latter allows for the insertion of hypergraphics and makes for a smaller HLP file size


Insert New Contextcreates a new context section. At the same time the title, browse sequence and keywords may be entered for the given context ID

Insert Titleinserts a footnote reference for the title into the current section. This is not necessary if it was entered with Insert New Context

Insert Browse Sequenceinserts a footnote reference for the browse sequence into the current section. This is not necessary if it was entered with Insert New Context

Insert Keywordinserts a footnote reference for the keywords into the current section. This is not necessary if they were entered with Insert New Context

Insert Jumpprompts for a context ID to set the selected text as a jump. The AutoContext feature is used to 'guess' the context ID or allows for a search of all available context IDs (can be slow)

Insert Definitioninserts a definition for the selected text in the DFN file. This also uses the AutoContext feature.

Tools Launch Helplaunches 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

Tools Compile Helplaunches HCxx to compile the current project. As this is a shell out to DOS you may require a PIF file for HCxx. On returning to WinWord you are given the options to load the error file generated by HCxx and/or to launch the newly compiled HLP file

Tools Launch SHEDlaunches the MS Hypergraphics editor (if installed)

Tools Setup CreateHelp!runs through all the setup options for CreateHelp!

Help CreateHelp! Indexlaunches the CreateHelp! HLP file

Help Aboutshows the About dialog box - registration status, version number etc.

Help Registerallows the entry of registration details to remove the nag messages
The HPJ File

The HPJ file is the project file specifying as the compilation options. Those that are directly editable from within CreateHelp! are as follows:

ROOTthe location of the DEFDEF_DEF and RTFRTF_DEF files. Beware of changing this, its better to change it via Setup Options

BMROOTthis is the location of the graphics.

ERRORLOGthe error file that HCxxHCXX_DEF writes after compilation

TITLEwhat is displayed in the title bar when the HLPHLP_DEF file is run

CONTENTSthe ContextCONTEXT_DEF ID of the contents page. It is jumped to when the CONTENTS button is pressed

ICONdefines the ICO file for your HLPHLP_DEF file. This must include the full path

WARNING1, 2 or 3 - the warning level that HCxxHCXX_DEF generates

REPORTON or OFF, whether or not HCxxHCXX_DEF reports errors

COMPRESSthis option causes HCxxHCXX_DEF to compress the HLPHLP_DEF file but can slow the compression process down considerably. Leave this set to OFF until the HLPHLP_DEF file is debugged and then re-compile using the HIGH option



Obtaining the Tools

The files HCxx and SHED.EXE are included with the Windows SDK, Visual Basic Professional Edition (versions 1.0 and 2.0) and probably in a few other SDKs. However those of you that don't have these products needn't dismay. Both files are available from library 16 in the WINSDK forum on Compuserv.

At time of writing the most recent versions were:
HCP.ZIP 11 01/93
SHED.ZIP 10 01/93
Writing help files

A Windows HLP file is a hypertext document which allows users to quickly jump from subject to subject and view definitions of unfamiliar terms in a pop-up window.

Every 'page' in a HLP file must have a unique name (containing no spaces) to identify it. This is known as a Context ID. Every 'page' may also be given a Title, this is a real name for the 'page'. For example this page would have a context ID of WRITING_HELP and a Title of 'Writing help files - explained'

The two other features of a help file are Keywords and Browse Sequence number. Keywords are words which are shown when the SEARCH button is pressed and each page can have many keywords associated with it. This page may have the keywords - Writing help files, Help files explained, Explanation of how to write help files, etc. So the more keywords associated with any page, the easier it is for the user to find the relevant topic. The Browse Sequence number is like a page number, it controls the order in which 'pages' are viewed when the user presses the << and >> buttons. They have the advantage that they do not have to be consecutive, so, the first page can be 000, the second 005 and so on, because of this 'pages' can be written in any order, as long as the browse sequence is defined. It is a good practice to uses multiples of 5 because if you find that a page has to be added later it can be given the number 002 without having to re-number all the other pages.

Using this manual as an example, the procedure to write a help file would be as follows

From WinWord select FILE NEW and then select the template C_HELP! You are asked for setup info as described in getting started and then a project name. The project name must be 8 characters or less with no extension, so, lets call this TEST. CreateHelp! does a bit of housework and then leaves you in the main document window. You are ready to start your first page (generally the contents page)

From the menus or toolbar, select INSERT NEW CONTEXT, fill the dialog box in as follows:

Title
Table of Contents
SYMBOL 253 \f "Wingdings"
Auto Insert Title

Context ID
CONTENTS
SYMBOL 168 \f "Wingdings"
Auto Context

Browse sequence
000



Keywords
Contents; Index
SYMBOL 253 \f "Wingdings"
Use Title as Keyword

(keywords are separated by a semi-colon)





CreateHelp! now creates a new 'page' and inserts the title. You are then asked if this is the contents page so answer YES.

Now add a few entries for the contents page:

Overview
Installation...
Writing help files
Now the next 'page', INSERT NEW CONTEXT and the dialog box is as follows

Title
Writing help files
SYMBOL 253 \f "Wingdings"
Auto Insert Title

Context ID

SYMBOL 253 \f "Wingdings"
Auto Context

Browse sequence
035



Keywords
Help files explained
SYMBOL 253 \f "Wingdings"
Use Title as Keyword


Enter some text for the Writing help files page:

A Windows HLP file is a hypertext document which allows users to quickly jump from subject to subject and to view definitions of unfamiliar terms in a pop-up window.

Every 'page' in a HLP file...

Now lets reference a jump. Select the text Writing help files on the contents page and select INSERTJUMP from the menus or 'J' on the toolbar. A dialog box asks the context ID you wish to associate with the text and suggests WRITING_HELP. Click on OK - all the character formatting is done, referencing Writing help files on the contents page to the context ID WRITING_HELP

To reference a definition, select the text HLP on the Writing help files page and from the menus INSERTDEFINITION or 'D' on the toolbar A dialog box asks the context ID you wish to associate with the text and suggests HLP_DEF. Click on OK and a second dialog box asks for the definition of HLP, type a definition such as - these are the help format files used by WinHelp and select OK. This definition is then inserted into the DFN file and you are returned to the main DOC file.

To reference the same definition select the second occurrence of HLP and INSERTDEFINITION again. The dialog box again suggests HLP_DEF and we know that this is the context ID we wish to reference to, so click OK. The second dialog box asks for a definition for the text HLP again, as this is already defined click on CANCEL. The text HLP is now referenced to an existing context ID and all the character formatting is done automatically.

Congratulations! you've written your first help file. Now all that needs to be done is to compile it. Select TOOLS HELP COMPILE from the menus or the happy face from the toolbar. CreateHelp! will shell out to DOS and run the help compiler selected in the setup options. You may see the message box "Compilation Complete! Open the Errorfile?" prematurely. Wait for the return from DOS and answer NO (Hopefully no errors have been generated) You are then asked if you wish to launch the newly created help file, well, do you?

This being a simple help file there's not much that can be done with it, but clicking on Writing help files should jump you to that 'page' and clicking on either occurrence of HLP should bring up a pop-up defining what a HLP file is. Click on the SEARCH button and you should see listed the five keywords you've defined, namely, Contents, Table of Contents, Help files explained, Index and Writing help files. Finally you can use the <> buttons to navigate from page to page (between both pages).

That's it! The rest is down to you, good luck and if you do continue to use CreateHelp!....REGISTER!
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.

If you continue to use this product after a reasonable trial period then please register it.

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
UK20.00
US$40.00
Payable by Cheque or banker's draft. If not drawn on a UK bank these will be subject to a delay while funds clear (upto about 3 weeks)

Contacting the Author

By eMail @ Compuserv 100111,3452

By Snail Mail @ Nic Barnes, CHC, 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

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

I enclose payment of UK20.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
27 West Park
London SE9 4RZ
ENGLAND

EMBED MSDraw \* mergeformat

page PAGE2





v*/=SSSSst:"`A
ZZ&MrEdMicrosoft DrawZ&MrEdArial PosterItalicP&MrEd}M
."Arial-2
C2
7H@"Arial-
2
:reate2
9elp@"Arial-2
!&MrEd#--#"System---''P:f\P,",C ""("@@@@@@
P(#'08.m59P@yGKe$RyY]P(#'08.m59P@yGKe$RyY]:9C&MrEdMicrosoft DrawZ&MrEdxxBodoni PosterItalic&MrEd
qm}4D$aU40,eYm,u}4UUi$qP(Yu0}D$a(qi(qH$YL$U8H$P@q8}4U,mH}(u408a0q0,}Dm,Y4]$mH4Um4P(8#'08.$m59P@,yGKe$R$yY]<:&8 C ( qm4}a$DU4e,0Yu,m4}UUq$iY(P}0u$Dq(aq(iY$HU$L8P$H@}8q4m,UHu(}4a8000q,D},m4Ym$]U4HyZZ&MrEdMicrosoft DrawZ&MrEdArial PosterItalicP&MrEd}M
."Arial-2
C2
7H@"Arial#-
2
:reate2
9elp@"Arial-2
!&MrEd#--#"System---''P4MSDraw"`Z&MrEdMicrosoft DrawZ&MrEdArial PosterItalicP&MrEd}M
."Arial-2
C2
7H@"Arialw-
2
:reate2
9elp@"Arial-2
!&MrEd#--#"System---''ynhB
METAFILEPICT"h"`Z&MrEdMicrosoft DrawZ&MrEdArial PosterItalicP&MrEd}M
."Arial-2
C2
7H@"Arial-
2
:reate2
9elp@"Arial-2
!&MrEd#--#"System---''PMSDraw
9&MrEdMicrosoft DrawZ&MrEdxxBodoni PosterItalic&MrEd
qm}4D$aU40,eYm,u}4UUi$qP(Yu0}D$a(qi(qH$YL$U8H$P@q8}4U,mH}(u408a0q0,}Dm,Y4]$mH4UmMETAFILEPICT
9&MrEdMicrosoft DrawZ&MrEdxxBodoni PosterItalic&MrEd
qm}4D$aU40,eYm,u}4UUi$qP(Yu0}D$a(qi(qH$YL$U8H$P@q8}4U,mH}(u408a0q0,}Dm,Y4]$mH4Um."Arial-2
C2
7H@"Arial-
2
:reate2
9elp@"Arial-2
!&MrEd#--#"System---''xx$.+
METAFILEPICT"h"`Z&MrEdMicrosoft DrawZ&MrEdArial PosterItalicP&MrEd}M
."Arial-2
C2
7H@"Arial#-
2
:reate2
9elp@"Arial-2
!&MrEd#--#"System---''PbjKW

;Gjk(-AFR6J

Y

`0 V
@400FYZ[mn}
%FM&,4=Naisy^nWb<

`b000

D
"#1,W?ABSacdr0 2 48
@h
ld


22 3 B K S ~ !!!!"""""""B#D#S#A$E$X$$$$p%r%%&&+&&&&'''''(((()))'*)*A*u*w*****+++[+i+k+,,,#,+,2,,0


N,,,,,,,,,+-2-@-B-K-V-a-----..;.C.O.Q.X.v.~.......5/


L999999999999:::):+:S:U:Y:[:]:;A;;;;;;;;;;;;;<<<<<'<.<0<2<<>(@,@I@x@E(EmEpE"G7GwIIKKGLQLLLMxMMeOpOrOpP 0
SpPrPPPTTTTxTzTTTTTTTrUtUUUUUUUUUUUUUUUUV*0
@\#0 0",CYsWYIKY[w-);7f-) 7f-)7f-)Vn-) n-)n-);n-)f-)f-)f-)6-)6-)`-[


(*,



<>DF46xzY}=?su
-)??-)-)-)-)6-)l8-)-)f-)f-)f;wy\^ "?Aac2 !!"""xp-) J
-)VJ
-);J
-)`J
-)`
-)J
S
-)hJ
S
-)J
S
-)J
S
-)J
S
J
S-)-)-)-)?-);?,""B#D#A$C$E$$$p%r%&&&&''''(())'*)*u*w***++Z+i+k++,~,,,,,,@-B---
..O.Q...y/{/}////00011-)-)6-) [-)[[-)-)-)-) J
-)VJ
-)`-)rJ
-);J
-)`J
>[email protected]|9999999999999:):+:U:W:Y:[:]:_:::;;;-;A;~xxx-)8l+
"
"
"
"ml
O
"2%
N%-)-)-)-)-)-)/A;;;;;;;;;;<<<'<,<.<0<2<<BI"-%
N%-)7ELGLQL[LeLLLMM+M-MuMwMMMMMNNcOeOpOrOpPrPPPPP)Q+QRRTTTTZT\TTTTTTTTTTTTTTTTl!

l!
{{-)-)-)-)-)-)6-)n-)n-){-)5TTTTUUUUUU"U$U&U(U*U,U;U=U?UAUCUEUnUpUrUtUUUUUUUUUUUUUUVxxxxxsmsgsgssx-)-)z-){-)l!
~{5{l!l!
l!
l!

{{'"80FGR!p#
T
TVk
W
)/9EKRT!#J
%6:@2 ,9pP*["1A;ELTVGTimes New RomanSymbol&ArialWingdingsarailTimes DKi@^`778,8v88):C:i::::T:
:999999 */1@:!HP DeskJet 500LPT1:HPDSKJETHP DeskJet 500 Printer
0D,,d##DEVICECAPABILITBhyTeee
2T
'
Nic Barnes
Nic Barnes