API リファレンス
ダウンロード
- RSSの取り出しに失敗しました:http://sourceforge.jp/projects/paraselene/releases/rss
ソースファイルは Linux 上での開発する形となっています。
全てのファイルは UTF-8 で書かれています。
アーカイブを展開すると、以下のディレクトリやファイルが存在します。
| No | ファイル/ディレクトリ | 説明 |
|---|---|---|
| 1 | Copyright.txt | 著作権です。 |
| 2 | License.txt | ライセンスです。 |
| 3 | Version.txt | バージョン番号が記載されています。 この内容を変更すると、全ての生成物のバージョン番号が変更されます。 |
| 4 | build.xml | antビルド用の設定ファイルです。 この、展開したディレクトリ構成でのみ正しく動作します。 antを引数なしで実行する事により
ant clean で上記出力ファイル群を削除します。 |
| 5 | js/paraselene.js | Paraseleneが生成するAjax用JavaScriptの元となるソースです。 |
| 6 | output_sample/ | Paraseleneが生成するJavaスケルトンソースの元となるソースを格納しています。 ここにあるテキストファイル中の # は特別な意味を持ちます。 #数値 は、開発者が指定したパッケージ名等に置換される事を表しています。 ## は、# 1個の意味のエスケープ文字列です。 |
| 7 | paraselene/ | Paraselene本体のソースファイル群が格納されています。 |
| 8 | readme/readme.html | スケルトン生成時に作られる Readme.html のモックアップHTMLです。 これもParaseleneのAPIにより生成しています。 |
| 9 | template/ | 開発用の各種ファイルを格納しています。 |
| 10 | tool/ | Paraselene本体のソースファイルの一部はプログラムにより自動生成しています。 その生成用プログラムが格納されています。 |
template/ ディレクトリには、以下のファイルが格納されています。
| No | ファイル | 説明 |
|---|---|---|
| 1 | Version.java | paraselene/Version.javaの雛形です。 ant実行時に、Version.txtを埋め込まれます。 |
| 2 | WebChar.java | paraselene/WebChar.javaの雛形です。 tool/下のプログラムで利用します。 |
| 3 | char.txt | WebChar.javaに埋め込まれるデータです。 |
| 4 | color.txt | paraselene/WebColor.java生成用のテキストファイルです。 |
| 5 | head.txt | 各ソースファイルのヘッダ部となるテキストファイルです。 tool/下のプログラムがソースを出力する際には、これを参照します。 |
| 6 | overview.html | javadoc の概要ページです。 |
tool/ ディレクトリには、以下のファイルが格納されています。何れのものも、tool/ 直下で実行します。各項目の説明にある、元となるファイルに変更があった場合は、このツールを使い新しいソースファイルを作成する必要があります(上書きします)。
また、何れのものもコンパイルまたは実行に際し、paraselene.jarにクラスパスが通っていなければなりません。
注意点として、paraselene.jarのビルドには、ここにあるツールが自動生成したソースファイルが必要です。一方、ここにあるツールが動作するには、正しく動作するparaselene.jarが必要です。鶏と卵のような関係になっています。どちらかにビルド不可能なトラブルが発生すると、復旧が面倒な事になります。
| No | ファイル | 説明 |
|---|---|---|
| 1 | CharMake.class CharMake.java |
java CharMake する事で、template/WebChar.javaとtemplate/char.txt を読み込み、paraselene/WebChar.javaを生成します。 |
| 2 | ColorMake.class ColorMake.java |
java ColorMake する事で、template/color.txt を読み込み、paraselene/WebColor.javaを生成します。 |
| 3 | JsTool.class JsTool.java |
java JsTool する事で、js/paraselene.js を読み込み、paraselene/mockup/下のソースファイルを生成します。 |
| 4 | MockupTool.class MockupTool.java |
java MockupTool する事で、output_sample/ 下のファイルを読み込み、paraselene/mockup/下のソースファイルを生成します。 paraselene.Pageクラス等スケルトンソースの親クラスに変更が発生した場合、paraselene/mockup/下のソースファイルの修正と、このツールの実行が必要となる場合があります。 |
| 5 | readme.sh | ./readme.sh する事で、readme/readme.html からスケルトンソースを生成し、paraselene/mockup/下に配置されます。 このツールもparaselene.Pageクラスと依存関係があります。
|
antを実行する事により、以下のディレクトリが作られます。
| No | ディレクトリ | 説明 |
|---|---|---|
| 1 | api | API リファレンス(javadoc)が格納されています。 |
| 2 | bin | リリース用のバイナリが格納されています。 |
| 3 | classes | paraselene/ 下のソースファイルをコンパイルしたクラスファイルが格納されます。 |
bin/ の下には、以下のファイルが生成されます。
| No | ファイル | 説明 |
|---|---|---|
| 1 | paraselene_バージョン番号.tar.gz | ここで提供しているソース群のアーカイブです。 |
| 2 | paraselene_バージョン番号.jar | paraseleneの本体となるjarファイルです。 |
| 3 | paraselene.jar | No2へのシンボリックリンクです。 この開発環境下では、これにクラスパスを通せばよいでしょう。 |