From: yoichi <yoichi>
Date: Sat, 9 Nov 2002 15:34:12 +0000 (+0000)
Subject: Update elmo-split explanation.
X-Git-Tag: wl-2_11_1~52
X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=54548bf9beda56fde71ffa6efcba2524c6a00bcd;p=elisp%2Fwanderlust.git

Update elmo-split explanation.
---

diff --git a/doc/wl-ja.texi b/doc/wl-ja.texi
index 20c1241..ebe5635 100644
--- a/doc/wl-ja.texi
+++ b/doc/wl-ja.texi
@@ -6297,17 +6297,18 @@ pop3                    ×    △    △    △
 規則の基本単位は
 
 @lisp
-(@samp{条件} @samp{フォルダ} [@code{continue}])
+(@samp{CONDITION} @samp{ACTION} [@code{continue}])
 @end lisp
 
-という一組です。
-第一の要素 @samp{条件} は S 式です。書式についてはすぐ後で説明します。
-第二の要素 @samp{フォルダ} はメッセージの振り分け先のフォルダ名です。
-もし第三の要素 @code{continue} がシンボルとして与えられると、
-その条件が満たされたとしても振り分け規則の評価を続けます。
+という一組で、@samp{CONDITION} が真の場合に @samp{ACTION} を実行します。
+第一の要素 @samp{CONDITION} には条件を S 式で記述します。書式については
+すぐ後で説明します。第二の要素 @samp{ACTION} にはメッセージの振り分け先
+のフォルダ名、もしくはシンボルを指定します。
+第三の要素 @code{continue} をシンボルとして与えると、@samp{CONDITION} が
+満たされた場合にも振り分け規則の評価を継続します。
 
-@samp{条件} の記法は以下のようになります。実際の書き方は上で挙げた例を
-参考にして下さい。
+@samp{CONDITION} の記法は以下のようになります。実際の書き方は上で挙げた
+例を参考にして下さい。
 
 @enumerate
 @item
@@ -6349,6 +6350,37 @@ pop3                    ×    △    △    △
 シンボルが指定されると、それを評価します。
 @end enumerate
 
+@samp{ACTION} の値として指定できるのは以下のいずれかです。
+
+@enumerate
+@item
+フォルダ名
+
+文字列が指定されるとそれを振り分け先のフォルダ名とみなして、そのフォルダ
+へメッセージを追加します。
+
+@item
+@samp{delete}
+
+シンボル @samp{delete} が指定されると @code{elmo-split-folder} 内にある
+メッセージの実体を削除します。
+
+@item
+@samp{noop}
+
+シンボル @samp{noop} が指定された場合、そのメッセージに対しては何もせず、
+そのままの状態に保ちます。
+
+@item
+関数
+
+関数が指定された場合、それを実行します。
+@end enumerate
+
+全ての振り分け規則を通過したメッセージは、変数
+@code{elmo-split-default-action} で指定した @samp{ACTION} に沿って処理さ
+れます。
+
 
 @node Address Book, Customization, Split messages, Top
 @chapter アドレス帳
diff --git a/doc/wl.texi b/doc/wl.texi
index cac797f..a1b6b6e 100644
--- a/doc/wl.texi
+++ b/doc/wl.texi
@@ -6389,14 +6389,16 @@ example, please.
 The basic unit of the rule is a combination like
 
 @lisp
-(@samp{CONDITION} @samp{FOLDER} [@code{continue}])
+(@samp{CONDITION} @samp{ACTION} [@code{continue}])
 @end lisp
 
-The 1st element @samp{CONDITION} is a balanced expression (sexp). Its
-grammar will be explained below. The 2nd element @samp{FOLDER} is the
-name of the folder to split messages into. When the 3rd element
-@code{continue} is specified as symbol, evaluating rules is not stopped
-even when the condition is satisfied.
+If @samp{CONDITION} is true, @samp{ACTION} is performed.
+The 1st element @samp{CONDITION} is a condition represented by a
+balanced expression (sexp). Its grammar will be explained below.
+The 2nd element @samp{ACTION} is the name of the folder to split
+messages into, or a symbol. When the 3rd element @code{continue} is
+specified as symbol, evaluating rules is not stopped even when the
+condition is satisfied.
 
 The grammar for @samp{CONDITION} is as follows. See example above to
 learn how to write the condition practically.
@@ -6440,6 +6442,36 @@ A symbol.
 When a symbol is specified, it is evaluated.
 @end enumerate
 
+You can specify followings as 2nd @samp{ACTION}.
+
+@enumerate
+@item
+folder name
+
+If some string is specified, it will be regarded as the destination
+folder, and the message will be appended to it.
+
+@item
+@samp{delete}
+
+If the symbol  @samp{delete} is specified, delete the substance of the
+message in @code{elmo-split-folder}
+
+@item
+@samp{noop}
+
+If the symbol @samp{noop} is specified, do nothing on the message and
+keep it as it is.
+
+@item
+function
+
+If some function is specified, execute it.
+@end enumerate
+
+If the message passes all rules, it will be dealed along @samp{ACTION}
+specified by @code{elmo-split-default-action}.
+
 
 @node Address Book, Customization, Split messages, Top
 @chapter Address Book