JDK 1.5 doc CHM coming!

I have set up one plan to give you javadoc_api chm up to the minute !

See the URL : http://dev.trueice.net/project/javadoc_chm/

English Introduce

"chm" type is the best convenient document type for developers to look over technique documents on MSWindows platform.

One chm type javadoc api document is more convenient than html documents : you can gather your data in one file with many functions : Hierarchy directory, index , full text search , bookmark.

I wrote one tool to do these things on today afternoon when jsdk1.5 released! It's name is " html2chm" , It is a java based tool for converting any structual directory with html documents into chm. we can use it to convert pure javadoc into chm , convert JDK doc into chm , any html documents into chm.

Why did I make it?

many fellows(include me) were used to Franck's chm(http://www.confluent.fr/javadoc/tutoriale.html) , but it's not up to the minute , only several documents (jdk ..?) , guide directory is jumbled and without com.sun.* api in jdk.

Java third party lib's api documents are so jillion, where we can get their chms? then many fellows were used to JDoc2chm, but it's commercial and directory structure is flat.

So I made this tool to make my ideal javadoc chm.

Reason 1 : I determine to give out javadoc api(sun's and third part's) chm up to the minute.

Reason 2 : JDK and JDK addition(com.sun.*).

Reason 3 : One highlight ?Live API" : it can give you one live java API show by distinguishing things with icon. I think you will love it after using :-)

doc package class field interface enum exception error annotation construct method

Note: Only j2sdk and j2ee 's chm documents are NOT with "Live API" . because they're so big and the speed problem.

[1828 byte] By [StevenZou] at [2007-9-30 18:50:13]
# 1
This is excellent!But where is the source code for your translator?
scorbett at 2007-7-6 21:07:50 > top of Java-index,Administration Tools,Sun Connection...
# 2

> "chm" type is the best convenient document type for developers to look over technique

> documents on MSWindows platform.

That's a big dose of opinion there.

What's so special about CHM files that the HTML files don't provide? I have "live links", an index, and a full cross-reference in the HTML documentation. The one CHM example I looked at from your site (the last link - something-xml) didn't have half this stuff.

And HTML is many, many times more portable than CHM. Why are you even bothering? Sorry to pour cold water over your enthusiasm, but perhaps you could divert that energy into something more multi-platform friendly?

shankar.unni at 2007-7-6 21:07:50 > top of Java-index,Administration Tools,Sun Connection...
# 3

> What's so special about CHM files

> that the HTML files don't provide? I

> have "live links", an index, and a full

> cross-reference in the HTML

.chm allows you to search through the documentation for specific words. This is something that you can't do with a large set of html files (well, if you use the OS tools at your disposal, yes, but it's nice to have a search capability built into the app you use to view the docs).

So for example, find me every class in the Java API that has a getInstance() method. With a .chm, that's just one search away, but with a set of html files, you have to drop to the OS and do a recursive grep on every file. Perhaps not a huge pain in the butt, but still...

scorbett at 2007-7-6 21:07:50 > top of Java-index,Administration Tools,Sun Connection...
# 4
However, having said that, I agree with you that .chm is much less portable than html.
scorbett at 2007-7-6 21:07:50 > top of Java-index,Administration Tools,Sun Connection...
# 5
What I really want to know right about now is if thare are any Java based clients/readers for CHM files ?It's pretty hard to be cross-platform if your help files are locked to just one.RegardsA.Grandt
AGrandt at 2007-7-6 21:07:50 > top of Java-index,Administration Tools,Sun Connection...
# 6
I couldn't find that tool, because the page is not available any more; does somebody knoe how can I get it ?
bzaharie at 2007-7-6 21:07:50 > top of Java-index,Administration Tools,Sun Connection...