HTMLHelp - Connect

 

What is HTMLHelp-Connect ?
 

!! Excuse me, for my bad english !!

What is HTMLHelp-Connect?

HTMLHelp-connect is the other way to write contextsensitive directhelp without helpcontext numbers. It enable you to write the context Help direct in the Helptopic for the form.

You must not write separate help topics for each context, but you can do it.
You must not assign help context numbers in the Delphi-IDE Propertyeditor for the controls, but you can do it.

Context sensitive directhelp is not shown in a seperate popup window. It is only a #bookmark for the component help statement, placed in the Helptopic for the form.

For example: The name of the topic is the formname + '.htm'. The bookmark <A NAME="..." is the componentname of controls in the form, you want create help for.
Bookmarks enable you to link to a specific location in a help topic. For direct help the Help-Connect does simply jump to the bookmark.

Example

Component  HelpFile

Form1      Form1.htm

  Button1  Form1.htm#Button1
                 <A NAME="Button1">Close window</A>

  Edit1    Form1.htm#Edit1
                 <A NAME="Edit1">write here</A>

Form2      Form2.htm

If you want to write separat topic for an component in the form, you can do it also, by assign however a helpcontext number in the IDE. Then the name of the topic should be "Topic" + the helpcontext number.
Note: StartHelpContext is by default 1000.
Only Helpcontext numbers >1000 are reserved for separat topics such as "Topic1xxx".
You can overwrite  StartHelpContext of other integer.

For use Application HelpKey F1 you must set Helpcontext (> 0 and  < StartHelpContext) in the IDE only for the Form you want Help with Key F1 for, but not for the components in the form. 
Note: Key F1 show normally  Help for the active Form, no context Help, because there  is Direct Help. You have set HelpContext for seperate Topic, then Key F1 show these.

What can HTMLHelp-Connect do for you?

HTML-Helpconnect is not a Help-authoring tool. You can write simply your help topics with each WYSIWYG HTML editor.  You must have install the Microsoft HTML-workshop.

You can create the Index keywordfile (.hhk) with an utility automaticly for all definded bookmarks over all topics. In additional the utility checks for undefinded hyperlinks. You must not place the topis as files in the hhp.-file, when you have created the index with the utility. You must create the Table of Contents (.hhc) manually. At last you must compile the help. The utility comes with source-code "MAUSHTML.dpr".

The component MAUSHelp you have placed  in your application does simply jump to the HTML- Helpviewer.

For simple instructions about to do these, see the example apps "MAUSHelpExa" and helpfile.

The component is not limited and absolutly free for non commercial use.
You have tested, found it good and want it for commercial use, please register for small price of 25$.

Instructions

Place the File MAUSHH5.bpl in Directory Borland/Delphi5/Projects/Bpl.
Install
in Delphi package MAUSHH5.bpl  with Component / Install packages.
Place the unit MAUSHelp5.dcu in Directory Borland/Delphi5/Lib.

In your apps:

Place the component MAUSHelp in the MainForm (or other).
Set Name you want and look for StartHelpContext.

Assign Application.HelpFile in Project/Options like: "MyHelp.chm" or different for Form.

Use procedures: MAUSHelp1.HHJump; .HHDirect(Sender); .HHTOC; .HHKey;
public properties: MAUSHelp1.TopicId and .LinkId (both are type string). 
For HHDirect(Sender) place a ToolButton or SpeedButton in your Form as Up/Down Button and set it as Sender. MAUSHelp will set it automaticly up/down.
properties for the buttons are different:
TToolButton:    AllowAllUp= False; Grouped= False;
TSpeedButton: AllowAllUp= True; GroupIndex= > 0;


Note: Do not forget at Formclose event set: MAUSHelp1.HHQuit; (see Example).     
Do not use MAUSHelp.dcu for D5.     

Place the unit MAUSHelp.dcu in Directory Borland/Delphi7/Lib.

In your apps:

Place MAUSHelp in the uses causes in the MainForm.pas (or other).
Under public define like this:   Help1 : TMAUSHelp;
On Create event for the Form "FormCreate" create instance of MAUSHelp like this: Help1 := TMausHelp.Create(self);

Assign
Application.HelpFile in Project/Options like: "MyHelp.chm" or different for Form.

Use procedures: Help1.HHJump; .HHDirect(Sender); .HHTOC; .HHKey;
public properties: Help1.TopicId and .LinkId (both are type string),
                              .StartHelpContext (is type Integer). 
For HHDirect(Sender) place a ToolButton or SpeedButton in your Form as Up/Down Button and set it as Sender. MAUSHelp will set it automaticly up/down.
properties for the buttons are different:
TToolButton:    AllowAllUp= False; Grouped= False;
TSpeedButton: AllowAllUp= True; GroupIndex= > 0;

Note: Do not make: Help1.Free; These is done by TMAUSHelp automaticly.   

Do not use MAUSHelp5.dcu for D7. 

HelpFileName

  1. If you do not assign HelpFileName in Project/Options like "MyHelp.chm", the Default HelpFileName is then: Application.ExeName with Extension .chm for Example:

    MyApp.exe = MyApp.chm in the them directory.
  2. If you do assign HelpfileName in Project/Options you can define Child-directory like

    "Help/MyHelp.chm".
  3. You can also define HelpFileName in the Properties for Forms different.

Top of page    Copyright © maussoft 2003.