Board index » cppbuilder » Windows Help Editor

Windows Help Editor


2004-02-09 11:42:22 AM
cppbuilder66
I need a Windows help editor/designer which will generate the files needed
by Microsoft Help Workshop. Ideally, the software I'm looking for would
have a WYSIWYG interface, and not cost more than $100 or so.
Any suggestions?
Pat
 
 

Re:Windows Help Editor

"Pat McClure" < XXXX@XXXXX.COM >wrote:
Quote
I need a Windows help editor/designer which will generate the files needed
by Microsoft Help Workshop. Ideally, the software I'm looking for would
have a WYSIWYG interface, and not cost more than $100 or so.

I downloaded just about every free or trial help designer
available. The free ones were {*word*99} and the others weren't
worth the cost IMHO.
I'm cheap so I use WordPad. No, it's not WYSIWYG but so what?
Ok, you don't want to spend the few hours required to figure
out the file lay-out even though all of the other choices have
a learning curve anyway.
Do you have a copy of Word laying about? All of the help examples
(for the workshop) are for using Word and that is WYSIWYG. It
might even work with MS Works but who knows? Just be sure to
save the files in RTF format.
If you want, I have a sample RTF that demonstrates just about
every conceivable feature available.
~ JD
 

Re:Windows Help Editor

JD:
Thanks for letting me know your experiences. I've about concluded the same
thing re: shareware and not-so-freee-ware.
You mention "Allof the help examples (for the workshop) are for using
Word...." Is there a "workshop" file/tutorial/activity of some kind? More
info would be nice.
And I'd love to have your sample RTF. I do use Word, and believe a good
example would push me over the top on understanding the help files.
Thanks,
Pat
"JD" < XXXX@XXXXX.COM >wrote in message
Quote

"Pat McClure" < XXXX@XXXXX.COM >wrote:
>I need a Windows help editor/designer which will generate the files
needed
>by Microsoft Help Workshop. Ideally, the software I'm looking for would
>have a WYSIWYG interface, and not cost more than $100 or so.
>

I downloaded just about every free or trial help designer
available. The free ones were {*word*99} and the others weren't
worth the cost IMHO.

I'm cheap so I use WordPad. No, it's not WYSIWYG but so what?
Ok, you don't want to spend the few hours required to figure
out the file lay-out even though all of the other choices have
a learning curve anyway.

Do you have a copy of Word laying about? All of the help examples
(for the workshop) are for using Word and that is WYSIWYG. It
might even work with MS Works but who knows? Just be sure to
save the files in RTF format.

If you want, I have a sample RTF that demonstrates just about
every conceivable feature available.

~ JD

 

{smallsort}

Re:Windows Help Editor

"Pat McClure" < XXXX@XXXXX.COM >wrote:
Quote
[...] Is there a "workshop" file/tutorial/activity of some
kind?
The workshop has a help file and if you compile the sample
help file, it too has lots of pointers. Other than that, all
of the stuff that I found was another person's concept of how
to and they were all different and somewhat contrived.
Quote
I do use Word, and believe a good example would push me over
the top on understanding the help files.
It's in the attachment group waiting.
One thought: If you're just learning it now, you might consider
spending a few hours looking at HTML help instead. The industry
is moving away from .hlp files to HTML help.
~ JD
 

Re:Windows Help Editor

Pat,
Quote
Is there a "workshop" file/tutorial/activity of some kind?
There are a few tutorials online that you may find useful:
www.{*word*137}storyteller.com/the_{*word*137}_storyteller/help_index.htm
www.thebits.org/tutorials/bhelp.asp
And there are quite a number of books on the subject. See:
helpware.net/htmlhelp/basics.htm
Quote
And I'd love to have your sample RTF. I do use Word, and believe a good
example would push me over the top on understanding the help files.
If you get the decompiler from the address below then you can extract
the source RTF files from any WinHelp file on your system.
www.helpmaster.com/hlp-developmentaids-helpdeco.htm
I agree with JD, though; it would be worth investigating HTML Help,
which has largely superseded WinHelp in the last few years.
Pete (Microsoft Help MVP)
 

Re:Windows Help Editor

JD:
Thanks much for the info. You've made my immediate job a lot easier,
however:
1. I do not see any evidence of an attachment to your last message (the
.rtf file). Please feel free to directly use my e-mail address
( XXXX@XXXXX.COM ) if you resend the attachment.
2. Is the "workshop" a Borland creation? Where can it be found?
I'm going to go ahead with the .hlp approach this time, as I need to
complete this task soon. I'll look at HTML help for the next job -- I
understand Microsoft is dropping .hlp in favor of HTML. My biggest problem
with help has been in understanding the function of each of the files, .hlp,
.cnt, .hpj, .rtf. I'm over that now, and into the details.
Thank you again, so much -- you're the hand that's pulling me out of the
swamp!
Pat
"JD" < XXXX@XXXXX.COM >wrote in message
Quote

"Pat McClure" < XXXX@XXXXX.COM >wrote:
>[...] Is there a "workshop" file/tutorial/activity of some
>kind?

The workshop has a help file and if you compile the sample
help file, it too has lots of pointers. Other than that, all
of the stuff that I found was another person's concept of how
to and they were all different and somewhat contrived.

>I do use Word, and believe a good example would push me over
>the top on understanding the help files.

It's in the attachment group waiting.

One thought: If you're just learning it now, you might consider
spending a few hours looking at HTML help instead. The industry
is moving away from .hlp files to HTML help.

~ JD

 

Re:Windows Help Editor

"Pat McClure" < XXXX@XXXXX.COM >wrote:
Quote
[...] I do not see any evidence of an attachment to your
last message
That's because attatchments are only permitted in
the .attachment group:
tinyurl.com/2bfe2
or you can go directly to the post:
tinyurl.com/245na
Quote
Is the "workshop" a Borland creation?
Nope. It's a MicroSoft animal.
Quote
Where can it be found?
One of several (100's of)sites. In this case it's the 4th item
listed:
www.magrino.com/download.htm
Quote
My biggest problem with help has been in understanding the
function of each of the files,
.hlp,
Is the compiled help file - like an exe.
Quote
.cnt,
The contents file. It just displays the little help (book's -
open and closed) icons as you scan the subjects/sub-subjects.
Deal with this last. You don't need it to get a useful help
file generated.
Quote
.hpj,
The project file. Here is an example:
; This file is maintained by HCW. Do not modify this file directly.
[OPTIONS]
COMPRESS=12 Hall Zeck
LCID=0x409 0x0 0x0 ; English (United States)
REPORT=Yes
FTS=1
CONTENTS=Contents
TITLE=IDEAtum Formulas Help
COPYRIGHT=IDEAtum?Formulas ?2002 IDEAtum Inc. All rights reserved.
BMROOT=..\BMP
BMROOT=..\SHG
HLP=Formulas.hlp
[FILES]
MainMod.rtf
Connect.rtf
Orders.rtf
Formulas.rtf
Ingredients.rtf
Clearance.rtf
DirPurAnl.rtf
Customers.rtf
Company.rtf
Logo.rtf
PrinterConfig.rtf
PrinterDialog.rtf
Build.rtf
[MAP]
#include Indexes.H
[WINDOWS]
Main="IDEAtum Formulas Help",(232,0,560,914),60672,,(r16384),f2
[CONFIG]
BrowseButtons()
And here's an example of the #include Indexes.H file:
/* Valid Comments */
// also valid comments
/* if you call Application->HelpContext( 100 ); the help will open (jump) */
/* to the label 'ConnectForm' that was defined in one of your .rtf files */
#define ConnectForm 100 // connection
#define OrderForm 200 // orders
#define FormulaForm 300 // formulas
#define ForPurposeForm 310 // Gbl->forHelpIndex + 10
#define ForDirectionForm 320 // Gbl->forHelpIndex + 20
#define IngredientForm 400 // ingredients
#define CalculateForm 480 // calculator
#define ClearanceForm 500 // clearance
#define DirectionForm 600 // directions
#define CustomerForm 700 // customers
#define AnlSortForm 800 // analysis sort
#define PrnConfigForm 900 // printer cfg
#define PrnDialogForm 950 // printer dlg
#define CompanyForm 1000 // company
#define LogoForm 1100 // Bitmapped Logos
#define PurposeForm 1200 // Formula Purpose
#define BuildForm 1300 // Build from G/A
#define ExportForm 1400 //
#define ImportForm 1500 //
Quote
.rtf.
.rtf files are your source code files.
When you download the the workshop, there is also a Shed.exe.
I downloaded about half a dozen times from different locations
trying to find a site that included help for Shed.exe but had
to figure it out for myself.
What it does is it takes a .bmp, lets you define a HotSpot and
a link to jump to in the help if the user clicks the HotSpot
and saves the result as a .shg file. Once added to the help,
when ther MouseOver the HotSpot, the cursor changes from
crDefault to crHand to let the user know they can click it.
This is what the code looks like in the .rtf file to display
the .shg file. I would suggest that you open the .rtf using
NotePad (not WordPad), insert the code and then reopen in Word
to see how it should be done in Word:
\par\par\{bmc FileName.shg\}\par\par
When you add a HotSpot, if the Context String (set using SHED)
is 'cusPrintCustomer', the following is how you code a pop-up:
#{\footnote cusPrintCustomer}\pard\f2\fs20\par
{\b Print Customer Address} : Field Type : Optional\par
Click the check box to include the customers Bill To Address on the Formula label every time a label is printed for this customer.\par\par\page
~ JD
 

Re:Windows Help Editor

JD:
You're a jewel! I was out of town for several days and could not get my
mail. When I returned and saw your info on my question I figured my next
set of questions would not be answered since my original post was too old.
You are restoring my faith in ...
I finally figured out what "workshop" is, wrote a short .rtf file, compiled
it and linked it to my application. So the architectural problem is solved,
now I just have to chase the details.
Thank you heaps for all the help. It's appreciated, believe me.
Pat
"JD" < XXXX@XXXXX.COM >wrote in message
Quote

"Pat McClure" < XXXX@XXXXX.COM >wrote:
>[...] I do not see any evidence of an attachment to your
>last message

That's because attatchments are only permitted in
the .attachment group:

tinyurl.com/2bfe2

or you can go directly to the post:

tinyurl.com/245na

>Is the "workshop" a Borland creation?

Nope. It's a MicroSoft animal.

>Where can it be found?

One of several (100's of)sites. In this case it's the 4th item
listed:

www.magrino.com/download.htm

>My biggest problem with help has been in understanding the
>function of each of the files,
>.hlp,

Is the compiled help file - like an exe.

>.cnt,

The contents file. It just displays the little help (book's -
open and closed) icons as you scan the subjects/sub-subjects.
Deal with this last. You don't need it to get a useful help
file generated.

>.hpj,

The project file. Here is an example:

; This file is maintained by HCW. Do not modify this file directly.

[OPTIONS]
COMPRESS=12 Hall Zeck
LCID=0x409 0x0 0x0 ; English (United States)
REPORT=Yes
FTS=1
CONTENTS=Contents
TITLE=IDEAtum Formulas Help
COPYRIGHT=IDEAtum?Formulas ?2002 IDEAtum Inc. All rights reserved.
BMROOT=..\BMP
BMROOT=..\SHG
HLP=Formulas.hlp

[FILES]
MainMod.rtf
Connect.rtf
Orders.rtf
Formulas.rtf
Ingredients.rtf
Clearance.rtf
DirPurAnl.rtf
Customers.rtf
Company.rtf
Logo.rtf
PrinterConfig.rtf
PrinterDialog.rtf
Build.rtf

[MAP]
#include Indexes.H

[WINDOWS]
Main="IDEAtum Formulas Help",(232,0,560,914),60672,,(r16384),f2

[CONFIG]
BrowseButtons()

And here's an example of the #include Indexes.H file:

/* Valid Comments */
// also valid comments
/* if you call Application->HelpContext( 100 ); the help will open (jump)
*/
/* to the label 'ConnectForm' that was defined in one of your .rtf files
*/

#define ConnectForm 100 // connection
#define OrderForm 200 // orders
#define FormulaForm 300 // formulas
#define ForPurposeForm 310 // Gbl->forHelpIndex + 10
#define ForDirectionForm 320 // Gbl->forHelpIndex + 20
#define IngredientForm 400 // ingredients
#define CalculateForm 480 // calculator
#define ClearanceForm 500 // clearance
#define DirectionForm 600 // directions
#define CustomerForm 700 // customers
#define AnlSortForm 800 // analysis sort
#define PrnConfigForm 900 // printer cfg
#define PrnDialogForm 950 // printer dlg
#define CompanyForm 1000 // company
#define LogoForm 1100 // Bitmapped Logos
#define PurposeForm 1200 // Formula Purpose
#define BuildForm 1300 // Build from G/A
#define ExportForm 1400 //
#define ImportForm 1500 //


>.rtf.

.rtf files are your source code files.

When you download the the workshop, there is also a Shed.exe.
I downloaded about half a dozen times from different locations
trying to find a site that included help for Shed.exe but had
to figure it out for myself.

What it does is it takes a .bmp, lets you define a HotSpot and
a link to jump to in the help if the user clicks the HotSpot
and saves the result as a .shg file. Once added to the help,
when ther MouseOver the HotSpot, the cursor changes from
crDefault to crHand to let the user know they can click it.

This is what the code looks like in the .rtf file to display
the .shg file. I would suggest that you open the .rtf using
NotePad (not WordPad), insert the code and then reopen in Word
to see how it should be done in Word:

\par\par\{bmc FileName.shg\}\par\par

When you add a HotSpot, if the Context String (set using SHED)
is 'cusPrintCustomer', the following is how you code a pop-up:

#{\footnote cusPrintCustomer}\pard\f2\fs20\par
{\b Print Customer Address} : Field Type : Optional\par
Click the check box to include the customers Bill To Address on the
Formula label every time a label is printed for this customer.\par\par\page

~ JD