From fb58227e2c2a6d061372a27409b96ea27ea75451 Mon Sep 17 00:00:00 2001 From: fukachan Date: Sat, 2 Aug 2003 03:05:53 +0000 Subject: clean up --- fml/doc/en/tutorial/command/chapter.sgml | 4 +-- fml/doc/en/tutorial/command/dataflow.sgml | 4 +-- fml/doc/en/tutorial/command/extension.sgml | 34 ++++++++++++------------ fml/doc/en/tutorial/command/internal.sgml | 41 ++++++++++++++--------------- fml/doc/en/tutorial/command/module.sgml | 42 ++++++++++++++---------------- 5 files changed, 61 insertions(+), 64 deletions(-) (limited to 'fml/doc/en/tutorial/command') diff --git a/fml/doc/en/tutorial/command/chapter.sgml b/fml/doc/en/tutorial/command/chapter.sgml index 0515ce65..c47cb8b9 100644 --- a/fml/doc/en/tutorial/command/chapter.sgml +++ b/fml/doc/en/tutorial/command/chapter.sgml @@ -1,11 +1,11 @@ - command (command mail, CUI, GUI) + Command (command mail, CUI and GUI) diff --git a/fml/doc/en/tutorial/command/dataflow.sgml b/fml/doc/en/tutorial/command/dataflow.sgml index 1fa1961a..ff3750d3 100644 --- a/fml/doc/en/tutorial/command/dataflow.sgml +++ b/fml/doc/en/tutorial/command/dataflow.sgml @@ -1,12 +1,12 @@ - data flow of command request processing + Data flow of command request processing diff --git a/fml/doc/en/tutorial/command/extension.sgml b/fml/doc/en/tutorial/command/extension.sgml index bf1cf0a7..53f7018e 100644 --- a/fml/doc/en/tutorial/command/extension.sgml +++ b/fml/doc/en/tutorial/command/extension.sgml @@ -1,41 +1,41 @@ - command extensoin: command mail + Command extension: command mail To make a new command usable for all ML's on this host, -put the module you wrote at +you need to put the module you wrote at /usr/local/lib/fml/site_local/ - +. If you permit the command is used only for the specifiec ML (e.g. elena ML), put it at the ML local library path /var/spool/ml/elena/local/lib/ -. +where $ml_home_dir = /var/spool/ml/elena. -In this section, we consider the former case. -In both cases, the module codes are same. +In this section, we consider the former case. In both cases, the way +of writing the module codes are same. Only path differs. - create a new user command + Create a new user command @@ -50,6 +50,8 @@ to permit the user of "uja" command. commands_for_user += uja +It you allow the command only for the specific elena ML, +edit /var/spool/ml/elena/config.cf in the same way. @@ -57,13 +59,13 @@ commands_for_user += uja - create a new admin command "admin uja" + Create a new admin command "admin uja" -In the same way describe above, hack the module!:) -but the location differs. -Put it at the FML::Command::Admin:: class. +In the same way described above, hack the module!:) +but the module path differs. +Put it at the FML::Command::Admin:: class. For example /usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm @@ -111,9 +113,9 @@ Create a module "uja" and put it at /usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm -No editing of .cf files. -The existence of module file enables the command automatically -in the case CUI since the use of CUI implies administrator use. +You do not need to edit .cf files. The existence of module file +enables the command automatically in the CUI case since the usability +of CUI implies administrator use. @@ -149,7 +151,7 @@ In both cases, the module codes are same. -craete a module "uja" and put it at +Craete a module "uja" and put it at /usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm diff --git a/fml/doc/en/tutorial/command/internal.sgml b/fml/doc/en/tutorial/command/internal.sgml index d671dcf0..75a4785f 100644 --- a/fml/doc/en/tutorial/command/internal.sgml +++ b/fml/doc/en/tutorial/command/internal.sgml @@ -1,5 +1,5 @@ @@ -9,12 +9,8 @@ -(... not yet translated ...) - - - -Consider help command which send back help message to the sender, an -example of command. +Consider "help" command an an example of command, +which sends back help message to the sender. @@ -25,10 +21,10 @@ FML::Process::Command via AUTOLOAD of FML::Command. -All commands are implemented as either of FML::Command::User -FML::Command::Admin classes. CUI (makefml, fml) and GUI (CGI) uses -FML::Command::Admin class. Command mail users both classes according -to the context. +All commands are implemented at either of FML::Command::User +FML::Command::Admin classes. Both CUI (makefml, fml) and GUI (CGI) +uses FML::Command::Admin class. Instead command mail users both +classes according to the context. @@ -66,24 +62,24 @@ sub process where $curproc is an object, which type is hash reference. It corresponds to %Envelope of &fml4;. It contains several references to objects for this process. -$config is an object, but global in $fml4;. +For exmple, variable $config is an object holding configuration variables. prepare_file_to_return() converts the message language and expands the -arguments in the message templtes. +arguments in the message templates. $curproc->reply_message() inserts the specified mesage string into the -queue. +message queue of this process on memory. -The error/log messages queued in are aggergated to one message at the -last of the current process. It is driven by Mail::Delivery class to -send it. If needed, the aggregator handles text strings and multipart -properly. +The error/log messages queued in on memory are aggergated to one +message at the last of the current process. Mail::Delivery class +handles the aggregation and send it. If needed, the aggregator handles +text strings and multipart properly to build one message. @@ -92,9 +88,12 @@ is different. -FYI: commands such as get for the file manipulation uses the same -message queuing mechanism. This is different from &fml4;'s Notify() -fundamentally. +FYI: commands such as "get" for the file manipulation uses the same +message queuing mechanism. Notify() sends back immediately. This is +different from &fml4;'s Notify() fundamentally. + + + diff --git a/fml/doc/en/tutorial/command/module.sgml b/fml/doc/en/tutorial/command/module.sgml index e2738b3e..aed20036 100644 --- a/fml/doc/en/tutorial/command/module.sgml +++ b/fml/doc/en/tutorial/command/module.sgml @@ -1,38 +1,36 @@ - modules for commands + Modules for commands -In &fmldevel;, all command modules are shared among command mail, -CUI(makefml, fml) and GUI. -Commands are caregorized into user and administrative ones by the -priviledge. +In &fmldevel;, all command modules are shared among command mail, CUI +(makefml, fml) and GUI (CGI). Commands are caregorized into user and +administrative ones by the priviledge. -FML::Command:: consists of the following classes: +FML::Command class consists of the following classes: FML::Command entrance into FML::Command -FML::Command::User command for usual ML users. -FML::Command::Admin command for administrators. +FML::Command::User command for general ML users. +FML::Command::Admin command for remote administrators. -For example, a user command in a command mail kicks off -FML::Command firstly, after some steps, -calls FML::Command::User::$command where $command is the specified -command name. +For example, a user command in a command mail kicks off FML::Command +firstly, after some steps, calls FML::Command::User::$command where +$command is the specified command name. - usre command in command mail + User command in command mail @@ -41,20 +39,18 @@ via FML::Command. - -Finally, some module calls FML::Command::Admin::$command for real work even if it is -a user command. -For example, -FML::Command::Admin::subscribe works for subscription. -In this case, -FML::Command::User::subscribe module is a wrapper or an entrance for -confirmation before the real subscription work. +FYI: some module calls FML::Command::Admin::$command for real work +even if it is a user command. For example, +FML::Command::Admin::subscribe works for subscription. In this case, +FML::Command::User::subscribe module is a wrapper/entrance for +confirmation before the real subscription process runs. + - admin command (administrative command in command mail) + Admin command (administrative command in command mail) -- cgit v1.2.1