summaryrefslogtreecommitdiff
path: root/fml/doc/ja/tutorial/devel
diff options
context:
space:
mode:
authorfukachan <fukachan>2002-07-06 14:55:14 +0000
committerfukachan <fukachan>2002-07-06 14:55:14 +0000
commitfdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c (patch)
treedc5434385deac2555f0bef29b4c71eee069edd18 /fml/doc/ja/tutorial/devel
parent0fef7ae28f858bb5ac669b5c5b4657b3e9063b77 (diff)
downloadfml8-fdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c.tar.gz
fml8-fdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c.tar.bz2
fml8-fdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c.zip
clean up/update
Diffstat (limited to 'fml/doc/ja/tutorial/devel')
-rw-r--r--fml/doc/ja/tutorial/devel/create_program.sgml40
-rw-r--r--fml/doc/ja/tutorial/devel/cvstree.sgml38
-rw-r--r--fml/doc/ja/tutorial/devel/docbook.sgml20
3 files changed, 67 insertions, 31 deletions
diff --git a/fml/doc/ja/tutorial/devel/create_program.sgml b/fml/doc/ja/tutorial/devel/create_program.sgml
index 2dc90832..38c6961c 100644
--- a/fml/doc/ja/tutorial/devel/create_program.sgml
+++ b/fml/doc/ja/tutorial/devel/create_program.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: create_program.sgml,v 1.3 2002/04/01 23:41:01 fukachan Exp $
+ $FML: create_program.sgml,v 1.4 2002/07/02 10:39:31 fukachan Exp $
-->
<chapter id="program.create">
@@ -34,7 +34,9 @@ verify_request()
run()
finish()
</screen>
-ダミーでもよいので、このメソッドを用意しておいて下さい。
+ダミーでもよいので、これらのメソッドを適宜用意しておいて下さい。
+各メソッドの具体例は、FML::Process を見て下さい。
+メソッドの役割を知るためには最大構成の Distribute が一番適当かも知れません。
</para>
<para>
@@ -55,16 +57,21 @@ FML::Process::○○○
を用意したら、
FML::Process::Switch
を編集します。
-このモジュールは、各プログラムごとに
+このモジュールでは、各プログラムごとに
『ロードするモジュール』
『コマンドラインオプション』
『ML名を必要とするか否か?』
-などを定義してください。
-編集する場所は fmlsch などの文字列を頼りにサーチすると良いでしょう。
+を定義してください。
+編集する場所は以下の private method です。
+<screen>
+sub _module_specific_options
+sub _ml_name_is_required
+sub _module_we_use
+</screen>
</para>
<para>
-この 2 つの準備だけで、準備は終りですです。
+この 2 つの準備だけで、新しいプログラムの準備は終りですです。
呼びたい名前のファイルを loader と link もしくは symlink することで
実行が可能になります。
例えば、標準のインストールでは、次のようになっています。
@@ -103,7 +110,7 @@ lrwxr-xr-x 1 root wheel 6 Nov 23 22:10 mead -> loader
CGI のプログラムは
FML::CGI::○○○
というモジュールです。
-CGI 系列では次のような、オブジェクトの関係にあります。
+CGI 系列では次のような、オブジェクトの関係があります。
<screen>
FML::Process::Kernel
|
@@ -119,9 +126,10 @@ CGI 系列では次のような、オブジェクトの関係にあります。
</para>
<para>
-CGI のプログラムの書き方も同様です。
-コマンドラインのプログラムと同様に、
-FML::CGI のモジュールを見本にして、
+CGI のプログラムの書き方もコマンドラインプログラムと同様です。
+名前空間で区別するために CGI スクリプトのモジュールは
+FML::Process ではなく FML::CGI に配置されています。
+既存の FML::CGI のモジュールを見本にして、
FML::CGI::○○○
を適宜用意して下さい。
</para>
@@ -129,7 +137,7 @@ FML::CGI::○○○
<para>
FML::CGI::○○○ の注意点は、
-用意するメソッドは
+用意するメソッドが
<screen>
html_start()
html_end()
@@ -148,13 +156,18 @@ run_cgi_options()
</para>
<para>
+これらは FML::Process::CGI の中の
+verify_request() および run() から呼ばれた先のメソッドとなっています。
+</para>
+
+<para>
CGI プロセスは FML::Process::CGI で駆動され、run() メソッドは
<screen>
$curproc->html_start($args);
画面を作るために run_cgi_xxx() メソッド郡を呼び出す。
$curproc->html_end($args);
</screen>
-のように FML::CGI:: 以下のメソッド群を呼び出しているからです。
+の順に FML::CGI:: 以下のメソッド群を呼び出しています。
</para>
<para>
@@ -164,7 +177,8 @@ $curproc->html_end($args);
<para>
このため、多くの場合
FML::Process::Kernel
- のメソッドは呼ばれてはいません。
+ のメソッドは CGI::Kernel でオーバロードされており、
+ 直接呼ばれることは稀です。
</para>
</footnote>
からなっています。
diff --git a/fml/doc/ja/tutorial/devel/cvstree.sgml b/fml/doc/ja/tutorial/devel/cvstree.sgml
index 220fb338..cf394bf5 100644
--- a/fml/doc/ja/tutorial/devel/cvstree.sgml
+++ b/fml/doc/ja/tutorial/devel/cvstree.sgml
@@ -1,5 +1,5 @@
<!--
- $FML
+ $FML$
-->
<appendix id="cvs.dirhier">
@@ -15,17 +15,16 @@
</title>
<para>
-fml-devel の基本方針として、
+&fmldevel; の基本方針として、
使えるもの(例えば CPAN )は片っ端から使います。
-そうしないと保守する項目が増える一方のためです。
+そうしないと自分で保守しないといけない項目が増える一方のためです。
</para>
<para>
-また、保守する人をはっきり区別するためにベンダーごとにディレクトリを分
-けています。例えば CPAN で保守されているものは CPAN/ ディレクトリ以下
-に入れてください。
-ライセンスなどによっては、
-将来さらに区分を分ける必要が出てくるかも知れません。
+また、保守する人とライセンスをはっきり区別するためにベンダーごとにディ
+レクトリを分けています。例えば CPAN で保守されているものは CPAN/ ディ
+レクトリ以下に入れてください。ライセンスなどによっては、将来さらに区分
+を分ける必要が出てくるかも知れません。
</para>
<para>
@@ -158,6 +157,16 @@ CPAN/dist/ はオリジナルを保存する場所なので、変更してはいけません。
<tbody>
<row>
+ <entry> fml/bin/ </entry>
+ <entry> /usr/local/bin/ にインストールするプログラム </entry>
+ </row>
+
+ <row>
+ <entry> fml/doc/ </entry>
+ <entry> Documentation/ のソース </entry>
+ </row>
+
+ <row>
<entry> fml/etc/ </entry>
<entry> 設定変数 </entry>
</row>
@@ -177,6 +186,19 @@ CPAN/dist/ はオリジナルを保存する場所なので、変更してはいけません。
呼び出すので、正確には wrapper です。
</entry>
</row>
+
+ <row>
+ <entry> fml/share/ </entry>
+ <entry> メッセージのテンプレートなど </entry>
+ </row>
+
+ <row>
+ <entry> fml/utils/ </entry>
+ <entry> ユーティリティですが、
+ これは
+ fml ソース内で使うだけです。
+ </entry>
+ </row>
</tbody>
</tgroup>
diff --git a/fml/doc/ja/tutorial/devel/docbook.sgml b/fml/doc/ja/tutorial/devel/docbook.sgml
index 2c94e345..c2f6c347 100644
--- a/fml/doc/ja/tutorial/devel/docbook.sgml
+++ b/fml/doc/ja/tutorial/devel/docbook.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: docbook.sgml,v 1.3 2002/04/01 23:41:01 fukachan Exp $
+ $FML: docbook.sgml,v 1.4 2002/07/02 10:39:31 fukachan Exp $
-->
@@ -19,7 +19,7 @@ fml-devel (&fmldevel;) のドキュメントでは、SGML の DTD は
</para>
<para>
-ここでは、SGML を書くために最小限必要な知識についてメモします。
+本章では、SGML を書くために最小限必要な知識についてメモします。
</para>
<para>
@@ -31,7 +31,7 @@ fml-devel (&fmldevel;) のドキュメントでは、SGML の DTD は
</para>
</footnote>
ですが、正しい HTML の書き方と同様です。
-本 Appendix で、2、3の典型的な SGML テンプレートをメモしておくので、
+本 Appendix で、2、3 の典型的な SGML テンプレートをメモしておくので、
それらを適当に切り剥ぎしていけばなんとかなるはずです。
</para>
@@ -48,7 +48,7 @@ SGML は本や短い文書(記事)を作成するに使います。
HTML のもっと厳密なものだと思って下さい
<footnote>
<para>
- 正確には HTML が SGML の一部です。
+ 正確には HTML が SGML の一部にフォーマッタの要素が合体してしまったものです。
HTML の方がはるかに有名になってしまったので、
「HTML のもっと厳密なもの…」といった説明が良くされます :)
</para>
@@ -385,14 +385,14 @@ include するべき定義ファイルを
<para>
SGML を HTML などに翻訳するために、いくつかのツールが必要です。
-DTD と DSL の規格文書群は必須です。
-処理系として openjade と opensp
+また DTD と DSL の規格文書群も必須です。
+処理系としては openjade と opensp
<footnote>
<para>
opensp は openjade パッケージに含まれています。
</para>
</footnote>
-も必須のプログラムです。
+が必須のプログラムでしょう。
その他はオプショナルで、各自が好きにすればよいようです。
</para>
@@ -420,8 +420,8 @@ DTD と DSL の規格文書群は必須です。
</listitem>
</itemizedlist>
-
-多くの OS では附属のパッケージシステムで一発ポン!てなもんでしょう。
+多くの OS ではこれらのプログラムを附属のパッケージシステムで簡単に
+インストールできるでしょう。
</para>
<para>
@@ -499,7 +499,7 @@ HTML の各ページに URL をつけたいとか、画像をつけたいといった
<para>
見栄えは DSL により記述をすることになります。
-しかしながら、DSL は本質的に LISP (List Processre) 言語なので、
+しかしながら、DSL は本質的に LISP (List Processor) 言語なので、
LISP を知らないとちょっと手が出ないでしょう。
</para>