X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=mime-en.sgml;h=4e8dcade58a9c9d2fa446e4e0e2fc19b8de13374;hb=57a3177465e8d977a8b2423f4343eefd3adf3d00;hp=1ec17582bc6aaedc9b55a381fd78cec01fb932f5;hpb=1126ce6d802977911ec3eb93a67749ba15609b44;p=elisp%2Fflim.git diff --git a/mime-en.sgml b/mime-en.sgml index 1ec1758..4e8dcad 100644 --- a/mime-en.sgml +++ b/mime-en.sgml @@ -1,8 +1,8 @@
--This file documents MIME features of FLIM, a Internet message -parsing/encoding library for GNU Emacs. +This file documents MIME features of FLIM, a fundamental library to +process Internet Messages for GNU Emacsen.
@@ -183,6 +187,15 @@ If message is not specified,
+Return entity from cid in message.
+
+If message is not specified,
+mime-message-structure
is used.
mime-message-structure
is used.
+
nil
.
-
+
Insert before point a decoded contents of header of entity.
@@ -276,8 +293,32 @@ field-name to hide.
If a field-name is matched with some elements of
invisible-fields and matched with none of
visible-fields, this function don't insert the field.
+
+Each
+Insert before point a contents of entity as text entity.
+
+Contents of the entity are decoded as
+Symbol to indicate default value of
+It is used when MIME charset is not specified.
+
+It is originally variable of APEL.
+default-mime-charset
.
+default-mime-charset
is
+used as default value.
+Insert content of entity at point. +
Write content of entity into filename.
+
+Insert header and body of entity at point.
+
@@ -393,12 +450,42 @@ return the result.
-(It is not written yet, sorry. (^_^;)
+
+Define type as a mm-backend.
+
+If PARENTS is specified, type inherits parents.
+Each parent must be representation-type.
+
+Example:
-(Please read mm*.el)
+
+Define name as a method function of (nth 1 (car
+args)) backend.
+
+args is like an argument list of lambda, but (car
+args) must be specialized parameter. (car (car
+args)) is name of variable and (nth 1 (car
+args)) is name of backend (representation-type).
+
+Example:
+
+
-Parse string as field-body of Content-Type field.
+Parse string as a field-body of Content-Type field, and
+return the result as
-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
Return
Return type/subtype string from type and
subtype.
@@ -538,10 +626,10 @@ specify presentation of an entity or attributes of an entity, such as
file name.
FLIM provides parser for Content-Disposition field and structure
Parse string as field-body of Content-Disposition field,
-and return the result.
+and return the result as
-Read field-body of Content-Disposition field from current-buffer,
+Parse Content-Disposition field of the current buffer, and return the
+result as
-Return nil if Content-Disposition field is not found.
+Return
-
-FLIM $B$G$O(B Content-Transfer-Encoding $BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$3(B
-$B$l$i$N4X?t$O(B Content-Transfer-Encoding $BMs$N>pJs$OJ8;zNs$GI=8=$7$^$9!#(B
+FLIM provides parser functions for Content-Transfer-Encoding field.
+They represent information of Content-Transfer-Encoding field as
+string.
-$B$^$?!"(BContent-Transfer-Encoding $B$K4p$E$$$FId9f2=!&I|9f2=$r9T$&4X?t$bDs(B
-$B6!$5$l$^$9!#(B
+In addition, FLIM provides encoder/decoder functions by
+Content-Transfer-Encoding.
-string $B$r(B content-transfer-encoding $B$H$7$F2r@O$7$?7k2L$rJV$9!#(B
+Parse string as a field-body of Content-Transfer-Encoding
+field, and return the result.
-$B8=:_$N(B buffer $B$N(B Content-Transfer-Encoding $BMs$rFI$_
-Alist of encoding vs. corresponding method to encode region.
-
-Each element looks like
-Alist of encoding vs. corresponding method to decode region.
-
-Each element looks like
-string $B$r(B encoding $B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#(B
+Decode string which is encoded in encoding, and
+return the result.
-Alist of encoding vs. corresponding method to decode string.
-
-Each element looks like
@@ -710,68 +769,172 @@ Decode and write current region encoded by encoding into
start and end are buffer positions.
-Alist of encoding vs. corresponding method to insert encoded file.
+
-Each element looks like
+If service is specified, it returns available list of
+Content-Transfer-Encoding for it.
+
-
-Alist of encoding vs. corresponding method to write decoded region to
-file.
+Return table of Content-Transfer-Encoding for completion.
-Each element looks like
+
+Define name as a method function of (nth 1 (car (last
+args))) backend.
+
+args is like an argument list of lambda, but (car (last
+args)) must be specialized parameter. (car (car (last
+args))) is name of variable and (nth 1 (car (last
+args))) is name of backend (encoding).
+
+Example:
+
+
+Set spec's function definition to function.
+
+First element of spec is service.
+
+Rest of args is like an argument list of lambda, but (car
+(last args)) must be specialized parameter. (car (car
+(last args))) is name of variable and (nth 1 (car (last
+args))) is name of backend (encoding).
+
+Example:
+
+
+
+Define name as a service for Content-Transfer-Encodings.
+
+If args is specified, name is defined as a
+generic function for the service.
+
+Example:
+
+
-encoded-word $B$O(B header $B$GHs(B
-$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"(Bencoded-word $B$rMQ$$$:$KHs(B
-
-FLIM $B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#(B
+FLIM provides encoding/decoding features of both encoded-word and
+invalid "raw" non-
-
Decode MIME encoded-words in header fields.
-If code-conversion is
-If separator is not nil, it is used as header separator.
+If separator is not
Encode header fields to network representation, such as MIME
encoded-word.
-It refer variable
+Association list to specify field encoding method. Each element looks
+like (FIELD . METHOD).
+
+If METHOD is
+If METHOD is
+If METHOD is a MIME charset, the FIELD will be encoded as the charset
+when it must be convert into network-code.
+
+Otherwise the FIELD will be encoded as variable
+
-$BE,@Z$J(B
-$BK\Mh$O(B APEL $B$NJQ?t$G$"$k!#(B
-
MIME $B5!G=$K4X$9$k
If you write bug-reports and/or suggestions for improvement, please
-send them to the tm Mailing List:
+send them to the EMACS-MIME Mailing List:
@@ -1156,16 +1311,16 @@ to send backtrace is very important.
-Via the tm ML, you can report FLIM bugs, obtain the latest release of
-FLIM, and discuss future enhancements to FLIM. To join the tm ML,
-send empty e-mail to:
+Via the EMACS-MIME ML, you can report FLIM bugs, obtain the latest
+release of FLIM, and discuss future enhancements to FLIM. To join the
+EMACS-MIME ML, send an empty e-mail to:
+$B$I$&$7$F$b(B ssh $B$,;H$($J$$>l9g!"(Bpserver $B7PM3$G$b3+H/$K;22C$G$-$^$9!#(B
+$B$3$N>l9g!"(BUNIX $B$N(B /etc/passwd $BMM<0$G0E9f2=$5$l$?%Q%9%o!<%I$rAw$C$F2<$5$$!#(B
+$B$3$N>l9g(B cvsroot $B$O(B :pserver:<$B%"%+%&%s%HL>(B>@cvs.m17n.org:/cvs/root $B$H$J$j$^$9!#(B
nil
if Content-Type field is not found.
nil
if Content-Type field is not found.
nil
if Content-Disposition field is not found.
Encoding Method
Parser
nil
is used as the
+default value.
Region encoding/decoding
-
Encoder/decoder
+
(STRING . FUNCTION)
or
-(STRING . nil)
. string is
-content-transfer-encoding. function
is region encoder
-and nil
means not to encode.
-(STRING . FUNCTION)
or
-(STRING . nil)
. string is
-content-transfer-encoding. function
is region decoder
-and nil
means not to decode.
- String encoding/decoding
-
(STRING . FUNCTION)
.
-STRING is content-transfer-encoding.
-FUNCTION is string decoder.
- File encoding/decoding
-
Other utilities
+
(STRING . FUNCTION)
. STRING is
-content-transfer-encoding. FUNCTION is function to insert encoded
-file.
-(STRING . FUNCTION)
. STRING is
-content-transfer-encoding. FUNCTION is function to write decoded
-region to file.
- How to write encoder/decoder module
+
How to add encoding/decoding service
+
Network representation of header
Header encoding/decoding
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.
+If code-conversion is nil
, only encoded-words
+are decoded. If code-conversion is a default-mime-charset
. nil
, it is used as header
+separator.
eword-field-encoding-method-alist
.
+Each field is encoded as corresponding method specified by variable
+eword-field-encoding-method-alist
.
mime
, the FIELD will be encoded into MIME
+format (encoded-word).
+nil
, the FIELD will not be encoded.
+default-mime-charset
when it must be convert into
+network-code.
+ Various Customization
mail
$B$H(B news
$B$KB0$9$k!#(B
-
-
-
@@ -1178,14 +1333,13 @@ FLIM $B$N(B file $B$O(B CVS $B$r;H$C$F4IM}$5$l$F$$$^$9!#$3$N$?$a!"0J2<$NJ}K
-
History of FLIM