Modify header.

[elisp/flim.git] / mime-en.sgml

diff --git a/mime-en.sgml b/mime-en.sgml
index dc00abc..de14cb9 100644 (file)
--- a/mime-en.sgml
+++ b/mime-en.sgml
@@ -299,9 +299,9 @@ used as default value.
 
 <defvar name="default-mime-charset">
 <p>
-Symbol to indicate default value of <dref>MIME-charset</dref>.
+Symbol to indicate default value of <dref>MIME charset</dref>.
 <p>
-It is used when MIME-charset is not specified.
+It is used when MIME charset is not specified.
 <p>
 It is originally variable of APEL.
 </defvar>
@@ -858,28 +858,49 @@ FLIM \e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#\e(B
 <h2> Header encoding/decoding
 <node> Header encoder/decoder
 <p>
-<defun name="eword-encode-header">
-             <opts> code-conversion separator
+<defun name="eword-decode-header">
+           <opts> code-conversion separator
 <p>
 Decode MIME encoded-words in header fields.
 <p>
-If <var>code-conversion</var> is <code>nil</code>, it decodes only
-encoded-words.  If it is mime-charset, it decodes non-ASCII bit
-patterns as the mime-charset.  Otherwise it decodes non-ASCII bit
-patterns as the default-mime-charset.
+If <var>code-conversion</var> is <code>nil</code>, only encoded-words
+are decoded.  If <var>code-conversion</var> is a <dref>MIME
+charset</dref>, non-ASCII bit patterns are decoded as the MIME
+charset.  Otherwise non-ASCII bit patterns are decoded as the
+<code>default-mime-charset</code>. <cf node="entity formatting">
 <p>
-If <var>separator</var> is not nil, it is used as header separator.
+If <var>separator</var> is not <code>nil</code>, it is used as header
+separator.
 </defun>
 
 <defun name="eword-encode-header">
-             <opts> code-conversion
+           <opts> code-conversion
 <p>
 Encode header fields to network representation, such as MIME
 encoded-word.
 <p>
-It refer variable <code>eword-field-encoding-method-alist</code>.
+Each field is encoded as corresponding method specified by variable
+<code>eword-field-encoding-method-alist</code>.
 </defun>
 
+<defvar name="eword-field-encoding-method-alist">
+<p>
+Association list to specify field encoding method.  Each element looks
+like (FIELD . METHOD).
+<p>
+If METHOD is <code>mime</code>, the FIELD will be encoded into MIME
+format (encoded-word).
+<p>
+If METHOD is <code>nil</code>, the FIELD will not be encoded.
+<p>
+If METHOD is a MIME charset, the FIELD will be encoded as the charset
+when it must be convert into network-code.
+<p>
+Otherwise the FIELD will be encoded as variable
+<code>default-mime-charset</code> when it must be convert into
+network-code.
+</defvar>
+
 
 <h1> Various Customization
 <node> custom