The Ja-Jakarta Project
Apache Jakarta Project

作業用ツール

Ja-Jakartaプロジェクトでは、次のようなツールを使用して作業します。 サブプロジェクトで使用するツールによって、翻訳方法も変わってくることに注意してください。

  1. javadocコマンド/javadocタスク
  2. Localization Doclet
  3. Antのstyleタスク
  4. Anakia
  5. Stylebook
  6. Forrest
javadoc
概要

javadocは、Javaソースコードから、APIドキュメントを作成するために使用します。

Ja-Jakartaプロジェクトでは、今後はLocalization Docletと併用していくことを検討してます。

国際化パラメータの設定
ロケール 入力 出力
コマンドライン -localeオプション -encodingオプション -docencodingオプション
Antのjavadocタスク locale属性 encoding属性 docencoding属性
問題点

以前のバージョンには次のバグが存在したために、バージョン1.4.1以上を勧めます。

Localization Doclet
概要

Localization Docletは、APIドキュメントの地域化を容易にするために使用するツールです。 Javaソースコードに直接手を加えずに、コメント部分だけを別ファイルに分離して、それだけを翻訳することができます。 Antのjavadocタスクでも、そのまま使用できます。 次のWebページに詳しい説明があります。

http://java.sun.com/j2se/javadoc/faq/index.html#localizationdoclets

実際の作業は、次の3段階に分けられます。

  1. ソースコードからコメント部分を抽出します。
    Pre-Process Localization Docletを使用して、Javaソースコードのコメント部分を.cmntファイルとして抽出します。
  2. コメント部分(.cmntファイル)を翻訳します。
  3. 日本語APIドキュメントを生成します。
    Post-Process Localization Docletを使用して、Javaソースコードと翻訳済み.cmntファイルからAPIドキュメントを作成します。
入手方法

このツールは、一般公開されていませんが、docs@java.sun.comに問い合わせれば使用が許可されます。

なお、Ja-Jakartaプロジェクトは、すでに団体として使用許可を受けています(他の目的に使用する場合は、再度許可を取り直す必要があります)ので、芦沢嘉典さんに連絡すれば、直接送ってもらえます。

国際化パラメータの設定
ロケール 入力 出力
LocalDoclet - デフォルト値に固定 デフォルト値に固定

現在、Localization Docletは、プラットフォームのデフォルト文字エンコーディングしか受け付けません。

問題点

次の問題点があります。

  1. Javaソースコードが、プラットフォームの文字エンコーディングで記述されていなければならない。
  2. コメント中に文字参照(И、 など)を使用する場合には、&を&と記述しなければならない。
Antのstyleタスク
概要

Antのstyleタスクは、XMLで記述したドキュメントを、XSLTプロセッサを使用して、HTML形式に変換します。 たとえば、TomcatやStrutsのドキュメントは、これを用いて生成されます。

国際化パラメータの設定
ロケール 入力 出力
XMLファイル - 先頭のXML宣言(<?xml version="1.0" ?>)にencoding="…"を追加 -
XSLファイル - - xsl:output要素にencoding="…"を追加
Anakia
概要

Anakiaは、JDOMとVelocityを使用して、指定したフォーマットでXML文書をHTML文書に変換するツールです。 たとえば、JakartaプロジェクトのWebサイト構築に使用されています。

国際化パラメータの設定
ロケール 入力 出力
velocity.properties - input.encoding="…"を追加 output.encoding="…"を追加
問題点

velocity.propertiesを指定した時にはtemplatePath属性が無視されるというバグがあるようです。 この場合には、velocity.propertiesに"file.resource.loader.path=…"という行を追加して指定して回避することができます。

StyleBook
概要

Xerces / Xalanを利用したWebドキュメントの生成ツールです。 一般公開はされておらず、メンテナンス・サポートもすでに打ち切られていますが、現時点ではまだCactusのドキュメント作成に使用されています。

Antのstyleタスク同様、XMLで記述したドキュメントをXSLTプロセッサを使用して HTML形式に変換します。

国際化パラメータの設定
ロケール 入力 出力
XMLファイル - 先頭のXML宣言(<?xml version="1.0" ?>)にencoding="…"を追加 -
XSLファイル - - xsl:output要素のencoding="…"指定を無視
プロジェクトファイル - - create"タスクのencoding属性を指定 (注1)

注1: ただし、Ja-Jakarta Projectが独自で作成した国際化パッチが必要です。

Forrest
概要

StyleBookやVelocityに代わるWebドキュメントの生成ツールです。 Apache XML Projectのサブプロジェクト(http://xml.apache.org/forrest/index.html)として、2002年に新設されました。

プログラムやドキュメントが完全に整備されていないため、まだ実用化の段階に至っておらず、今のところ、Jakarta Projectへの導入実績はありません。

なおForrestに関する日本語訳・日本語化作業は、JAXMLプロジェクトで進められています。


Copyright © 1999-2004, The Ja-Jakarta Project