* (TESTPAT): add quoted-encoded-word description and test.

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

diff --git a/mime-en.texi b/mime-en.texi
index 2e589fb..a95ec3d 100644 (file)
--- a/mime-en.texi
+++ b/mime-en.texi
@@ -1,13 +1,13 @@
 \input texinfo.tex
 @setfilename mime-en.info
-@settitle{FLIM 1.8 Manual about MIME Features}
+@settitle{FLIM 1.9 Manual about MIME Features}
 @titlepage
-@title FLIM 1.8 Manual about MIME Features
+@title FLIM 1.9 Manual about MIME Features
 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp>
 @subtitle 1998/07/01
 @end titlepage
 @node Top, Introduction, (dir), (dir)
-@top FLIM 1.8 Manual about MIME Features
+@top FLIM 1.9 Manual about MIME Features
 
 @ifinfo
 
@@ -20,10 +20,10 @@ parsing/encoding library for GNU Emacs.
 * How to use::                  How to use MIME features
 * Entity::                      Message and Entity
 * Content-Type::                Information of Content-Type field
-* Content-Disposition::         Content-Disposition \e$BMs$N>pJs\e(B
-* Content-Transfer-Encoding::   \e$BId9f2=K!\e(B
-* encoded-word::                Header \e$B$N\e(B network \e$BI=8=\e(B
-* custom::                      \e$B0lHL@_Dj\e(B
+* Content-Disposition::         Information of Content-Disposition field
+* Content-Transfer-Encoding::   Encoding Method
+* encoded-word::                Network representation of header
+* custom::                      Various Customization
 * Appendix::                    
 * Concept Index::               
 * Function Index::              
@@ -126,19 +126,16 @@ on representation-type.
 @end defun
 
 
-@defun mime-parse-message &optional  default-ctl node-id
-
-Parse current buffer as message, and return the result as mime-entity.
-@end defun
-
-
-@defun mime-parse-buffer &optional  buffer
+@defun mime-parse-buffer &optional  buffer type
 
 Parse @var{buffer} as message, and set the result to buffer local
 variable @code{mime-message-structure} of @var{buffer} as
 mime-entity.@refill
 
-If @var{buffer} is omitted, current buffer is used.
+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}.
 @end defun
 
 
@@ -226,10 +223,14 @@ Return file name of @var{entity}.
 @end defun
 
 
-@defun mime-entity-encoding entity
+@defun mime-entity-encoding entity  &optional  default-encoding
 
 Return content-transfer-encoding of @var{entity}.
-(cf. @ref{Content-Transfer-Encoding})
+(cf. @ref{Content-Transfer-Encoding}) @refill
+
+If the @var{entity} does not have Content-Transfer-Encoding field, this
+function returns @var{default-encoding}.  If it is nil, @code{"7bit"} is
+used as default value.
 @end defun
 
 
@@ -445,15 +446,16 @@ mechanism to represent kind of character code like MIME charset.
 @end quotation
 
 
-FLIM \e$B$O\e(B Content-Type \e$BMs$r9=J82r@O$9$k4X?t$H\e(B Content-Type \e$BMs$N2r@O7k2L$r\e(B
-\e$B3JG<$9$k9=B$BN\e(B @strong{mime-content-type} \e$B$rDs6!$7$^$9!#\e(B
+FLIM provides parser for Content-Type field and structure
+@strong{mime-content-type} to store information of
+Content-Type field.
 
 
 @menu
 * Content-Type field::          Format of Content-Type field
 * mime-content-type::           mime-content-type structure
-* Content-Type parser::         Content-Type \e$BMs$N2r@O4o\e(B
-* Content-Type utility::        Content-Type \e$B$K4X$9$kM-MQ$J4X?t\e(B
+* Content-Type parser::         Parser
+* Content-Type utility::        Utility functions
 @end menu
 
 @node Content-Type field, mime-content-type, Content-Type, Content-Type
@@ -552,7 +554,7 @@ content-type \e$B$N@8@.;R!#\e(B
 
 
 @node Content-Type parser, Content-Type utility, mime-content-type, Content-Type
-@section Content-Type \e$BMs$N2r@O4o\e(B
+@section Parser
 
 @defun mime-parse-Content-Type string
 
@@ -570,17 +572,17 @@ Content-Type \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
 
 
 @node Content-Type utility,  , Content-Type parser, Content-Type
-@section Content-Type \e$B$K4X$9$kM-MQ$J4X?t\e(B
+@section Utility functions
 
 @defun mime-type/subtype-string type  &optional  subtype
 
-@var{type} \e$B$H\e(B @var{subtype} \e$B$+$i\e(B type/subtype \e$B7A<0$NJ8;zNs$rJV$9!#\e(B
+Return type/subtype string from @var{type} and @var{subtype}.
 @end defun
 
 
 
 @node Content-Disposition, Content-Transfer-Encoding, Content-Type, Top
-@chapter Content-Disposition \e$BMs$N>pJs\e(B
+@chapter Information of Content-Disposition field
 @cindex mime-content-disposition
 @cindex RFC 2183
 @cindex Standards Track
@@ -604,12 +606,12 @@ FLIM \e$B$O\e(B Content-Disposition \e$BMs$r9=J82r@O$9$k4X?t$H\e(B Content-Dispositi
 
 
 @menu
-* mime-content-disposition::    mime-content-disposition \e$B9=B$BN\e(B
-* Content-Disposition parser::  Content-Disposition \e$BMs$N2r@O4o\e(B
+* mime-content-disposition::    mime-content-disposition structure
+* Content-Disposition parser::  Parser for Content-Disposition field
 @end menu
 
 @node mime-content-disposition, Content-Disposition parser, Content-Disposition, Content-Disposition
-@section mime-content-disposition \e$B9=B$BN\e(B
+@section mime-content-disposition structure
 
 @deffn{Structure} mime-content-disposition
 
@@ -645,7 +647,7 @@ Content-Disposition \e$BMs$N\e(B parameter (\e$BO"A[\e(B list).
 
 
 @node Content-Disposition parser,  , mime-content-disposition, Content-Disposition
-@section Content-Disposition \e$BMs$N2r@O4o\e(B
+@section Parser for Content-Disposition field
 
 @defun mime-parse-Content-Disposition string
 
@@ -664,7 +666,7 @@ Content-Disposition \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
 
 
 @node Content-Transfer-Encoding, encoded-word, Content-Disposition, Top
-@chapter \e$BId9f2=K!\e(B
+@chapter Encoding Method
 @cindex Content-Transfer-Encoding \e$BMs\e(B
 
 @strong{Content-Transfer-Encoding \e$BMs\e(B} \e$B$O\e(B entity \e$B$NId9f2=K!$r5-=R$9$k$?$a\e(B
@@ -679,14 +681,14 @@ FLIM \e$B$G$O\e(B Content-Transfer-Encoding \e$BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$
 
 
 @menu
-* Content-Transfer-Encoding parser::  Content-Transfer-Encoding \e$BMs$N2r@O4o\e(B
-* Region encoder/decoder::      \e$BNN0h$NId9f2=!&I|9f2=\e(B
-* String encoder/decoder::      \e$BJ8;zNs$NId9f2=!&I|9f2=\e(B
-* File encoder/decoder::        File \e$B$NId9f2=!&I|9f2=\e(B
+* Content-Transfer-Encoding parser::  Parser
+* Region encoder/decoder::      Region encoding/decoding
+* String encoder/decoder::      String encoding/decoding
+* File encoder/decoder::        File encoding/decoding
 @end menu
 
 @node Content-Transfer-Encoding parser, Region encoder/decoder, Content-Transfer-Encoding, Content-Transfer-Encoding
-@section Content-Transfer-Encoding \e$BMs$N2r@O4o\e(B
+@section Parser
 
 @defun mime-parse-Content-Transfer-Encoding string
 
@@ -706,7 +708,7 @@ Content-Transfer-Encoding \e$BMs$,B8:_$7$J$$>l9g$O\e(B@var{default-encoding} \e$B$r
 
 
 @node Region encoder/decoder, String encoder/decoder, Content-Transfer-Encoding parser, Content-Transfer-Encoding
-@section \e$BNN0h$NId9f2=!&I|9f2=\e(B
+@section Region encoding/decoding
 
 @defun mime-encode-region start end encoding
 
@@ -744,7 +746,7 @@ region decoder and @code{nil} means not to decode.
 
 
 @node String encoder/decoder, File encoder/decoder, Region encoder/decoder, Content-Transfer-Encoding
-@section \e$BJ8;zNs$NId9f2=!&I|9f2=\e(B
+@section String encoding/decoding
 
 @defun mime-decode-string string encoding
 
@@ -763,7 +765,7 @@ content-transfer-encoding.  FUNCTION is string decoder.
 
 
 @node File encoder/decoder,  , String encoder/decoder, Content-Transfer-Encoding
-@section File \e$B$NId9f2=!&I|9f2=\e(B
+@section File encoding/decoding
 
 @defun mime-insert-encoded-file filename encoding
 
@@ -803,7 +805,7 @@ to file.
 
 
 @node encoded-word, custom, Content-Transfer-Encoding, Top
-@chapter Header \e$B$N\e(B network \e$BI=8=\e(B
+@chapter Network representation of header
 @cindex RFC 2047
 @cindex Standards Track
 @cindex RFC 2047
@@ -827,11 +829,11 @@ FLIM \e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#\e(B
 
 
 @menu
-* Header encoder/decoder::      Header \e$B$NId9f2=!&I|9f2=\e(B
+* Header encoder/decoder::      Header encoding/decoding
 @end menu
 
 @node Header encoder/decoder,  , encoded-word, encoded-word
-@section Header \e$B$NId9f2=!&I|9f2=\e(B
+@section Header encoding/decoding
 
 @defun eword-encode-header &optional  code-conversion separator
 
@@ -857,7 +859,7 @@ It refer variable @code{eword-field-encoding-method-alist}.
 
 
 @node custom, Appendix, encoded-word, Top
-@chapter \e$B0lHL@_Dj\e(B
+@chapter Various Customization
 
 @deffn{group} mime