RE: Calling javadoc from within HTML Help

Subject: RE: Calling javadoc from within HTML Help
From: David Price <price -at- ontos -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 22 Jan 2001 10:44:19 -0500

Thanks, Richard, you got it right on the money -- relative links do not work
within an HTML file that is linked from HTML Help. The proof is that I've
linked to a javadoc page that has both a relative link and a link to another
section in the same page. The relative link doesn't work, the other one
does. So much for HTML Help.

One thing that's interesting about the way javadoc creates links is that a
link to a named anchor on the same page could be created in two ways: 1) as
a standard link, like <A HREF="#method_summary">, which works fine, or 2) as
a relative link _to the same page_ -- for example, <A
HREF="../../../../com/objects/dsl/base/IDslEntity.html#find">, which will
link to the "find" named anchor on the same (current) page.

I'll try your suggestion about using HTML Help Workshop to make the CHM from
the HTML files -- I had limited success with importing them into Robo. But
I'll probably just use WebHelp. Or maybe I'll write a little program to fix
up the relative links in the javadoc.

- David

> [I] would like to be able to link to that documentation from
> within an HTML Help
> project. When I call a javadoc page from within HTML Help, it
> is displayed
> correctly, but I can't follow any of the links on the javadoc
> page (page not
> found error).

While far from an expert, I've been fiddling with this lately.

The problem lies within the HTML help spec. You can only call external html
files with a fixed (i.e. not relative) path. Javadoc generates the
documentaion with relative path links. I don't know for sure, but I doubt
you can change this, since it has to do with the way java is structured,
class hierarchies=path, etc.

The exact behavior you are seeing is probably explained by the whole
relative path thing. There are some workarounds that should work which I
have not tried yet, and many things I have tried that don't work.


Richard Smith

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. or toll-free 877/278-2131.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: Calling javadoc from within HTML Help
Next by Author: RE: Source Code Documentation Systems?
Previous by Thread: RE: Calling javadoc from within HTML Help
Next by Thread: salary survey suggestions

What this post helpful? Share it with friends and colleagues:

Sponsored Ads