From 071445b25b9522ae289f4b96f3fb34e4caafeace Mon Sep 17 00:00:00 2001 From: fukachan Date: Thu, 24 Jul 2003 15:37:33 +0000 Subject: translation. (partly submitted, phase 1) --- fml/doc/en/tutorial/command/chapter.sgml | 22 ++++ fml/doc/en/tutorial/command/dataflow.sgml | 15 +++ fml/doc/en/tutorial/command/extension.sgml | 164 +++++++++++++++++++++++++++++ fml/doc/en/tutorial/command/module.sgml | 95 +++++++++++++++++ 4 files changed, 296 insertions(+) create mode 100644 fml/doc/en/tutorial/command/chapter.sgml create mode 100644 fml/doc/en/tutorial/command/dataflow.sgml create mode 100644 fml/doc/en/tutorial/command/extension.sgml create mode 100644 fml/doc/en/tutorial/command/module.sgml (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 new file mode 100644 index 00000000..eabf70c6 --- /dev/null +++ b/fml/doc/en/tutorial/command/chapter.sgml @@ -0,0 +1,22 @@ + + + + + command (command mail, CUI, GUI) + + + + +§.command.module; + +§.command.dataflow; + +§.command.extension; + +§.command.internal; + + + diff --git a/fml/doc/en/tutorial/command/dataflow.sgml b/fml/doc/en/tutorial/command/dataflow.sgml new file mode 100644 index 00000000..2fb765ff --- /dev/null +++ b/fml/doc/en/tutorial/command/dataflow.sgml @@ -0,0 +1,15 @@ + + + + + + data flow of command request processing + + + + + + diff --git a/fml/doc/en/tutorial/command/extension.sgml b/fml/doc/en/tutorial/command/extension.sgml new file mode 100644 index 00000000..bf1cf0a7 --- /dev/null +++ b/fml/doc/en/tutorial/command/extension.sgml @@ -0,0 +1,164 @@ + + + + + + command extensoin: command mail + + + + + +To make a new command usable for all ML's on this host, +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/ + +. + + + +In this section, we consider the former case. +In both cases, the module codes are same. + + + + + + + create a new user command + + + +Consider to make a new user command "uja". +Pick up a command at FML::Command, cut and paste it. +Please put it at + +/usr/local/lib/fml/site_local/FML/Command/User/uja.pm + +Edit site_default_config.cf to add it into $commands_for_user +to permit the user of "uja" command. + +commands_for_user += 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. + +/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm + +Edit site_default_config.cf to add it into $commands_for_privileged_user +to permit the use of "admin uja" command. + +commands_for_privileged_user += uja + + + + + + + + + + + CUI command extension: makefml/fml + + + + +To make a new command usable for all ML's on this host, +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/ + +. + + + +In this section, we consider the former case. +In both cases, the module codes are same. + + + + +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. + + + + + + + + GUI command extension: CGI + + + + + +To make a new command usable for all ML's on this host, +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/ + +. + + + +In this section, we consider the former case. +In both cases, the module codes are same. + + + + + +craete a module "uja" and put it at + +/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm + +Edit site_default_config.cf to add it into $commands_for_admin_cgi +to permit the use of "uja" command. + +commands_for_admin_cgi += uja + + + + + diff --git a/fml/doc/en/tutorial/command/module.sgml b/fml/doc/en/tutorial/command/module.sgml new file mode 100644 index 00000000..e2738b3e --- /dev/null +++ b/fml/doc/en/tutorial/command/module.sgml @@ -0,0 +1,95 @@ + + + + + + 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. + + + +FML::Command:: 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. + +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 + + + +FML::Process::Command call FML::Command::User::$command for $command +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. + + + + + + admin command (administrative command in command mail) + + + +call FML::Command::Admin::$command for $command via FML::Command +via FML::Process::Command. + + + + + + + + CUI (makefml/fml) + + + +FML::Process::Configure calls +FML::Command::Admin::$command via FML::Command. + + + + + + + + GUI (CGI) + + + + +FML::Process::CGI calls +FML::Command::Admin::$command via FML::Command. + + + + + + -- cgit v1.2.1