Skip to main content

Building context-sensitive help with no MAP IDs?

1 reply [Last post]
Anonymous

Hello, this is a rudimentary question from a writer new to building JavaHelp.

I have a product (built with Java) I'm documenting and I want to write
context-sensitive help to be included with the product. By context-sensitive
help I mean popup content that appears when a user positions the mouse over
or tabs to a field on a wizard screen. I want to write the content of the
popup and give it to my developers as a file they can include with the
application.

I have a documentation product to build JavaHelp 1.1.3 and it is asking for
Map IDs to link to the content I'm writing. Sounds reasonable, but I've
asked my developers and they have either been confused about what a Map ID
is or have indicated that they have not built Map IDs into the product code.

Is that possible?

If I can build the .jhm file and assign the Map IDs myself (which I can do
with the documentation product I have) will the development team still have
to build the Map IDs into the application code for the context-sensitive
help I've written to appear?

How can I ease this transition for the developers?

Thank you in advance to anyone who can provide guidance. I appreciate it.

********************************************************************************

You may leave the list at any time by sending message with no subject and
"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
are available at http://archives.java.sun.com/archives/javahelp-interest.html.
Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.

Reply viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
Roger Brinkley

Virginia O'Connor wrote:

> Hello, this is a rudimentary question from a writer new to building JavaHelp.
>
> I have a product (built with Java) I'm documenting and I want to write
> context-sensitive help to be included with the product. By context-sensitive
> help I mean popup content that appears when a user positions the mouse over
> or tabs to a field on a wizard screen. I want to write the content of the
> popup and give it to my developers as a file they can include with the
> application.
>
> I have a documentation product to build JavaHelp 1.1.3 and it is asking for
> Map IDs to link to the content I'm writing. Sounds reasonable, but I've
> asked my developers and they have either been confused about what a Map ID
> is or have indicated that they have not built Map IDs into the product code.
>
> Is that possible?
>
> If I can build the .jhm file and assign the Map IDs myself (which I can do
> with the documentation product I have) will the development team still have
> to build the Map IDs into the application code for the context-sensitive
> help I've written to appear?
>
> How can I ease this transition for the developers?
>
> Thank you in advance to anyone who can provide guidance. I appreciate it.

The MapIDs are the connection between the application and the help
content. Since you have created the MapIDs already the engineers don't
need to create another set of MapIDs. All they need to do is tie the
MapIDs into the the JavaHelp APIs so the correct help appears.

The type of help that you're trying to do is called field-level help. To
implement field-level help the developers will have to set the
appropriate ID for each component that you want field-level help to
display. A simple call to CSH.setHelpID will do what they want. For
general activation of the field-level help they would need to call
CSH.DisplayHelpAfterTracking. In your case since you want the help to
appear in a popup you'll need to use the V2.0 calls to direct it to
"javax.help.Popup".

Remember implementing help for your developers is as easy as 1, 2, 3.

1. Instantiate a HelpSet (and a HelpBroker) - 10 lines of code

2. Assign MapIDs to the component you want help on. 1 line of code per item

3. Add the code to activate the online help. 1 line of code per activation.

If your developers are still having problems have them read section 5
Programming with JavaHelp in the JavaHelp Users Guide (part of the
JavaHelp distribution. Better yet read it yourself and then go and tell
them what to do.

Binky

********************************************************************************

You may leave the list at any time by sending message with no subject and
"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
are available at http://archives.java.sun.com/archives/javahelp-interest.html.
Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.