Skip to main content

RE: [JAVAHELP] Trying static merge

1 reply [Last post]
Anonymous

Roger,
Do you have any words of wisdom for people that cross-link helpsets that are not merged? Our helpsets are separate entities but do reference documentation from each other. Any words of advice besides don't do it?

-----Original Message-----
From: Roger Brinkley [mailto:Roger.Brinkley@SUN.COM]
Sent: Tuesday, November 25, 2003 11:51 AM
To: JAVAHELP-INTEREST@JAVA.SUN.COM
Subject: Re: [JAVAHELP] Trying static merge

Per Lundkvist wrote:
> Grmpf...ups!
> That is not good for me, I'm in trouble!
> I thought that was the whole point with JavaHelp and merging JAR-files
> with eachother. What is the point of merging JAR:s if they can not
> link to eachother. They merge the TOC, Index and search but they can't
> link to eachother...
>
> In my case we have modules in our software. If a module is installed
> we just merge the module-documentation JAR-file into the
> master-documentation JAR-file. And in the module-documentation there
> are several links to the masterdocumentation that now will not work...

It's a constraint and it's been there since the age of time. Module help should be self contained. There are good reasons for this. The only place where cross reference occurs, or should occur, is in the content viewer. What should the help system do if the reference your trying to make doesn't exist or is configured incorrectly (referenced differently)? As you have found out there are two many installation variables that make cross referencing impossible and for some applications these variables are uncontrollable.

However, there is a workaround, which as been discussed more than once in the archives. The proper and only way to accurately reference a document in another helpset is through a map.ID. That's what is used in context-sensitive help within the application. If you're going to go across helpset boundaries this is thee (it may as well be divine) only way to assure access to a content file in another helpset. Since the map files are linked at the master helpset level it is possible to access a content file through the mapID.

The trick is doing this in the content viewer because you can't use a URL to do it. The only way I know of doing this is to write a light-weight component that transform the text with underlines, turns blue, or whatever when the file existed and is normal text when it doesn't. This is very similar to the code that currently exists for secondary and popup windows lightweight component. In fact this code optionally already handles mapIDs. Copying that code and parring it down should be be pretty simple.

So there is a workaround and all you have to do is use it.

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.

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

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

David Cagle wrote:
> Roger, Do you have any words of wisdom for people that cross-link
> helpsets that are not merged? Our helpsets are separate entities but
> do reference documentation from each other. Any words of advice
> besides don't do it?

Don't do it is my first reaction, but if you understand the contraints
there are ways around it. Give me some additonal details how the
non-merged help works. What happens when you switch from one helpset to
another. Is there any way that you might have access to the other
helpset objects?

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.