svnno****@sourc*****
svnno****@sourc*****
2009年 4月 13日 (月) 01:09:14 JST
Revision: 3227
http://svn.sourceforge.jp/view?root=jiemamy&view=rev&rev=3227
Author: daisuke_m
Date: 2009-04-13 01:09:14 +0900 (Mon, 13 Apr 2009)
Log Message:
-----------
ドキュメントの位置を移動。
Added Paths:
-----------
metis/documents/trunk/README.txt
Removed Paths:
-------------
metis/trunk/README.txt
-------------- next part --------------
Copied: metis/documents/trunk/README.txt (from rev 3226, metis/trunk/README.txt)
===================================================================
--- metis/documents/trunk/README.txt (rev 0)
+++ metis/documents/trunk/README.txt 2009-04-12 16:09:14 UTC (rev 3227)
@@ -0,0 +1,59 @@
+■概要
+このプロジェクトは、Jiemamyの各種ドキュメントを生成するプロジェクトです。
+
+pom.xmlが配置されていますが、完全なMaven化には至っておらず、大部分はAntによるビルドになります。
+ドキュメントのビルドは Ant を経由した、Velocity DocBook-Framework-1.0 をベースにしたシステムで
+行っています。（日本語化対応等のため、フレームワークにも手が入っています）
+
+■チェックアウト後の準備
+このドキュメント構築システムはJava Advanced Imaging (JAI)に依存していますが、
+このライブラリは再配布が許可されていない為、各自で配置する必要があります。（svn:ignore済みです）
+
+http://download.java.net/media/jai/builds/release/1_1_3/jai-1_1_3-lib.zip
+上記URLからJAIをダウンロードし、jai_core.jar と jai_codec.jar を src/DocBook-Framework-1.0/lib
+ディレクトリにコピーしてください。
+
+■ドキュメントの生成
+src/docbook/userguide内にdocbook形式のソースを配置し、Antを引数なしで起動することにより、
+target/userguide 内に各種フォーマットのドキュメントが生成されます。
+
+■プロジェクト構成
+簡略化したプロジェクトディレクトリ構成は以下のとおり。
+下記以外のディレクトリは、フレームワーク本体や、あまり編集する必要のない設定ファイル、またはビルドに
+おける中間ファイルが占めています。あまり気にする必要がないところです。
+
+ProjectRoot
+ +- src
+ | +- docbook
+ | | +- userguide
+ | | +- 各種ドキュメントのソース
+ | +- images
+ | | +- 画像リソース
+ | +- test
+ | +- java
+ | +- ドキュメント内で使用するソースコード
+ + target
+ +- userguide
+ +- html
+ | +- 複数ページHTML形式ドキュメント
+ +- htmlsingle
+ | +- 単一HTML形式ドキュメント
+ +- pdf
+ +- PDF形式ドキュメント
+
+■ドキュメント記述方法
+src/docbook/userguide 内のXMLを編集します。
+現在のところ、quickstart 及び editor-reference の２つのドキュメントが定義されていますが、
+新たなドキュメントを追加する際は、build.xmlを編集する必要があります。
+
+ドキュメントファイルはベースとなるdocbook-XMLから XInclude によりインクルードされる形になっており、
+ファイル単位で再利用が可能です。 <xi:include href="***.xml"/> のような形でインクルードして
+ください。
+
+また、Javaソースコードを引用する際は、src/test/java (mainではない) に配置されたコードを
+自動的にドキュメント内に取り込むことができます。（コンパイルされるJavaソースなので、リファクタリングにも
+追従し、テストを通すこともできます。）
+
+com.docbook.sample.SampleClass のような記述をすると、target/codes 内にインクルード用の
+ドキュメント片が生成されます。 <xi:include href="../../../target/codes/***.xml"/>
+のような形でインクルードしてください。
Deleted: metis/trunk/README.txt
===================================================================
--- metis/trunk/README.txt 2009-04-12 16:09:13 UTC (rev 3226)
+++ metis/trunk/README.txt 2009-04-12 16:09:14 UTC (rev 3227)
@@ -1,59 +0,0 @@
-■概要
-このプロジェクトは、Jiemamyの各種ドキュメントを生成するプロジェクトです。
-
-pom.xmlが配置されていますが、完全なMaven化には至っておらず、大部分はAntによるビルドになります。
-ドキュメントのビルドは Ant を経由した、Velocity DocBook-Framework-1.0 をベースにしたシステムで
-行っています。（日本語化対応等のため、フレームワークにも手が入っています）
-
-■チェックアウト後の準備
-このドキュメント構築システムはJava Advanced Imaging (JAI)に依存していますが、
-このライブラリは再配布が許可されていない為、各自で配置する必要があります。（svn:ignore済みです）
-
-http://download.java.net/media/jai/builds/release/1_1_3/jai-1_1_3-lib.zip
-上記URLからJAIをダウンロードし、jai_core.jar と jai_codec.jar を src/DocBook-Framework-1.0/lib
-ディレクトリにコピーしてください。
-
-■ドキュメントの生成
-src/docbook/userguide内にdocbook形式のソースを配置し、Antを引数なしで起動することにより、
-target/userguide 内に各種フォーマットのドキュメントが生成されます。
-
-■プロジェクト構成
-簡略化したプロジェクトディレクトリ構成は以下のとおり。
-下記以外のディレクトリは、フレームワーク本体や、あまり編集する必要のない設定ファイル、またはビルドに
-おける中間ファイルが占めています。あまり気にする必要がないところです。
-
-ProjectRoot
- +- src
- | +- docbook
- | | +- userguide
- | | +- 各種ドキュメントのソース
- | +- images
- | | +- 画像リソース
- | +- test
- | +- java
- | +- ドキュメント内で使用するソースコード
- + target
- +- userguide
- +- html
- | +- 複数ページHTML形式ドキュメント
- +- htmlsingle
- | +- 単一HTML形式ドキュメント
- +- pdf
- +- PDF形式ドキュメント
-
-■ドキュメント記述方法
-src/docbook/userguide 内のXMLを編集します。
-現在のところ、quickstart 及び editor-reference の２つのドキュメントが定義されていますが、
-新たなドキュメントを追加する際は、build.xmlを編集する必要があります。
-
-ドキュメントファイルはベースとなるdocbook-XMLから XInclude によりインクルードされる形になっており、
-ファイル単位で再利用が可能です。 <xi:include href="***.xml"/> のような形でインクルードして
-ください。
-
-また、Javaソースコードを引用する際は、src/test/java (mainではない) に配置されたコードを
-自動的にドキュメント内に取り込むことができます。（コンパイルされるJavaソースなので、リファクタリングにも
-追従し、テストを通すこともできます。）
-
-com.docbook.sample.SampleClass のような記述をすると、target/codes 内にインクルード用の
-ドキュメント片が生成されます。 <xi:include href="../../../target/codes/***.xml"/>
-のような形でインクルードしてください。