QuickHelp with javadoc

ajmoraal · Post by **ajmoraal** » Fri Feb 23, 2007 3:40 pm

Somehow I can't get quickhelp to index the jdk1.5 docs from Sun. I downloaded the whole docs package and unpacked it in a local directory. Then I try to create a quickhelp index with filter 'Java Document', select to the docs/api/index-files/index-1.html and click on the 'Add >>' button. I get an hourglass cursor for a couple of seconds and then Zeus reports that no information is found in the index file.

Does it only work for jdk1.4 docs - maybe Sun changed something in format of the 1.5 docs?

Post by **jussij** » Sat Feb 24, 2007 1:24 am

The Zeus Java Doc Quick Help was implemented many years ago, probably around JDK 1.1, so more than likely things have changed in the SDK which is why it is no longer worling

But there is an easy fix

I would suggest is using a JDK converted to CHM format. For more details refer to this link:

http://www.zeusedit.com//forum/viewtopic.php?t=10

Cheers Jussi

ajmoraal · Post by **ajmoraal** » Sat Feb 24, 2007 8:32 am

Thanks Jussi. I'm indeed using a downloaded CHM help file now, which works perfectly for the jdk15 docs.

Problem is I use a lot of 3rd party libraries that come with javadoc as well. I tried several javadoc2chm tools to convert the javadoc to chm. Unfortunately all tools I tried generate chm files that don't work with the HtmlHelp provided with WinXP SP2/IE7.

Is the code in Zeus that tries to parse the index-xx.html somewhere in a script so I can try to change it myself?

Post by **jussij** » Sat Feb 24, 2007 11:22 pm

The parsing is deep inside Zeus

But if you send me a few (ie say 1 or 2 of the index files and 10 or so of the actual API files) from the JDK 1.5 Java Doc, I will try to find out why is no longer working.

Just put them into a Zip file and send it to jussij@zeusedit.com with the topic of Zeus Java Doc.

Cheers Jussi

Post by **jussij** » Sun Feb 25, 2007 2:04 am

I had a look at the Zeus Quick Help Java Doc code and I think I have found the issue

It looks like the Quick Help code was recently changed for CHM and this by accident has broken the Java Doc Quick Help

To test this theory could you zip up the your JDK zix files found in the zHelpt Zeus directory and send them to me as an e-mail attachment.

From what I can tell the indexing of the Java Doc is working fine, but the searching is broken. These zix will show if the indexing is in fact working.

Cheers Jussi

ajmoraal · Post by **ajmoraal** » Mon Feb 26, 2007 9:00 am

I'm afraid it must be the indexing, no zix files are created.

I will send you some index and api files.

Post by **jussij** » Mon Feb 26, 2007 11:55 am

Thaks for sending me the index files.

From the these files is seems the indexing problem is caused by the fact the files are saved in unix file format.

As a test you could try opening these index files and saving them in MS-DOS format. While I am pretty sure this will fix the indexing issue, I don't think it will get around the index searching bug that is in the Zeus code itself

But the good news is both of these issues will be fixed in the next patch

Cheers Jussi

ajmoraal · Post by **ajmoraal** » Mon Feb 26, 2007 12:15 pm

Thanks, saving the files as DOS indeed solved the indexing issue, it is now creating a zix file that looks ok when opened in the editor.

But as you mentioned looking up a word using Alt-Q doesn't work, Zeus always responds with a 'topic not found' message in the status bar. I'll wait for the next patch.

Post by **jussij** » Wed Feb 28, 2007 10:29 pm

Java Doc support should now be working in the latest Zeus patch: http://www.zeusedit.com/forum/viewtopic.php?t=1064

Cheers Jussi

ajmoraal · Post by **ajmoraal** » Thu Mar 01, 2007 8:48 am

Hmm.. it's getting closer but not working yet.

The files are indexed ok. But when I put my cursor on the word String and press Alt-Q, it activates the browser with the file:
/api/javax/swing/AbstractAction.html#AbstractAction(java.lang.String)
it should of course load
/api/java/lang/String.html

Another example: putting the cursor in the word File in "new File(filename)" and pressing Alt-Q opens
/api/java/io/FileFilter.html#accept(java.io.File)
instead of
/api/java/io/File.html

Post by **jussij** » Thu Mar 01, 2007 10:12 pm

The files are indexed ok. But when I put my cursor on the word String and press Alt-Q, it activates the browser with the file:
/api/javax/swing/AbstractAction.html#AbstractAction(java.lang.String)
it should of course load
/api/java/lang/String.html

What has happened in the JDK HTML files there is this an entry defined as AbstractAction(String) and the quick help index search found the String which is part of this keyword

For example if you had done a search for AbstractAction it would have loaded the correct file

I will look to change the searching to fix this.

In the mean time you can fix this by manually editing the quick help index files and running this regular expression search and replace:

Code: Select all

   search: [b]\(+[a-zA-Z]+\)\t[/b]
  replace:

Cheers Jussi

Post by **jussij** » Tue Mar 20, 2007 6:23 am

This bug is fixed in the latest Zeus patch found here: http://www.zeusedit.com/forum/viewtopic.php?t=1075

Cheers Jussi