JDK API リファレンスのEclipseヘルプ化

とりあえずやってはみたのですが、便利かどうかは微妙です。

toc.xml の生成 （Java TOC Doclet）

JavaTOC ドックレットと Javadoc を実行すると、Java API リファレンス・マニュアル、目次 (TOC) ナビゲーション、そしてプラグイン構造を生成することができます。あるいは JavaTOC ドックレットだけを実行し、開発者から提供された既存のマニュアルから TOC ナビゲーションを生成することも可能です。

JavaTOC ドックレットを使って生成する Eclipse Javadoc API リファレンス構造　（IBM developerWorks）

”%JDK_HOME%\src.zip"を展開して、APIのソースコードより、Eclipseヘルプのplugin.xmlファイル、toc.xmlファイルを生成します。JDK APIのJavadocドキュメントは、Sunのサイトよりダウンロードしておきます。

コマンドは以下のようにしました。

javadoc -J"-Xmx512m" @config @options @package-list

config ファイル :

-doclet com.ibm.malup.doclet.config.TOCDoclet
-docletpath C:\JavaTOC\bin\TOCNavDoclet.jar

options ファイル :

-sourcepath ./src
-d ./output/java.doc.api
-overview ./docs/api/overview-summary.html
-version "1.5.0"
-provider "Sun Microsystems"

package-list ファイル:

JDK API ドキュメントの"docs\api"フォルダにあるものを使用。

plugin.xml, toc.xml の編集

生成されるファイルなのですが、微妙に違っていて、そのままでは使えません。何箇所か手を入れます。

1. plugin.xml に、生成された toc.xml をすべて追加

Eclipseヘルプシステムは、plugin.xml に記述された toc.xml だけを認識するようです。生成された当初は、 primary.plugin.toc.xml しかありませんので、toc.xml をすべて追加します。

<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.0"?>

<plugin>

  <extension point="org.eclipse.help.toc">

    <toc file="primary.plugin.toc.xml" primary="true"/>
    <toc file="java.applet.toc.xml" />
    <toc file="java.awt.color.toc.xml" />
    <toc file="java.awt.datatransfer.toc.xml" />
    <toc file="java.awt.dnd.toc.xml" />
    <toc file="java.awt.event.toc.xml" />

    <!-- 中略 -->

    <toc file="org.xml.sax.ext.toc.xml" />
    <toc file="org.xml.sax.helpers.toc.xml" />
    <toc file="org.xml.sax.toc.xml" />
  </extension>

</plugin>

２. primary.plugin.toc.xml に ”anchor” 要素 を追加

id="java.packages" として ”anchor” 要素 を追加 します。

<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>

<toc label="Java 2 Platform Standard Edition 5.0 API Specification">
   <topic label="Overview" href="topics/overview-summary.html" />
   <topic label="Packages">
    <anchor id="java.packages" />
   </topic>
</toc>

3. "link_to" 属性のパスを編集

toc.xml ファイルの "toc"要素 "link_to"属性にあるパスを修正します。例えば、"java.applet.toc.xml"なのですが、なぜかパスが一段上になっています。パッケージのトップレベルに該当するファイルは全部こうなってますので、修正します。

<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>

<toc label="java.applet Package" link_to="../primary.plugin.toc.xml#java.packages">

<!-- 中略 -->

</toc>

以下のように、パスを揃えます。

<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>

<toc label="java.applet Package" link_to="primary.plugin.toc.xml#java.packages">

<!-- 中略 -->

</toc>

4. "build.properties" ファイル

"bin.includes"に必要なファイル・フォルダを含めます。

bin.includes = META-INF/,\
               plugin.xml,\
               primary.plugin.toc.xml,\
               java.applet.toc.xml,\
               java.awt.color.toc.xml,\

               ; 中略

               org.xml.sax.ext.toc.xml,\
               org.xml.sax.helpers.toc.xml,\
               org.xml.sax.toc.xml,\
               topics/

"topics"以下に、JDK API ドキュメントの"docs\api"以下をコピーします。

5. Eclipseプラグイン・プロジェクトでテスト・ビルド

Eclipseプラグイン・プロジェクトでテストを行なった後、 jar ファイルをエクスポートして完成です。