P5Doclet

processing(proce55ing)アプリケーションのアプレット生成用ツールです。processingスケッチブックの'Export to web'と同様の動作をしますが、以下の違いがあります。

• アプレットページやソースコードページ用のテンプレートを利用できます
• アプリケーションの説明文をソースのコメントに書くことができ、説明文はアプレットページに書き込まれます
• processingアプリケーションのAPIドキュメントを生成できます
• doclet(Javadoc)として動作するので、Eclipseに組み込んで利用できます

P5DocletはJ2SDK1.4.2_04のjavadocで動作します。

出力例

• Rallx
• EsCave

ダウンロード

P5Docletはフリーソフトウェアです。

• p5doclet0_1.zip(33,861bytes)

bclasses.jarの生成

最初にprocessingアプレットの基本クラスを含む'bclasses.jar'を生成してください。

'bclasses.jar'を生成するには、processingのスケッチブック(processing.exe)で、

1. [File] -> [New]
2. [File] -> [Rename] として 'bclasses'と入力
3. [File] -> [Export to web]

bclasses.jarは'{processing root}/sketchbook/default/bclasses/applet/bclasses.jar'に生成されます。

Eclipseで使う

1. processingアプリケーション用のプロジェクトを生成
   (P5 vs Eclipseを参照)
2. アプリケーションを書く
   • '@p5'タグをコメント内で使うことで出力されるHTMLファイル内に埋め込まれる文字列を指定することができます
3. 以下のファイルを'{project home}'にコピー
   • applet_template.html - アプレットページのテンプレート
   • source_template.html - ソースコードページのテンプレート
   • bclasses.jar - processingアプリケーションの基本クラスを含むjarファイル
4. このプロジェクトのJavadocを生成
   • [Project] -> [Generate Javadoc]
   • [Use Custom Doclet] をチェック
   • [Doclet name] を 'jp.gr.java_conf.abagames.p5doclet.P5Doclet' にセット
   • [Doclet classs path] を '{p5docletのzipを展開したディレクトリ}/p5doclet/p5doclet.jar' にセット
   • [Finish] を押す

HTMLファイルとjarファイルは'{project home}/doc/'の下に生成されます。

APIドキュメントを生成したい場合は、

1. 'applet_template.html'を編集して'[[javadochtml]]'タグを追加して、APIドキュメントへのリンクを設定
   (例 <a href="[[javadochtml]]">API Document</a>)
2. Javadocを生成
   • [Create Javadoc for members with visibility] の [Package] をチェック
   • [Next] を押す
   • '-apidoc' を [Extra Javadoc options] に追加
   • [Finish] を押す

スケッチブックで使う

1. スケッチブックでアプリケーションを書く
2. [Export to web] を行う
3. 以下のファイルを '{project home}/applet/' にコピー
   • applet_template.html - アプレットページのテンプレート
   • source_template.html - ソースコードページのテンプレート
   • p5doclet.jar - p5docletのjarファイル
   • p5doclet.bat - doclet起動用バッチファイル
4. 'p5doclet.bat' を編集して 'TARGET_FILE' 変数をjavaファイル名に設定
5. 'p5doclet.bat' を起動

HTMLファイルとjarファイルは'{project home}/applet/doc/'の下に生成されます。

コメント

ご意見、ご感想は、cs8k-cyu@asahi-net.or.jpまでお願いします。