diff options
| author | fukachan <fukachan> | 2005-09-28 11:05:48 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2005-09-28 11:05:48 +0000 |
| commit | 8ff58391fa2519616abc3fdc8929f9c8cafbb9a0 (patch) | |
| tree | 17a189889db62f1608b4e92023f320153bf0f976 /fml/doc/en/tutorial/internals | |
| parent | d4c6b7a0d8d7d8d7bfffee7d1f2d8c15950bc194 (diff) | |
| download | fml8-8ff58391fa2519616abc3fdc8929f9c8cafbb9a0.tar.gz fml8-8ff58391fa2519616abc3fdc8929f9c8cafbb9a0.tar.bz2 fml8-8ff58391fa2519616abc3fdc8929f9c8cafbb9a0.zip | |
clean up
Diffstat (limited to 'fml/doc/en/tutorial/internals')
| -rw-r--r-- | fml/doc/en/tutorial/internals/bootloader.sgml | 25 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/cgi.examples.sgml | 6 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/cgi.sgml | 16 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/config.cf.sgml | 35 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/db_modules.sgml | 29 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/design.sgml | 12 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/errormail.sgml | 33 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/filter.sgml | 28 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/hook.sgml | 18 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/io_abstraction.sgml | 34 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/internals/language.sgml | 20 |
11 files changed, 131 insertions, 125 deletions
diff --git a/fml/doc/en/tutorial/internals/bootloader.sgml b/fml/doc/en/tutorial/internals/bootloader.sgml index e7c9d6b8..2b68d4e4 100644 --- a/fml/doc/en/tutorial/internals/bootloader.sgml +++ b/fml/doc/en/tutorial/internals/bootloader.sgml @@ -1,16 +1,16 @@ <!-- - $FML: bootloader.sgml,v 1.13 2005/06/25 15:11:33 fukachan Exp $ + $FML: bootloader.sgml,v 1.1 2005/07/27 12:21:35 fukachan Exp $ --> <chapter id="bootloader"> <title> - &fml8; boot loader to resolv version dependence dynamically + &fml8; Boot Loader To Resolve Version Dependence Dynamically </title> <para> -&fml8; provides a boot loader to resolv version dependence dynamically. -For example, the loader boot straps &fml8; as follows: +&fml8; provides a boot loader to resolve version dependence +dynamically. For example, the loader boot straps &fml8; as follows: <screen> fml (libexec/distribute) boots like this ... @@ -36,7 +36,7 @@ fml (libexec/distribute) boots like this ... <sect1 id="bootloader.example.distribute"> <title> - Case: distribution + Case: Distribution </title> <para> @@ -44,10 +44,11 @@ fml (libexec/distribute) boots like this ... </para> <para> -/usr/local/libexec/fml/distributre (== /usr/local/libexec/fml/loader -in fact) reads /usr/local/etc/fml/main.cf and resolvers the version it -should use from $fml_version variable. Let $fml_version -current-20010501. The loader uses library perl modules under +/usr/local/libexec/fml/distributre (is same as +/usr/local/libexec/fml/loader in fact) reads +/usr/local/etc/fml/main.cf and resolvers the version it should use +from $fml_version variable. Let $fml_version current-20010501. The +loader uses library perl modules under /usr/local/lib/fml/current-20010501/. </para> @@ -74,7 +75,7 @@ argument and drives the object. <sect1 id="bootloader.classes"> <title> - FML::Process:: class structure + FML::Process:: Class Structure </title> <para> @@ -94,7 +95,7 @@ FML::Process::Mead >-| | <sect1 id="bootloader.classes2"> <title> - Modules in process execution + Modules In Process Execution </title> <itemizedlist> @@ -172,7 +173,7 @@ $process->finish($args); <sect1 id="bootloader.resolv.mlxxx"> <title> - Discussion: where function should resolve $ml_name and $ml_domain. + Discussion: Where Function Should Resolve $ml_name And $ml_domain. </title> <para> diff --git a/fml/doc/en/tutorial/internals/cgi.examples.sgml b/fml/doc/en/tutorial/internals/cgi.examples.sgml index bf10702d..7fa66bbf 100644 --- a/fml/doc/en/tutorial/internals/cgi.examples.sgml +++ b/fml/doc/en/tutorial/internals/cgi.examples.sgml @@ -1,15 +1,15 @@ <!-- - $FML: cgi.examples.sgml,v 1.3 2005/06/25 15:11:33 fukachan Exp $ + $FML: cgi.examples.sgml,v 1.1 2005/07/27 12:21:35 fukachan Exp $ --> <sect1 id="cgi.internal.example.isa"> <title> - CGI implementation: inheritance among CGI classes + CGI Implementation: Inheritance Among CGI Classes </title> <para> -@ISA of config.cgi follow: +@ISA of config.cgi follows: <screen> FML::CGI::Menu FML::Process::CGI::Kernel FML::Process::CGI::Param </screen> diff --git a/fml/doc/en/tutorial/internals/cgi.sgml b/fml/doc/en/tutorial/internals/cgi.sgml index 67046cd8..495694ec 100644 --- a/fml/doc/en/tutorial/internals/cgi.sgml +++ b/fml/doc/en/tutorial/internals/cgi.sgml @@ -1,11 +1,11 @@ <!-- - $FML: cgi.sgml,v 1.14 2005/06/25 15:11:33 fukachan Exp $ + $FML: cgi.sgml,v 1.1 2005/07/28 13:27:47 fukachan Exp $ --> <chapter id="cgi.internal"> <title> - Internal of CGI process + Internal Of CGI Process </title> @@ -58,7 +58,7 @@ finish() <sect1 id="cgi.internal.frames"> <title> - Screen of CGI and the method + Screen Of CGI And The Method </title> <para> @@ -96,7 +96,7 @@ sw south se <sect2> <title> - Screen of the current CGI + Screen Of The Current CGI </title> <para> @@ -138,15 +138,15 @@ run_cgi_menu() print out the data. <sect1 id="cgi.internal.trampoline"> <title> - Screen and trampolin mechanism + Screen And Trampolin Mechanism </title> <para> CGI print engine is moved to FML::Command:: class. -However FML::Command:: does not contains all content of pritn engine. +However FML::Command:: does not contains all content of print engine. By object composition, -some modules us methods FML::CGI:: provides. +some modules use methods FML::CGI:: provides. For example, subscribe command internal is as follows. <screen> FML::CGI::Admin::Main -> @@ -162,7 +162,7 @@ The flow goes and back again like trampolin mechanism. <sect1 id="cgi.internal.problems"> <title> - MISC: hard coding is mandatory ? + MISC: Hard Coding Is Mandatory ? </title> <para> diff --git a/fml/doc/en/tutorial/internals/config.cf.sgml b/fml/doc/en/tutorial/internals/config.cf.sgml index db55cee8..8ca66464 100644 --- a/fml/doc/en/tutorial/internals/config.cf.sgml +++ b/fml/doc/en/tutorial/internals/config.cf.sgml @@ -1,18 +1,18 @@ <!-- - $FML: config.cf.sgml,v 1.2 2003/08/03 05:28:48 fukachan Exp $ + $FML: config.cf.sgml,v 1.3 2005/07/27 12:21:35 fukachan Exp $ $jaFML: config.cf.sgml,v 1.11 2003/06/20 22:23:14 fukachan Exp $ --> <chapter id="internal.config.cf"> <title> - Configuration file: config.cf + Configuration File: config.cf </title> <!-- ======================================= --> <sect1 id="config.cf"> <title> - ML specific configuration file: config.cf + ML Specific Configuration File: config.cf </title> <para> @@ -26,7 +26,7 @@ $DIR (e.g. /var/spool/ml). This "config.ph" file is a perl script. </para> <para> -There is a config.cf file in &fmldevel;, too. +There is one configuration file (config.cf) in &fmldevel;, too. But the format is different. The format is like this: <screen> variable = value @@ -61,8 +61,9 @@ It is similar to the conversion from .mc to .cf in sendmail. <para> The use of cf is suitable for configuration tools but introduces another difficulty such as inconsistency between cf and config.ph -since human may edit config.ph but forgets cf editing. So, &fmldevel; -introduces a new format as .cf files. This format is postfix flavour. +since human may edit config.ph but forgets editing cf. So, &fmldevel; +introduces only one configuration file. +It is a new format which is similar to Postfix main.cf. </para> </sect2> @@ -73,12 +74,12 @@ introduces a new format as .cf files. This format is postfix flavour. <!-- ======================================= --> <sect1 id="config.cf.format"> <title> - config.cf format + config.cf Format </title> <para> The format of "config.cf" is "variable = value syntax". -If plural values are required, space or "\n" is a separator. +If plural values are required, space or "\n\s" is a separator. <screen> variable = value @@ -134,7 +135,7 @@ since the last $a overwrites the previous one. <!-- ======================================= --> <sect1 id="config.cf.format.extension"> <title> - Extension to postfix style + Extension To Postfix Style </title> <para> @@ -176,7 +177,7 @@ x = a b c d e <!-- ======================================= --> <sect1 id="config.cf.overload"> <title> - Overload variables in config.cf + Overload Variables In config.cf </title> <para> @@ -194,8 +195,8 @@ ML specific file. </para> <para> -Fml reads these files sequentially. At the last, fml reads ML specific -config.cf and expand variables when variable reading is requested. +&fml8; reads these files sequentially. At the last, &fml8; expands +variables when variable reading is requested. </para> </sect1> @@ -203,8 +204,8 @@ config.cf and expand variables when variable reading is requested. <!-- ======================================= --> <sect1> <title> - Modifying/adding variables - after all configuration files have been loaded. + Modifying/Adding Variables + After All Configuration Files Have Been Loaded. </title> <para> @@ -235,7 +236,7 @@ $config->{ another_key } <sect2> <title> - Internal of variable expansion + Internal Of Variable Expansion </title> <para> @@ -253,7 +254,7 @@ The variable is expanded in calling get() method. <sect1 id="list.variables.by.alphabeticalorder"> <title> - Variable list (alphabetical order) + Variable List (Alphabetical Order) </title> &var.table.list.variables; @@ -263,7 +264,7 @@ The variable is expanded in calling get() method. <sect1 id="list.variables.by.class"> <title> - Variable list (class based) + Variable List (Class Based) </title> &var.table.class.variables; diff --git a/fml/doc/en/tutorial/internals/db_modules.sgml b/fml/doc/en/tutorial/internals/db_modules.sgml index 40f5bd91..55c855a7 100644 --- a/fml/doc/en/tutorial/internals/db_modules.sgml +++ b/fml/doc/en/tutorial/internals/db_modules.sgml @@ -1,5 +1,5 @@ <!-- - $FML: db_modules.sgml,v 1.3 2005/06/25 15:11:33 fukachan Exp $ + $FML: db_modules.sgml,v 1.1 2005/08/03 13:22:06 fukachan Exp $ --> <!-- @@ -9,7 +9,7 @@ <chapter id="db.module"> <title> - Database related module + Database Related Modules </title> @@ -19,16 +19,17 @@ </title> <para> -ML driver needs to hold some data on mail. -some data persistently but some data with expiration (data is -discarded after the interval). +ML driver needs to hold some data on mail. Some data exixsts +persistently but some data with expiration (data is discarded after +some interval). </para> <para> An example of permisistent data is thread database. -The latter case, an exapmle of non persistent data is message-id cache. -The thread database also has message-id cache in it. -But we handle these two data separately. +The latter case, an exapmle of non persistent data, is message-id cache. +The thread database also has message-id cache in it, which is a +sub-set of all message-id set of incoming messages. We handle these +two data separately. </para> <para> @@ -49,7 +50,7 @@ FML::Cache::Ring classes. <para> It is better to use RDBMS for important persistent data such as -address list. This chapter describes persistent data handling for +address list. This chapter describes persistent data handling only for &fml8; internal use. </para> @@ -58,7 +59,7 @@ address list. This chapter describes persistent data handling for <sect1 id="db.module.persistent"> <title> - Persistent data use + Persistent Data Use </title> <para> @@ -76,7 +77,7 @@ for important data. </para> <para> -This chapter describes &fml8; internal use. +This chapter describes only &fml8; internal use. </para> <para> @@ -89,7 +90,7 @@ The type is time saving or space saving. <sect1 id="db.module.Tie.JournaledFile"> <title> - Tie::JournaledFile class + Tie::JournaledFile Class </title> <para> @@ -136,7 +137,7 @@ key => [ <warning> <para> -search algorithm select either of first match or last match. last +Search algorithm is either of first match or last match. The last match by default since the last appended data is latest. </para> </warning> @@ -146,7 +147,7 @@ match by default since the last appended data is latest. <sect1 id="db.module.FML.Cache.Ring"> <title> - FML::Cache::Ring class + FML::Cache::Ring Class </title> <para> diff --git a/fml/doc/en/tutorial/internals/design.sgml b/fml/doc/en/tutorial/internals/design.sgml index ab33f15b..dd9c55f4 100644 --- a/fml/doc/en/tutorial/internals/design.sgml +++ b/fml/doc/en/tutorial/internals/design.sgml @@ -1,11 +1,11 @@ <!-- - $FML: design.sgml,v 1.11 2004/10/06 09:07:38 fukachan Exp $ + $FML: design.sgml,v 1.1 2005/07/28 13:27:47 fukachan Exp $ --> <chapter id="design"> <title> - [LOG] Original Idea of &fml8; project + [LOG] Original Idea Of &fml8; Project </title> @@ -16,7 +16,7 @@ <sect1 id="design.overview"> <title> - the original idea of &fml8; (fml-devel) project + The Original Idea Of &fml8; (fml-devel) Project </title> <para> @@ -48,7 +48,7 @@ of fml-current. <sect1 id="design.idea.detail"> <title> - Details of idea + Details Of Idea </title> <itemizedlist> @@ -153,7 +153,7 @@ of fml-current. <!-- ======================================================== --> <sect1 id="design.refactoring"> <title> - refactoring + Refactoring </title> <table> @@ -176,7 +176,7 @@ of fml-current. </row> <row> - <entry> </entry> + <entry> underway. </entry> <entry> image </entry> <entry> &fml4; to &fml8; is similar to diff --git a/fml/doc/en/tutorial/internals/errormail.sgml b/fml/doc/en/tutorial/internals/errormail.sgml index 020dd96c..39fbbe90 100644 --- a/fml/doc/en/tutorial/internals/errormail.sgml +++ b/fml/doc/en/tutorial/internals/errormail.sgml @@ -1,5 +1,5 @@ <!-- - $FML: errormail.sgml,v 1.7 2005/06/25 14:43:08 fukachan Exp $ + $FML: errormail.sgml,v 1.1 2005/07/28 13:27:48 fukachan Exp $ --> @@ -14,9 +14,9 @@ mead (/usr/local/fml/libexec/mead) of &fml4; </para> <para> -set "$use_error_mail_analyzer_function = yes" to enable error mail +Set "$use_error_mail_analyzer_function = yes" to enable error mail analyzer function. By default, $use_error_mail_analyzer_function is -yes. That is, &fml8; error analyzer is enabled by default but &fml4; +"yes". That is, &fml8; error analyzer is enabled by default but &fml4; not. This default behaviour differs from &fml4;. </para> @@ -31,14 +31,14 @@ In fact, typical functions of &fml8; are enabled by default. </title> <para> -&fml8; sets up that $ml-admin address (address error messages returned -to) calls /usr/local/libexec/fml/error in creating a ML. +In creating a ML, &fml8; sets up that $ml-admin address (address error +messages returned to) calls /usr/local/libexec/fml/error. </para> <para> /usr/local/libexec/fml/error reads a message, analyzes it and creates a chain of Mail::Message objects on memory. Mail::Bounce class -analyzes the detail of error based on the object. +analyzes the detail of error based on the objects. </para> <para> @@ -62,7 +62,7 @@ member/recipient list. <sect1 id="error.internal.algorithm"> <title> - Algorithm of error detection + Algorithm Of Error Detection </title> <para> @@ -83,10 +83,9 @@ determine whether the address is effective or not. </para> <para> -This logic depends on just the total number of errors. If the traffic -of ML is high, little configuration error of recipients caueses -removal of the address soon. -This is the main problem of this logic. +This logic depends on just the total number of errors. If the traffic +of ML is high, even a little configuration error of recipients caueses +removal of the address soon. This is the main problem of this logic. </para> </sect2> @@ -101,10 +100,11 @@ This is the main problem of this logic. Count up the number of continuous days that error messages returned. If the number oversomes the threshold, &fml8; removes the corresponding address. The threshold is 14 days by default. +That implies continuous errors in 14 days. </para> <para> -This logic assumes that the traffic of a ML is at least one message +This logic assumes that the traffic of an ML is at least one message per day. In other words, this logic requires the continuous error. So, little configuration error in the side of recipient has no effect. </para> @@ -125,7 +125,7 @@ message per day, this algorithm does not work. <sect1 id="error.internal.cache"> <title> - Cache of error messages data + Cache Of Error Messages Data </title> <para> @@ -147,14 +147,17 @@ class. All IO should be done via methods provided by FML::Error::Cache. <sect1 id="error.internal.message.forward"> <title> - Forward error messages + Forward Error Messages </title> <para> You can specify the location the error message is forwarded to as $maintainer_recipient_maps variable. -Undefiend by default. +</para> + +<para> +Undefined by default. Error messages are logged at a log file but not forwarded. </para> diff --git a/fml/doc/en/tutorial/internals/filter.sgml b/fml/doc/en/tutorial/internals/filter.sgml index 98625316..86dd8440 100644 --- a/fml/doc/en/tutorial/internals/filter.sgml +++ b/fml/doc/en/tutorial/internals/filter.sgml @@ -1,5 +1,5 @@ <!-- - $FML: filter.sgml,v 1.1 2005/08/03 13:22:06 fukachan Exp $ + $FML: filter.sgml,v 1.2 2005/09/25 04:27:18 fukachan Exp $ --> @@ -32,12 +32,12 @@ e.g. line length limit of one line. <sect1 id="internals.filter.overview"> <title> - Overview of filter system + Overview Of Filter System </title> <para> There are three types of filter system for content check such as for -header, body and mime structure based. Other than the tree cases, we +header, body and mime structure based. Other than the tree cases, we should consider text/plain and non mime text (text/?) filter. So there may be four types of filter. <screen> @@ -64,7 +64,7 @@ may be four types of filter. </screen> Other than these filters, content_filter using SMTP/LMTP can be needed but not implemented. If you need content_filter, please use the -function of postfix. +function of Postfix. </para> <!-- XXX-TODO traffic filter --> @@ -77,7 +77,7 @@ Traffic based filter is also needed but not implemented yet. <sect1 id="internals.filter.config"> <title> - Configuration variables + Configuration Variables </title> <para> @@ -101,7 +101,7 @@ function_A_rules = rule_01 urle_02 <sect1 id="internals.filter.size"> <title> - Size limit + Size Limit </title> <para> @@ -121,7 +121,7 @@ the input message is analyzed already. <sect1 id="internals.filter.command"> <title> - limit for command mail + Limit For Command Mail </title> <para> @@ -137,7 +137,7 @@ the input message is analyzed already. <sect1 id="internals.filter.mimecomponent"> <title> - mime component filter rules + Mime Component Filter Rules </title> <para> @@ -176,14 +176,14 @@ But there are several problems of rule construction. <sect2> <title> - first match vs last match ? + First Match Vs Last Match ? </title> <para> -This is a filter but not a router filter. Router filter is first -match almost cases. But both first match and last match are not -suitable for mime component filter when we consider the meaning of -"cutoff" operation. +This is a filter but not a router filter. Router filter is first match +in almost cases. But both first match and last match are not suitable +for mime component filter when we consider the meaning of "cutoff" +operation. </para> <para> @@ -197,7 +197,7 @@ suitable for mime component filter when we consider the meaning of <sect1 id="internals.filter.mimecomponent.functions"> <title> - Discussion: mime component filter needs what functions ? + Discussion: Mime Component Filter Needs What Functions ? </title> <para> diff --git a/fml/doc/en/tutorial/internals/hook.sgml b/fml/doc/en/tutorial/internals/hook.sgml index f0c7b015..206e4d5c 100644 --- a/fml/doc/en/tutorial/internals/hook.sgml +++ b/fml/doc/en/tutorial/internals/hook.sgml @@ -1,11 +1,11 @@ <!-- - $FML: hook.sgml,v 1.6 2004/10/06 09:07:39 fukachan Exp $ + $FML: hook.sgml,v 1.1 2005/07/28 13:27:48 fukachan Exp $ --> <chapter id="hook"> <title> - HOOK + Hook </title> @@ -15,7 +15,7 @@ </title> <para> -Hooks are requierd to resolve complicated problems or for compilcated +Hooks are required to resolve complicated problems or for compilcated customization. But there are several problems in implemantation. </para> @@ -31,7 +31,7 @@ $ROLE_FUNCTION_end_hook </para> <para> -There is no common hook amongh processes. Each process has each hook. +There is no common hook among processes. Each process has each hook. In other words, there is no common hook. You need to define plural hooks for different processes even if the hook is same content. <screen> @@ -48,12 +48,12 @@ since perl beginners may code it. use strict; </screen> definition but not effective in evalauating hooks. -In evaluating a hook, apply +In evaluating a hook, &fml8; evaluate it as <screen> no strict; HOOK CONTENT </screen> -, that is disable the strict check, and evaluates the hook. +to disable the strict check. </para> <para> @@ -68,11 +68,11 @@ We should provide hooks when we can see $curproc. <sect1 id="hook.naming.convention"> <title> - Hook naming convension + Hook Naming Convension </title> <para> -hook standard form is +Hook standard form is <screen> ROLE_METHOD_start_hook ROLE_METHOD_end_hook @@ -90,7 +90,7 @@ the following hooks: fmlconf_run_start_hook fmlconf_run_end_hook </screen> -The actual code calling hooks follows: +The actual code calling hooks as follows: <screen> sub run { diff --git a/fml/doc/en/tutorial/internals/io_abstraction.sgml b/fml/doc/en/tutorial/internals/io_abstraction.sgml index c66eb10a..5dcf7cd5 100644 --- a/fml/doc/en/tutorial/internals/io_abstraction.sgml +++ b/fml/doc/en/tutorial/internals/io_abstraction.sgml @@ -1,11 +1,11 @@ <!-- - $FML: io_abstraction.sgml,v 1.5 2005/06/25 15:11:34 fukachan Exp $ + $FML: io_abstraction.sgml,v 1.1 2005/07/28 13:27:48 fukachan Exp $ --> <chapter id="io.abstraction"> <title> - IO Interface and operations + IO Interface And Operations </title> <para> @@ -38,7 +38,7 @@ abstraction layer. <sect1 id="io.abstraction.overview"> <title> - Fundamentals of IO::Adapter + Fundamentals Of IO::Adapter </title> <para> @@ -94,7 +94,7 @@ At least, enough to write user management codes. <sect1 id="io.abstraction.ops"> <title> - Methods / operation vector + Methods / Operation Vector </title> <para> @@ -131,7 +131,7 @@ The argument is a map which calls map dependent constructor. </title> <para> -For a file, call open(2), for RDBMS, connect to the specified sql +For a file, call open(2), for RDBMS, connect to the specified SQL server. </para> @@ -144,7 +144,7 @@ server. </title> <para> -reverse of open(). +Reverse of open(). </para> </sect2> @@ -167,7 +167,7 @@ It is similar to RDBMS. <para> The primary key is a mail address. This assumption is correct in the -case of mailing list deriver. This is basic data structure. +case of mailing list driver. This is basic data structure. </para> </sect2> @@ -179,7 +179,7 @@ case of mailing list deriver. This is basic data structure. </title> <para> -delete KEY and the associated VALUE. +Delete KEY and the associated VALUE. </para> </sect2> @@ -191,7 +191,7 @@ delete KEY and the associated VALUE. </title> <para> -search data corresponding with the primary key within an object. +Search data corresponding with the primary key within an object. </para> <para> @@ -200,7 +200,7 @@ Regular expression search is useful. </para> <para> -The returl value is STR of ARRAY_REF (KEY => [ VALUE, VALUE2, VALUE3 ]). +The return value is STR of ARRAY_REF (KEY => [ VALUE, VALUE2, VALUE3 ]). </para> </sect2> @@ -212,7 +212,7 @@ The returl value is STR of ARRAY_REF (KEY => [ VALUE, VALUE2, VALUE3 ]). </title> <para> -return the list of primary keys like this: +Return the list of primary keys like this: <screen> while ($obj->get_next_key()) { ... } </screen> @@ -240,7 +240,7 @@ This operation corresponds to FIRST_KEY() and NEXT_KEY() of perl hash. <para> What expected in using ARRAY_REF as the return value ? -a list of PRIMARY KEY ? +A list of PRIMARY KEY ? </para> </sect2> @@ -248,13 +248,13 @@ a list of PRIMARY KEY ? <sect2> <title> - How to get all primary keys ? + How To Get All Primary Keys ? </title> <para> -We need to call get_next_keys() again and again. It may be useful to -implement special method to return a list of keys but it is not -implemented. +We need to call get_next_keys() again and again to retrieve all +keys. It may be useful to implement special method to return a list of +keys but it is not implemented. </para> <para> @@ -268,7 +268,7 @@ It is of no use to implement specific method for this. <sect2> <title> - HASH_REF as return value ? + HASH_REF As Return Value ? </title> <para> diff --git a/fml/doc/en/tutorial/internals/language.sgml b/fml/doc/en/tutorial/internals/language.sgml index dc4aa124..439518f4 100644 --- a/fml/doc/en/tutorial/internals/language.sgml +++ b/fml/doc/en/tutorial/internals/language.sgml @@ -1,23 +1,23 @@ <!-- - $FML: language.sgml,v 1.3 2004/10/06 09:07:39 fukachan Exp $ + $FML: language.sgml,v 1.1 2005/07/27 12:21:36 fukachan Exp $ --> <chapter id="language.preference"> <title> - Language preference in processing + Language Preference In Processing </title> <sect1 id="language.preference.overview"> <title> - Problems of language preference + Problems Of Language Preference </title> <para> The simplest model is that we suppose we should return the japanese -message when the ML is configures as for Japanese. -This model needs the language of a ML is fixed. +message when the ML is configured as for Japanese. +This model needs that the language of a ML is fixed. This ML always returns the error message in Japanese. </para> @@ -35,7 +35,7 @@ with the body content "help" (English) ? In that case we cannot determine we should return the reply in us-ascii or iso-2022-jp. For example, how about the following example ? <screen> -Example: +[Example] From: rudo@example.co.jp Subject: help @@ -49,9 +49,9 @@ help <para> We should return the English reply message based on charset information since this message contains English only, so charset is -us-ascii. But this case we should return Japanese message since the +us-ascii. But in this case we should return Japanese message since the sender is a Japanese. So we should return the help message in both -English and Japanese if the ML is configures as Japanese +English and Japanese if the ML is configured as Japanese preferrable. If English is preferrable, the reply is English only. </para> @@ -68,12 +68,12 @@ Japanese help message. <sect1 id="language.preference.ml.ja"> <title> - Japanese preferred ML + Japanese Preferred ML </title> <para> language_preference_order variable controls the behaviour. -By default, an ML for Japanese is configures as +By default, an ML for Japanese is configured as <screen> language_preference_order = ja en </screen> |
