diff options
| author | fukachan <fukachan> | 2003-07-24 15:37:33 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2003-07-24 15:37:33 +0000 |
| commit | 071445b25b9522ae289f4b96f3fb34e4caafeace (patch) | |
| tree | 128a12f1cb98746681f805001d5db76ac5415a82 /fml/doc/en/tutorial/command | |
| parent | 7836dc5e837d4902eea5c741669950c058ba86d2 (diff) | |
| download | fml8-071445b25b9522ae289f4b96f3fb34e4caafeace.tar.gz fml8-071445b25b9522ae289f4b96f3fb34e4caafeace.tar.bz2 fml8-071445b25b9522ae289f4b96f3fb34e4caafeace.zip | |
translation. (partly submitted, phase 1)
Diffstat (limited to 'fml/doc/en/tutorial/command')
| -rw-r--r-- | fml/doc/en/tutorial/command/chapter.sgml | 22 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/command/dataflow.sgml | 15 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/command/extension.sgml | 164 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/command/module.sgml | 95 |
4 files changed, 296 insertions, 0 deletions
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 @@ +<!-- +# $FML$ + $jaFML: chapter.sgml,v 1.7 2002/12/25 11:50:42 fukachan Exp $ +--> + +<chapter> + <title> + command (command mail, CUI, GUI) + </title> + + +<!-- module usage, FML::Command::* modules --> +§.command.module; + +§.command.dataflow; + +§.command.extension; + +§.command.internal; + + +</chapter> 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 @@ +<!-- +# $FML$ + $jaFML: dataflow.sgml,v 1.1 2002/12/25 11:50:42 fukachan Exp $ +--> + + +<sect1 id="fml.command.dataflow"> + <title> + data flow of command request processing + </title> + + +<graphic entityref="image.command.dataflow"></graphic> + +</sect1> 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 @@ +<!-- + $FML$ + $jaFML: extension.sgml,v 1.10 2003/04/15 14:51:36 fukachan Exp $ +--> + + +<sect1 id="fml.command.hack.commandmail"> + <title> + command extensoin: command mail + </title> + + +<warning> +<para> +To make a new command usable for all ML's on this host, +put the module you wrote at +<screen> +/usr/local/lib/fml/site_local/ +</screen> + +If you permit the command is used only for the specifiec ML +(e.g. elena ML), put it at the ML local library path +<screen> +/var/spool/ml/elena/local/lib/ +</screen> +. +</para> + +<para> +In this section, we consider the former case. +In both cases, the module codes are same. +</para> +</warning> + + +<sect2> + <title> + create a new user command + </title> + +<para> +Consider to make a new user command "uja". +Pick up a command at FML::Command, cut and paste it. +Please put it at +<screen> +/usr/local/lib/fml/site_local/FML/Command/User/uja.pm +</screen> +Edit site_default_config.cf to add it into $commands_for_user +to permit the user of "uja" command. +<screen> +commands_for_user += uja +</screen> +</para> + +</sect2> + + +<sect2> + <title> + create a new admin command "admin uja" + </title> + +<para> +In the same way describe above, hack the module!:) +but the location differs. +Put it at the FML::Command::Admin:: class. +<screen> +/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm +</screen> +Edit site_default_config.cf to add it into $commands_for_privileged_user +to permit the use of "admin uja" command. +<screen> +commands_for_privileged_user += uja +</screen> +</para> + +</sect2> + +</sect1> + + +<sect1 id="fml.command.hack.makefml"> + <title> + CUI command extension: makefml/fml + </title> + +<warning> +<para> +To make a new command usable for all ML's on this host, +put the module you wrote at +<screen> +/usr/local/lib/fml/site_local/ +</screen> + +If you permit the command is used only for the specifiec ML +(e.g. elena ML), put it at the ML local library path +<screen> +/var/spool/ml/elena/local/lib/ +</screen> +. +</para> + +<para> +In this section, we consider the former case. +In both cases, the module codes are same. +</para> +</warning> + +<para> +Create a module "uja" and put it at +<screen> +/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm +</screen> +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. +</para> + +</sect1> + + +<sect1 id="fml.command.hack.cgi"> + <title> + GUI command extension: CGI + </title> + + +<warning> +<para> +To make a new command usable for all ML's on this host, +put the module you wrote at +<screen> +/usr/local/lib/fml/site_local/ +</screen> + +If you permit the command is used only for the specifiec ML +(e.g. elena ML), put it at the ML local library path +<screen> +/var/spool/ml/elena/local/lib/ +</screen> +. +</para> + +<para> +In this section, we consider the former case. +In both cases, the module codes are same. +</para> +</warning> + + +<para> +craete a module "uja" and put it at +<screen> +/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm +</screen> +Edit site_default_config.cf to add it into $commands_for_admin_cgi +to permit the use of "uja" command. +<screen> +commands_for_admin_cgi += uja +</screen> +</para> + + +</sect1> 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 @@ +<!-- + $FML$ + $jaFML: module.sgml,v 1.4 2003/04/15 14:51:36 fukachan Exp $ +--> + + +<sect1 id="fml.command.module.hierarchy"> + <title> + modules for commands + </title> + +<para> +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. +</para> + +<para> +FML::Command:: consists of the following classes: +<screen> +FML::Command entrance into FML::Command +FML::Command::User command for usual ML users. +FML::Command::Admin command for administrators. +</screen> +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. +</para> + + +<sect2> + <title> + usre command in command mail + </title> + +<para> +FML::Process::Command call FML::Command::User::$command for $command +via FML::Command. +</para> + +<para> + +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. +</para> +</sect2> + +<sect2> + <title> + admin command (administrative command in command mail) + </title> + +<para> +call FML::Command::Admin::$command for $command via FML::Command +via FML::Process::Command. +</para> + +</sect2> + + +<sect2> + <title> + CUI (makefml/fml) + </title> + +<para> +FML::Process::Configure calls +FML::Command::Admin::$command via FML::Command. +</para> + +</sect2> + + +<sect2> + <title> + GUI (CGI) + </title> + + +<para> +FML::Process::CGI calls +FML::Command::Admin::$command via FML::Command. +</para> + +</sect2> + + +</sect1> |
