X-Git-Url: http://git.chise.org/gitweb/?p=elisp%2Fflim.git;a=blobdiff_plain;f=mime-en.sgml;h=6e5b959058ff22ff880075a654f7b10126bea98c;hp=a8e0e42a37c0716d47de15ea3035069d791d3488;hb=HEAD;hpb=f0a9e3c90638ef0c24c80ab431d40ecbdad2d152 diff --git a/mime-en.sgml b/mime-en.sgml index a8e0e42..6e5b959 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:
+
+
+Define name as a method function of (nth 1 (car
+args)) backend.
-(Please read mm*.el)
+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:
+
+
-Content-Type 欄の形式は以下のように定義されています:
+Format of Content-Type field is defined as follows:
``Content-Type'' ``:''
-例えば、
+For example:
-ここで、`type' と `subtype' は entity の形式を示すもので、両者を総称し
-て、`media-type' と呼ぶことにします。上記の例における `image/jpeg' や
-`text/plain' は media-type の1つです。
+`type' and `subtype' indicate format of an entity. In this document,
+pair of them is called `media-type'. `image/jpeg' or `text/plain' is
+a media-type.
-Content-Type 欄のない entity は
+If an entity does not have Content-Type field, it is regarded as
+following:
-Content-Type 欄の情報を格納するための構造体。
+Structure to store information of a Content-Type field.
-この構造体を参照するには
-この構造体の要素は以下の通りである:
+Slots of the structure are following:
content-type の生成子。
+ Constructor of content-type.
-content-type の parameter の値を返す。
+Return value of parameter of content-type.
-string を content-type として解析した結果を返す。
+Parse string as a field-body of Content-Type field, and
+return the result as
-現在の buffer の Content-Type 欄を読み取り、解析した結果を返す。
+Parse Content-Type field of the current buffer, and return the result
+as
-Content-Type 欄が存在しない場合は nil を返す。
+Return
Return type/subtype string from type and
subtype.
@@ -536,18 +621,19 @@ Return type/subtype string from type and
-
-FLIM は Content-Disposition 欄を構文解析する関数と Content-Disposition
-欄の解析結果を格納する構造体
-
-Content-Disposition 欄の解析結果を収めるための構造体。
+Structure to store information of a Content-Disposition field.
-この構造体を参照するには
-この構造体の要素は以下の通りである:
+Slots of the structure are following:
-content-disposition の parameter の値を返す。
+Return value of parameter of
+content-disposition.
-content-disposition の filename の値を返す。
+Return filename of content-disposition.
-string を content-disposition として解析した結果を返す。
+Parse string as field-body of Content-Disposition field,
+and return the result as
-現在の buffer の Content-Disposition 欄を読み取り、解析した結果を返す。
+Parse Content-Disposition field of the current buffer, and return the
+result as
-Content-Disposition 欄が存在しない場合は nil を返す。
+Return
-
-FLIM では Content-Transfer-Encoding 欄を構文解析する関数を提供します。こ
-れらの関数は Content-Transfer-Encoding 欄の情報は文字列で表現します。
+FLIM provides parser functions for Content-Transfer-Encoding field.
+They represent information of Content-Transfer-Encoding field as
+string.
-また、Content-Transfer-Encoding に基づいて符号化・復号化を行う関数も提
-供されます。
+In addition, FLIM provides encoder/decoder functions by
+Content-Transfer-Encoding.
-string を content-transfer-encoding として解析した結果を返す。
+Parse string as a field-body of Content-Transfer-Encoding
+field, and return the result.
-現在の buffer の Content-Transfer-Encoding 欄を読み取り、解析した結果を
-返す。
+Parse Content-Transfer-Encoding field of the current buffer, and
+return the result.
-Content-Transfer-Encoding 欄が存在しない場合は
-default-encoding を返す。
+Return default-encoding if Content-Transfer-Encoding field
+is not found. If it is not specified,
-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 を encoding として復号した結果を返します。
+Decode string which is encoded in encoding, and
+return the result.
-Alist of encoding vs. corresponding method to decode string.
-
-Each element looks like
@@ -708,96 +769,182 @@ 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 は header で非
-また、行儀の悪いことだと言えますが、encoded-word を用いずに非
-
-FLIM はこれらを符号化・復号化する機能を提供します。
+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
-
-MIME 関連機能に関する group.
+If METHOD is
-
-適切な
-本来は APEL の変数である。
+Otherwise the FIELD will be encoded as variable
+
-MIME 機能に関する実装が一時的に使用する file を作成する directory.
+
-環境変数
+It belongs to
Any byte stream is called
-It does not require structureof lines. It differs from from 8bit.
In addition, if line structured data contain too long line (more than
@@ -1133,11 +1280,11 @@ be interpreted as us-ascii.
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:
@@ -1154,49 +1301,48 @@ 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:
-FLIM の file は CVS を使って管理されています。このため、以下の方法で最
-新の FLIM を入手することができます:
+Files in FLIM are managed under CVS. Therefore you can obtain the
+newest FLIM by the following method:
-CVS を用いた開発に参加したい方は
+If you would like to join CVS based development, please send mail to
-
-
-
mime-content-type-要素名
という名
-前の参照関数を用いる。
+Applications should use reference functions
+mime-content-type-SLOT
to refer information of the
+structure.
nil
if Content-Type field is not found.
Information of Content-Disposition field
mime-content-disposition structure
@@ -555,17 +641,19 @@ FLIM は Content-Disposition 欄を構文解析する関数と Content-Dispositi
mime-content-disposition-要素名
と
-いう名前の参照関数を用いる。
+Applications should use reference functions
+mime-content-disposition-SLOT
to refer information of the
+structure.
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
+mime-field-encoding-method-alist
.
Various Customization
-
mime
, the FIELD will be encoded into MIME
+format (encoded-word).
mail
と news
に属する。
-nil
, the FIELD will not be encoded.
default-mime-charset
when it must be convert into
+network-code.
Various Customization
+
MIME_TMP_DIR
, TM_TMP_DIR
,
-TMPDIR
, TMP
もしくは TEMP
が設定
-されていた場合、それを初期値として用いる。何も設定されていない場合、
-"/tmp/"
を用いる。
-mail
and news
.
+
Appendix
@@ -895,7 +1042,7 @@ translated by non-Internet gateways.
-
-
CVS based development
-
History of FLIM