1998-10-18 MORIOKA Tomohiko <morioka@jaist.ac.jp>
+ * mime-en.sgml, mime-ja.sgml (Header encoder/decoder): Add
+ description about `eword-field-encoding-method-alist'.
+
+ * mime-en.sgml (Header encoder/decoder): Modify description about
+ `eword-encode-header'.
+
+ * mime-ja.sgml (Header encoder/decoder): Translate.
+
+1998-10-18 MORIOKA Tomohiko <morioka@jaist.ac.jp>
+
+ * mime-en.sgml (entity formatting): Fix typo in description of
+ `default-mime-charset'.
+
+ * mime-en.sgml (Header encoder/decoder): Modify description of
+ `eword-decode-header'.
+
+ * mime-ja.sgml, mime-en.sgml (Header encoder/decoder): fix typo.
+
+ * mime-en.sgml (encoder/decoder): Translate description of
+ `mime-decode-string'.
+
+1998-10-18 MORIOKA Tomohiko <morioka@jaist.ac.jp>
+
+ * mime-en.sgml (Content-Disposition parser): Modify description.
+
+ * mime-en.sgml (Content-Type parser): Modify description.
+
+1998-10-18 MORIOKA Tomohiko <morioka@jaist.ac.jp>
+
+ * mime-en.sgml (Content-Transfer-Encoding parser): Translate.
+
+\f
+1998-10-18 MORIOKA Tomohiko <morioka@jaist.ac.jp>
+
* FLIM: Version 1.11.0 (Yamadagawa) was released.
1998-10-17 MORIOKA Tomohiko <morioka@jaist.ac.jp>
<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>
<node> Content-Type parser
<p>
<defun name="mime-parse-Content-Type">
- <args> string
+ <args> string
<p>
-Parse <var>string</var> as field-body of Content-Type field.
+Parse <var>string</var> as a field-body of Content-Type field, and
+return the result as <dref>mime-content-type</dref> structure.
</defun>
<defun name="mime-read-Content-Type">
<p>
-Read field-body of Content-Type field from current-buffer,
-and return parsed it.
+Parse Content-Type field of the current buffer, and return the result
+as <dref>mime-content-type</dref> structure.
<p>
Return <code>nil</code> if Content-Type field is not found.
</defun>
<node> Content-Type utility
<p>
<defun name="mime-type/subtype-string">
- <args> type <opts> subtype
+ <args> type <opts> subtype
<p>
Return type/subtype string from <var>type</var> and
<var>subtype</var>.
file name.
<rfc number="2183" type="Standards Track"
- author="S. Dorner, K. Moore and R. Troost"
- title="Communicating Presentation Information in
- Internet Messages: The Content-Disposition Header"
- date="August 1997">
+ author="S. Dorner, K. Moore and R. Troost"
+ title="Communicating Presentation Information in Internet
+ Messages: The Content-Disposition Header" date="August
+ 1997">
<p>
FLIM provides parser for Content-Disposition field and structure
<concept>mime-content-disposition</concept> to store information of
<args> string
<p>
Parse <var>string</var> as field-body of Content-Disposition field,
-and return the result.
+and return the result as <dref>mime-content-disposition</dref>
+structure.
</defun>
<defun name="mime-read-Content-Disposition">
<p>
-Read field-body of Content-Disposition field from current-buffer,
+Parse Content-Disposition field of the current buffer, and return the
+result as <dref>mime-content-disposition</dref> structure.
<p>
-Return nil if Content-Disposition field is not found.
+Return <code>nil</code> if Content-Disposition field is not found.
</defun>
<node> Content-Transfer-Encoding parser
<p>
<defun name="mime-parse-Content-Transfer-Encoding">
- <args> string
+ <args> string
<p>
-<var>string</var> \e$B$r\e(B content-transfer-encoding \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
+Parse <var>string</var> as a field-body of Content-Transfer-Encoding
+field, and return the result.
</defun>
<defun name="mime-read-Content-Transfer-Encoding">
- <opts>default-encoding
+ <opts>default-encoding
<p>
-\e$B8=:_$N\e(B buffer \e$B$N\e(B Content-Transfer-Encoding \e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$r\e(B
-\e$BJV$9!#\e(B
+Parse Content-Transfer-Encoding field of the current buffer, and
+return the result.
<p>
-Content-Transfer-Encoding \e$BMs$,B8:_$7$J$$>l9g$O\e(B
-<var>default-encoding</var> \e$B$rJV$9!#\e(B
+Return <var>default-encoding</var> if Content-Transfer-Encoding field
+is not found. If it is not specified, <code>nil</code> is used as the
+default value.
</defun>
<defun name="mime-decode-string">
- <args> string encoding
+ <args> string encoding
<p>
-<var>string</var> \e$B$r\e(B <var>encoding</var> \e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#\e(B
+Decode <var>string</var> which is encoded in <var>encoding</var>, and
+return the result.
</defun>
<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
If @var{buffer} is omitted, current buffer is used.@refill
@var{type} is representation-type of created
-mime-entity. (cf. @ref{mm-backend}) Default value is @var{buffer}.
+mime-entity. (cf. @ref{mm-backend})
+ Default value is @var{buffer}.
@end defun
@defvar default-mime-charset
-Symbol to indicate default value of MIME-charset
-(@ref{MIME-charset}).@refill
+Symbol to indicate default value of MIME charset (@ref{MIME charset}).@refill
-It is used when MIME-charset is not specified.@refill
+It is used when MIME charset is not specified.@refill
It is originally variable of APEL.
@end defvar
@defun mime-parse-Content-Type string
-Parse @var{string} as field-body of Content-Type field.
+Parse @var{string} as a field-body of Content-Type field, and return the
+result as mime-content-type (@ref{mime-content-type}) structure.
@end defun
@defun mime-read-Content-Type
-Read field-body of Content-Type field from current-buffer, and return
-parsed it.@refill
+Parse Content-Type field of the current buffer, and return the result as
+mime-content-type (@ref{mime-content-type}) structure.@refill
Return @code{nil} if Content-Type field is not found.
@end defun
@defun mime-parse-Content-Disposition string
Parse @var{string} as field-body of Content-Disposition field, and
-return the result.
+return the result as mime-content-disposition
+(@ref{mime-content-disposition}) structure.
@end defun
@defun mime-read-Content-Disposition
-Read field-body of Content-Disposition field from current-buffer,@refill
+Parse Content-Disposition field of the current buffer, and return the
+result as mime-content-disposition (@ref{mime-content-disposition})
+structure.@refill
-Return nil if Content-Disposition field is not found.
+Return @code{nil} if Content-Disposition field is not found.
@end defun
@defun mime-parse-Content-Transfer-Encoding string
-@var{string} \e$B$r\e(B content-transfer-encoding \e$B$H$7$F2r@O$7$?7k2L$rJV$9!#\e(B
+Parse @var{string} as a field-body of Content-Transfer-Encoding field,
+and return the result.
@end defun
@defun mime-read-Content-Transfer-Encoding &optional default-encoding
-\e$B8=:_$N\e(B buffer \e$B$N\e(B Content-Transfer-Encoding \e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$r\e(B
-\e$BJV$9!#\e(B@refill
+Parse Content-Transfer-Encoding field of the current buffer, and return
+the result.@refill
-Content-Transfer-Encoding \e$BMs$,B8:_$7$J$$>l9g$O\e(B@var{default-encoding} \e$B$r\e(B
-\e$BJV$9!#\e(B
+Return @var{default-encoding} if Content-Transfer-Encoding field is not
+found. If it is not specified, @code{nil} is used as the default value.
@end defun
@defun mime-decode-string string encoding
-@var{string} \e$B$r\e(B @var{encoding} \e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#\e(B
+Decode @var{string} which is encoded in @var{encoding}, and return the
+result.
@end defun
@node Header encoder/decoder, , encoded-word, encoded-word
@section Header encoding/decoding
-@defun eword-encode-header &optional code-conversion separator
+@defun eword-decode-header &optional code-conversion separator
Decode MIME encoded-words in header fields.@refill
-If @var{code-conversion} is @code{nil}, 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.@refill
+If @var{code-conversion} is @code{nil}, only encoded-words are decoded.
+If @var{code-conversion} is a MIME charset (@ref{MIME charset}),
+non-ASCII bit patterns are decoded as the MIME charset. Otherwise
+non-ASCII bit patterns are decoded as the
+@code{default-mime-charset}. (cf. @ref{entity formatting}) @refill
-If @var{separator} is not nil, it is used as header separator.
+If @var{separator} is not @code{nil}, it is used as header separator.
@end defun
Encode header fields to network representation, such as MIME
encoded-word.@refill
-It refer variable @code{eword-field-encoding-method-alist}.
+Each field is encoded as corresponding method specified by variable
+@code{eword-field-encoding-method-alist}.
@end defun
+@defvar eword-field-encoding-method-alist
+
+Association list to specify field encoding method. Each element looks
+like (FIELD . METHOD).@refill
+
+If METHOD is @code{mime}, the FIELD will be encoded into MIME format
+(encoded-word).@refill
+
+If METHOD is @code{nil}, the FIELD will not be encoded.@refill
+
+If METHOD is a MIME charset, the FIELD will be encoded as the charset
+when it must be convert into network-code.@refill
+
+Otherwise the FIELD will be encoded as variable
+@code{default-mime-charset} when it must be convert into network-code.
+@end defvar
+
+
@node custom, Appendix, encoded-word, Top
@chapter Various Customization
<defun name="mime-decode-string">
- <args> string encoding
+ <args> string encoding
<p>
-<var>string</var> \e$B$r\e(B <var>encoding</var> \e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#\e(B
+<var>string</var> \e$B$r\e(B <var>encoding</var> \e$B$H$7$FI|9f$7$?7k2L$rJV$9!#\e(B
</defun>
<h2> Header \e$B$NId9f2=!&I|9f2=\e(B
<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.
+Header \e$BCf$N\e(B encoded-word \e$B$rI|9f$9$k!#\e(B
<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.
+\e$B$b$7\e(B <var>code-conversion</var> \e$B$,\e(B <code>nil</code> \e$B$J$i!"\e(Bencoded-word
+\e$B$@$1$,I|9f$5$l$k!#$b$7!"\e(B<var>code-conversion</var> \e$B$,\e(B <dref>MIME
+charset</dref> \e$B$J$i!"Hs\e(B ASCII bit patterns \e$B$O$=$N\e(B MIME charset \e$B$H$7$F\e(B
+\e$BI|9f$5$l$k!#$3$l0J30$N>l9g!"Hs\e(B ASCII bit patterns \e$B$O\e(B
+<code>default-mime-charset</code>. \e$B$H$7$FI|9f$5$l$k!#\e(B<cf node="entity
+formatting">
<p>
-If <var>separator</var> is not nil, it is used as header separator.
+\e$B$b$7\e(B <var>separator</var> \e$B$,\e(B <code>nil</code> \e$B$G$J$1$l$P!"$=$NCM$,\e(B
+header separator \e$B$H$7$FMQ$$$i$l$k!#\e(B
</defun>
<defun name="eword-encode-header">
- <opts> code-conversion
+ <opts> code-conversion
<p>
-Encode header fields to network representation, such as MIME
-encoded-word.
+Header \e$B$r\e(B network \e$BI=8=$KId9f2=$9$k!#\e(B
<p>
-It refer variable <code>eword-field-encoding-method-alist</code>.
+\e$B3F\e(B field \e$B$O\e(B <code>eword-field-encoding-method-alist</code> \e$B$G;XDj$5$l\e(B
+\e$B$?J}<0$GId9f2=$5$l$k!#\e(B
</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> \e$B0lHL@_Dj\e(B
<node> custom
@defun mime-decode-string string encoding
-@var{string} \e$B$r\e(B @var{encoding} \e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#\e(B
+@var{string} \e$B$r\e(B @var{encoding} \e$B$H$7$FI|9f$7$?7k2L$rJV$9!#\e(B
@end defun
@node Header encoder/decoder, , encoded-word, encoded-word
@section Header \e$B$NId9f2=!&I|9f2=\e(B
-@defun eword-encode-header &optional code-conversion separator
+@defun eword-decode-header &optional code-conversion separator
-Decode MIME encoded-words in header fields.@refill
+Header \e$BCf$N\e(B encoded-word \e$B$rI|9f$9$k!#\e(B@refill
-If @var{code-conversion} is @code{nil}, 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.@refill
+\e$B$b$7\e(B @var{code-conversion} \e$B$,\e(B @code{nil} \e$B$J$i!"\e(Bencoded-word \e$B$@$1$,I|9f$5\e(B
+\e$B$l$k!#$b$7!"\e(B@var{code-conversion} \e$B$,\e(B MIME charset (@ref{MIME charset})
+\e$B$J$i!"Hs\e(B ASCII bit patterns \e$B$O$=$N\e(B MIME charset \e$B$H$7$FI|9f$5$l$k!#$3$l0J\e(B
+\e$B30$N>l9g!"Hs\e(B ASCII bit patterns \e$B$O\e(B@code{default-mime-charset}. \e$B$H$7$FI|\e(B
+\e$B9f$5$l$k!#\e(B(cf. @ref{entity formatting}) @refill
-If @var{separator} is not nil, it is used as header separator.
+\e$B$b$7\e(B @var{separator} \e$B$,\e(B @code{nil} \e$B$G$J$1$l$P!"$=$NCM$,\e(Bheader separator
+\e$B$H$7$FMQ$$$i$l$k!#\e(B
@end defun
@defun eword-encode-header &optional code-conversion
-Encode header fields to network representation, such as MIME
-encoded-word.@refill
+Header \e$B$r\e(B network \e$BI=8=$KId9f2=$9$k!#\e(B@refill
-It refer variable @code{eword-field-encoding-method-alist}.
+\e$B3F\e(B field \e$B$O\e(B @code{eword-field-encoding-method-alist} \e$B$G;XDj$5$l$?J}<0$G\e(B
+\e$BId9f2=$5$l$k!#\e(B
@end defun
+@defvar eword-field-encoding-method-alist
+
+Association list to specify field encoding method. Each element looks
+like (FIELD . METHOD).@refill
+
+If METHOD is @code{mime}, the FIELD will be encoded into MIME format
+(encoded-word).@refill
+
+If METHOD is @code{nil}, the FIELD will not be encoded.@refill
+
+If METHOD is a MIME charset, the FIELD will be encoded as the charset
+when it must be convert into network-code.@refill
+
+Otherwise the FIELD will be encoded as variable
+@code{default-mime-charset} when it must be convert into network-code.
+@end defvar
+
+
@node custom, Appendix, encoded-word, Top
@chapter \e$B0lHL@_Dj\e(B
projects / elisp / flim.git / commitdiff