summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfukachan <fukachan>2003-07-27 15:31:52 +0000
committerfukachan <fukachan>2003-07-27 15:31:52 +0000
commitead7085e4355d92ee84dd20a7186cbc472867ba3 (patch)
treed956fc0657cf40653b2b4923547d1cc4e67b5be7
parentb42c6bda08ad0d2d1b5ae96de7e90d4e62962742 (diff)
downloadfml8-ead7085e4355d92ee84dd20a7186cbc472867ba3.tar.gz
fml8-ead7085e4355d92ee84dd20a7186cbc472867ba3.tar.bz2
fml8-ead7085e4355d92ee84dd20a7186cbc472867ba3.zip
cleanup
-rw-r--r--fml/doc/en/tutorial/glossary.sgml27
-rw-r--r--fml/doc/en/tutorial/preface.sgml96
-rw-r--r--fml/doc/en/tutorial/terms.sgml6
3 files changed, 85 insertions, 44 deletions
diff --git a/fml/doc/en/tutorial/glossary.sgml b/fml/doc/en/tutorial/glossary.sgml
index e8d07a72..0fbaf5e6 100644
--- a/fml/doc/en/tutorial/glossary.sgml
+++ b/fml/doc/en/tutorial/glossary.sgml
@@ -1,16 +1,16 @@
<!--
- $FML: glossary.sgml,v 1.1 2003/07/24 15:37:35 fukachan Exp $
+ $FML: glossary.sgml,v 1.2 2003/07/26 09:10:39 fukachan Exp $
$jaFML: glossary.sgml,v 1.5 2003/04/15 14:51:34 fukachan Exp $
-->
<glossary id="glossary">
<title>
- Glossary (function and variable names)
+ Glossary (function and variable names convention)
</title>
<glossentry>
- <glossterm> fml 4 </glossterm>
+ <glossterm> fml4 </glossterm>
<glossdef>
<para>
&fml4; series
@@ -19,6 +19,16 @@
</glossentry>
+ <glossentry>
+ <glossterm> fml8 </glossterm>
+ <glossdef>
+ <para>
+ &fml8; series
+ </para>
+ </glossdef>
+
+ </glossentry>
+
<glossentry>
<glossterm> fml-devel </glossterm>
@@ -28,8 +38,9 @@
</para>
<para>
- We call it fml 8, too.
+ same as &fml8; now.
</para>
+
</glossdef>
@@ -153,7 +164,7 @@
<glossdef>
<para>
The first "r" implies "reference".
- This called hangalian form but we use it little in fml8.
+ This called hangalian form but we use it very little in fml8.
</para>
</glossdef>
</glossentry>
@@ -174,7 +185,7 @@
<glossterm> Japanese character set name </glossterm>
<glossdef>
<para>
- JIS SJIS EUC ...
+ JIS, SJIS, EUC ...
</para>
</glossdef>
</glossentry>
@@ -216,9 +227,9 @@ $euc_string = STR2EUC($string);
<para>
By sending the command mail to some address,
- a user can make fml8 action something, such as
+ a user can make &fml8; action something, such as
subscribe, file retrieve, unsubscribe et.al,
- The address is typically $ml-ctl@$domain.
+ The address is typically $ml-ctl@$domain for $ml@$domain ML.
</para>
</glossdef>
diff --git a/fml/doc/en/tutorial/preface.sgml b/fml/doc/en/tutorial/preface.sgml
index 65e18638..b18f7173 100644
--- a/fml/doc/en/tutorial/preface.sgml
+++ b/fml/doc/en/tutorial/preface.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: preface.sgml,v 1.2 2003/07/26 01:31:21 fukachan Exp $
+ $FML: preface.sgml,v 1.3 2003/07/26 04:52:00 fukachan Exp $
$jaFML: preface.sgml,v 1.18 2003/04/15 14:51:35 fukachan Exp $
-->
@@ -12,26 +12,26 @@
<sect1 id="status">
<title>
- fml-devel status
+ &fml8; status
</title>
<warning>
<para>
-&fmldevel; already implemented fundamental functions
-except for configuration editing.
-Several people uses &fmldevel; as operational level.
+&fmldevel; already implemented fundamental functions except for
+editing configuration files. Several people uses &fmldevel; as hobby
+and office mailing list system for a test.
</para>
<para>
-&fml8; is intended to implement almost all &fml4; functions but
-not yet.
+&fml8; is intended to re-implement almost all &fml4; functions but not
+yet enough.
So, if you are interested in the use of special features,
please use
<ulink url="http://www.fml.org/software/fml/menu.html">
-4.0 stable
+&fml4; stable
</ulink>
-.
+series.
</para>
<para>
@@ -55,51 +55,54 @@ for the current status of &fmldevel;.
<para>
&fmldevel; is fully rewritten mailing list driver from scratch to
-re-implement &fml4; The purpose of this project is re-implementation
-of fml mailing list driver system, based on my 10 years experience.
+re-implement &fml4;. The main purpose of this project is
+re-implementation of fml mailing list driver system with reflecting my
+10 years experience on mailing list driver developement.
</para>
<para>
-Roughly speaking, the relatoin between &fml4; and &fmldevel; is
+Roughly speaking, the relation between &fml4; and &fmldevel; is
similar to one between sendmail and postfix.
</para>
<para>
-&fmldevel; re-implements features of &fml4; functions. We redesing
-fml and clean up the function and variable naming convenstion.
+&fmldevel; re-implements features of &fml4; functions. We redesign fml
+and clean up the function and variable naming convenstion. Also, We
+reinforce guide line to the coding style for clean source codes.
</para>
<para>
-For example, when you use &fml4;, you'll find that fml supposes list
-of members is found in the text file on the host. &fml4; inherits the
-assumption through from version 1.0. It affetcts the core part of
-designs. Hence, it is difficult to extend fml IO for the use of RDBMS,
-redundency et.al. We should need to fully rewrite fml core parts.
+For example, when you use &fml4;, you'll find that fml assumes the
+list of members is found in the text file on the host. &fml4;
+inherits the assumption from version 1.0 through 4.0. It affetcts the
+core part of designs. Hence, it is difficult to extend fml IO for the
+use of RDBMS, redundency et.al. In fact, &fml4; supports RDBMS but the
+code is ugly. We should need to fully rewrite fml core parts.
</para>
<para>
-Also, I need a lot of new features. &fmldevel; should provide tiny bug
-tracking system maintatined automatically.
-It is better to co-relate fml with cvs log.
+Also, I want a lot of new features. &fmldevel; should provide tiny bug
+tracking system maintatined automatically. It is better to co-relate
+fml with cvs log. These features help the support by mail and
+developer mailing list. I need it, of course.
</para>
<para>
-Firstly, we need to discuss what we inherit from fml 4.0 design and
-features.
+Firstly, we need to discuss what we should inherit from &fml4; design
+and features, and discard what in &fml4;.
<itemizedlist>
-
<listitem>
<para>
- What we inherit into &fmldevel; from &fml4; ?
+ What we should inherit into &fmldevel; from &fml4; ?
</para>
</listitem>
<listitem>
<para>
- easily customisable ?
+ easily customizable ?
</para>
</listitem>
@@ -112,7 +115,7 @@ features.
</itemizedlist>
-Anyway, we should write code for the further discussion!
+Anyway, we should write codes for the further discussion!
You can find it at the following URL.
</para>
@@ -138,7 +141,7 @@ ftp://ftp.fml.org/pub/fml-devel/
</title>
<para>
-We implement new feature at &fml8; branch.
+We implement new features at &fml8; branch.
&fml4; imports it if needed.
We only have to bug-fix at &fml4; branch.
</para>
@@ -169,13 +172,19 @@ We only have to bug-fix at &fml4; branch.
</title>
<para>
-Send "subscribe YOUR NAME" to fml-users-ctl@ffs.fml.org and you'll
-receive the reply for confirmation.
-Please send back the confirmation again to
-fml-users-ctl@ffs.fml.org.
+fml-users@ffs.fml.org is prepared.
+Use it for English discussion.
+</para>
+
+<para>
+To subscribe it, send the mail with "subscribe YOUR NAME" in the body
+to fml-users-ctl@ffs.fml.org. You will receive the reply for
+confirmation. Please reply the confirmation and send back it to
+fml-users-ctl@ffs.fml.org again.
For example, a subscribe mail is as follows:
<screen>
+From: your-account@your-domain
To: fml-users-ctl@ffs.fml.org
subscribe Kinomoto Sakura
@@ -197,6 +206,27 @@ Please send me the idea on &fmldevel; to the mail address:
<ulink url="mailto:fml-request@fml.org">
fml-request@fml.org
</ulink>
+or myself
+<ulink url="mailto:fukachan@fml.org">
+fukachan@fml.org
+</ulink>
+directly.
+</para>
+
+</sect1>
+
+
+<!-- ======================================================== -->
+<sect1>
+
+ <title>
+ On this tutorial
+ </title>
+
+<para>
+For the &fml4; user, the order of chapters and sections are almost
+same as the book "fml bible" publishded by O'reilly Japan (rewritten
+in Japanese).
</para>
</sect1>
diff --git a/fml/doc/en/tutorial/terms.sgml b/fml/doc/en/tutorial/terms.sgml
index f44734e7..c7ede9c7 100644
--- a/fml/doc/en/tutorial/terms.sgml
+++ b/fml/doc/en/tutorial/terms.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: terms.sgml,v 1.1 2003/07/24 15:37:35 fukachan Exp $
+ $FML: terms.sgml,v 1.2 2003/07/26 09:10:40 fukachan Exp $
$jaFML: terms.sgml,v 1.5 2003/04/15 14:51:35 fukachan Exp $
-->
@@ -13,14 +13,14 @@
<varlistentry>
<term> % </term>
<listitem>
- <para> prompt of a user on the shell </para>
+ <para> user prompt on the shell </para>
</listitem>
</varlistentry>
<varlistentry>
<term> # </term>
<listitem>
- <para> prompt of the user root </para>
+ <para> root user prompt on the shell </para>
</listitem>
</varlistentry>