Mercurial > hg > xemacs-beta

comparison man/tm/tm-view-en.texi @ 10:49a24b4fd526 r19-15b6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r19-15b6
author cvs
date Mon, 13 Aug 2007 08:47:52 +0200
parents 4b173ad71786
children 0293115a14e9
comparison
equal deleted inserted replaced
9:6f2bbbbbe05a 10:49a24b4fd526
1 \input texinfo.tex 1 \input texinfo.tex
2 @setfilename tm-view-en.info 2 @setfilename tm-view-en.info
3 @settitle{tm-view 7.77 Reference Manual (English Version)} 3 @settitle{tm-view 7.79 Reference Manual (English Version)}
4 @titlepage 4 @titlepage
5 @title tm-view 7.77 Reference Manual (English Version) 5 @title tm-view 7.79 Reference Manual (English Version)
6 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp> 6 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp>
7 @subtitle 1996/10/11 7 @subtitle 1996/12/25
8 @end titlepage 8 @end titlepage
9 @node Top, Introduction, (dir), (dir) 9 @node Top, Introduction, (dir), (dir)
10 @top tm-view 7.77 Reference Manual (English Version) 10 @top tm-view 7.79 Reference Manual (English Version)
11 11
12 @ifinfo 12 @ifinfo
13 13
14 This file documents tm-view, a MIME Viewer for GNU Emacs. 14 This file documents tm-view, a MIME Viewer for GNU Emacs.
15 @end ifinfo 15 @end ifinfo
19 * MIME display:: Structure of display in mime/viewer-mode 19 * MIME display:: Structure of display in mime/viewer-mode
20 * mime/viewer-mode:: Navigation in mime/viewer-mode 20 * mime/viewer-mode:: Navigation in mime/viewer-mode
21 * method:: Mechanism of decoding 21 * method:: Mechanism of decoding
22 * Two buffers for an article:: raw-article-buffer and preview-buffer 22 * Two buffers for an article:: raw-article-buffer and preview-buffer
23 * API:: Functions to decode MIME message 23 * API:: Functions to decode MIME message
24 * Acknowledgments::
24 * Concept Index:: 25 * Concept Index::
25 * Function Index:: 26 * Function Index::
26 * Variable Index:: 27 * Variable Index::
27 @end menu 28 @end menu
28 29
29 @node Introduction, MIME display, Top, Top 30 @node Introduction, MIME display, Top, Top
30 @chapter What is tm-view? 31 @chapter What is tm-view?
32 @cindex filter
33 @cindex method
31 34
32 The tm-view is a general MIME viewer running on GNU Emacs.@refill 35 The tm-view is a general MIME viewer running on GNU Emacs.@refill
33 36
34 tm-view provides the major-mode called @code{mime/viewer-mode} 37 tm-view provides the major-mode called @code{mime/viewer-mode}
35 (@ref{mime/viewer-mode}) to read MIME message for MUA. MUA 38 (@ref{mime/viewer-mode}) to read MIME message for MUA. MUA
36 (@ref{(tm-en)MUA}) implementer can use it to add MIME function.@refill 39 (@ref{(tm-en)MUA}) implementer can use it to add MIME function.@refill
37 40
38 tm-view is a user interface kernel to view and navigate MIME message. 41 tm-view is a user interface kernel to view and navigate MIME message.
39 tm-view drives some programs to navigate each content-type 42 tm-view drives some programs to navigate each content-type
40 (@ref{(tm-en)content-type})s, they are called 43 (@ref{(tm-en)content-type})s, they are called @strong{method}
41 @cindex{method}@strong{method} (@ref{method}). tm-view calls some 44 (@ref{method}). tm-view calls some programs to display each contents
42 programs to display each contents and headers in preview buffer, they 45 and headers in preview buffer, they are called @strong{filter} (@ref{Two buffers for an article}). Method and filters are tm-view application
43 are called @cindex{filter}@strong{filter} (@ref{Two buffers for an 46 program. They expand tm-view to treat various kinds of MIME types.
44 article}). Method and filters are tm-view application program. They
45 expand tm-view to treat various kinds of MIME types.
46 47
47 48
48 @node MIME display, mime/viewer-mode, Introduction, Top 49 @node MIME display, mime/viewer-mode, Introduction, Top
49 @chapter Structure of display in mime/viewer-mode 50 @chapter Structure of display in mime/viewer-mode
50 51
121 * content-separator:: 122 * content-separator::
122 @end menu 123 @end menu
123 124
124 @node content-button, content-header, MIME display, MIME display 125 @node content-button, content-header, MIME display, MIME display
125 @section content-button 126 @section content-button
127 @cindex content-number
126 128
127 content-subject displays abstract for the part. It is placed in top of 129 content-subject displays abstract for the part. It is placed in top of
128 the part.@refill 130 the part.@refill
129 131
130 In default, it is displayed following design: 132 In default, it is displayed following design:
133 [1.3 test (text/plain)] 135 [1.3 test (text/plain)]
134 @end example 136 @end example
135 137
136 138
137 First number field represents position of a content in the part. It is 139 First number field represents position of a content in the part. It is
138 called @cindex{content-number}@strong{content-number}. It can be 140 called @strong{content-number}. It can be considered as the chapter
139 considered as the chapter number in the message.@refill 141 number in the message.@refill
140 142
141 Second string part represents title. It is created by following: 143 Second string part represents title. It is created by following:
142 144
143 @enumerate 145 @enumerate
144 @item 146 @item
187 189
188 190
189 191
190 @node content-header, content-body, content-button, MIME display 192 @node content-header, content-body, content-button, MIME display
191 @section content-header 193 @section content-header
194 @cindex content-header-filter
192 195
193 A content header displays the header portion of a part in the 196 A content header displays the header portion of a part in the
194 preview-buffer. However it is annoying to display header for every 197 preview-buffer. However it is annoying to display header for every
195 parts, so tm-view provides a mechanism to specify its condition.@refill 198 parts, so tm-view provides a mechanism to specify its condition.@refill
196 199
208 if you redefine function @code{mime-viewer/header-visible-p}, it may not 211 if you redefine function @code{mime-viewer/header-visible-p}, it may not
209 work. So if you want to redefine it, it should be refer variable 212 work. So if you want to redefine it, it should be refer variable
210 @code{mime-viewer/childrens-header-showing-Content-Type-list}.@refill 213 @code{mime-viewer/childrens-header-showing-Content-Type-list}.@refill
211 214
212 When content-header is displayed, content-header are formated by the 215 When content-header is displayed, content-header are formated by the
213 program called by 216 program called by @strong{content-header-filter}. Content-header-filter
214 @cindex{content-header-filter}@strong{content-header-filter}. 217 is searched from variable
215 Content-header-filter is searched from variable
216 @code{mime-viewer/content-header-filter-alist}. Its key is major-mode 218 @code{mime-viewer/content-header-filter-alist}. Its key is major-mode
217 of the raw-article-buffer (@ref{raw-article-buffer}). If not found, 219 of the raw-article-buffer (@ref{raw-article-buffer}). If not found,
218 function @code{mime-viewer/default-content-header-filter} is 220 function @code{mime-viewer/default-content-header-filter} is
219 called.@refill 221 called.@refill
220 222
273 275
274 276
275 277
276 @node content-body, content-separator, content-header, MIME display 278 @node content-body, content-separator, content-header, MIME display
277 @section content-body 279 @section content-body
278 280 @cindex content-filter
279 @cindex{content-body}@strong{content-body} represents content of the 281 @cindex content-body
280 part.@refill 282
283 @strong{content-body} represents content of the part.@refill
281 284
282 tm-view does not display raw content body. For example, if a content 285 tm-view does not display raw content body. For example, if a content
283 has binary, it is hidden. If a content has text/enriched, it is 286 has binary, it is hidden. If a content has text/enriched, it is
284 formated. Namely content body is hidden or formated.@refill 287 formated. Namely content body is hidden or formated.@refill
285 288
288 content-body is hidden. In default, it returns non-@code{nil} when 291 content-body is hidden. In default, it returns non-@code{nil} when
289 content-type of a part is a member of variable 292 content-type of a part is a member of variable
290 @code{mime-viewer/default-showing-Content-Type-list}.@refill 293 @code{mime-viewer/default-showing-Content-Type-list}.@refill
291 294
292 When content-body of a content is displayed, content-body is formated by 295 When content-body of a content is displayed, content-body is formated by
293 @cindex{content-filter}@strong{content-filter}. Content-filter is 296 @strong{content-filter}. Content-filter is searched from variable
294 searched from variable @code{mime-viewer/content-filter-alist}. At this 297 @code{mime-viewer/content-filter-alist}. At this time, major-mode of
295 time, major-mode of the raw-article-buffer (@ref{raw-article-buffer}) is 298 the raw-article-buffer (@ref{raw-article-buffer}) is used as the key.
296 used as the key.
297 299
298 If it is not found, function 300 If it is not found, function
299 @code{mime-viewer/default-content-filter} is called. 301 @code{mime-viewer/default-content-filter} is called.
300 302
301 303
336 338
337 339
338 340
339 @node content-separator, , content-body, MIME display 341 @node content-separator, , content-body, MIME display
340 @section content-separator 342 @section content-separator
341 343 @cindex content-separator
342 @cindex{content-separator}@strong{content-separator} is displayed to 344
343 represent boundary of contents.@refill 345 @strong{content-separator} is displayed to represent boundary of
346 contents.@refill
344 347
345 Content-separator is displayed by function 348 Content-separator is displayed by function
346 @code{mime-viewer/default-content-separator}. In default, it displays 349 @code{mime-viewer/default-content-separator}. In default, it displays
347 line-break when content-header and content-body are not 350 line-break when content-header and content-body are not
348 displayed.@refill 351 displayed.@refill
433 436
434 437
435 438
436 @node method, Two buffers for an article, mime/viewer-mode, Top 439 @node method, Two buffers for an article, mime/viewer-mode, Top
437 @chapter Mechanism of decoding 440 @chapter Mechanism of decoding
441 @cindex external method
442 @cindex internal method
443 @cindex method
444 @cindex decoding-mode
445 @cindex decoding operation(s) (for a part)
438 446
439 In @code{mime/viewer-mode}, you can do play (@kbd{v}), extract 447 In @code{mime/viewer-mode}, you can do play (@kbd{v}), extract
440 (@kbd{e}), or print (@kbd{C-c C-p}) for each parts. These operations 448 (@kbd{e}), or print (@kbd{C-c C-p}) for each parts. These operations
441 are called @cindex{decoding operation(s) (for a part)}@strong{decoding 449 are called @strong{decoding operation(s) (for a part)}. And kind of
442 operation(s) (for a part)}. And kind of decoding operations are called 450 decoding operations are called @strong{decoding-mode}.@refill
443 @cindex{decoding-mode}@strong{decoding-mode}.@refill
444 451
445 When decoding operation is driven, tm-view calls a procedure matched for 452 When decoding operation is driven, tm-view calls a procedure matched for
446 the condition, such as content-type (@ref{(tm-en)content-type}) of the 453 the condition, such as content-type (@ref{(tm-en)content-type}) of the
447 part or its environment. This procedure is called 454 part or its environment. This procedure is called
448 @cindex{method}@strong{method}.@refill 455 @strong{method}.@refill
449 456
450 There are two kinds of methods. One is Emacs Lisp function, called 457 There are two kinds of methods. One is Emacs Lisp function, called
451 @cindex{internal method}@strong{internal method}. Another one is 458 @strong{internal method}. Another one is external program, called
452 external program, called @cindex{external method}@strong{external 459 @strong{external method}.@refill
453 method}.@refill
454 460
455 Internal method operates in Emacs, so it can do carefully.@refill 461 Internal method operates in Emacs, so it can do carefully.@refill
456 462
457 External method is called as asynchronous process, so Emacs does not 463 External method is called as asynchronous process, so Emacs does not
458 wait while method is running. So it is good for big data, such as 464 wait while method is running. So it is good for big data, such as
714 720
715 721
716 722
717 @node Two buffers for an article, API, method, Top 723 @node Two buffers for an article, API, method, Top
718 @chapter raw-article-buffer and preview-buffer 724 @chapter raw-article-buffer and preview-buffer
725 @cindex filter
726 @cindex content-filter
727 @cindex header-filter
728 @cindex preview-buffer
729 @cindex raw-article-buffer
719 730
720 tm-view managements two buffers, one is for raw message called 731 tm-view managements two buffers, one is for raw message called
721 @cindex{raw-article-buffer}@strong{raw-article-buffer}, another one is 732 @strong{raw-article-buffer}, another one is to preview for user called
722 to preview for user called 733 @strong{preview-buffer}. major-mode of raw-article-buffer is same as
723 @cindex{preview-buffer}@strong{preview-buffer}. major-mode of 734 major-mode for article of original MUA, major-mode of preview-buffer is
724 raw-article-buffer is same as major-mode for article of original MUA, 735 @code{mime/viewer-mode} (@ref{mime/viewer-mode}).@refill
725 major-mode of preview-buffer is @code{mime/viewer-mode}
726 (@ref{mime/viewer-mode}).@refill
727 736
728 When called @code{mime/viewer-mode}, tm-view analyzes 737 When called @code{mime/viewer-mode}, tm-view analyzes
729 raw-article-buffer, and sets its result to the variable 738 raw-article-buffer, and sets its result to the variable
730 @code{mime::article/content-info}.@refill 739 @code{mime::article/content-info}.@refill
731 740
732 After that, tm-view create a preview-buffer corresponded to the 741 After that, tm-view create a preview-buffer corresponded to the
733 raw-article-buffer. As this time, tm-view modifies header and body of 742 raw-article-buffer. As this time, tm-view modifies header and body of
734 each parts of the message by specified conditions. Filter program for 743 each parts of the message by specified conditions. Filter program for
735 header is called @cindex{header-filter}@strong{header-filter} 744 header is called @strong{header-filter} (@ref{content-header}), filter
736 (@ref{content-header}), filter program for body is called 745 program for body is called @strong{content-filter} (@ref{content-body}),
737 @cindex{content-filter}@strong{content-filter} (@ref{content-body}), and 746 and they are called @strong{filter}.@refill
738 they are called @cindex{filter}@strong{filter}.@refill
739 747
740 When preview-buffer is made, buffer local variable of preview-buffer 748 When preview-buffer is made, buffer local variable of preview-buffer
741 @code{mime::preview/content-list} is made to register structure of 749 @code{mime::preview/content-list} is made to register structure of
742 preview-buffer. tm-view manages message by 750 preview-buffer. tm-view manages message by
743 @code{mime::article/content-info} in raw-article-buffer and 751 @code{mime::article/content-info} in raw-article-buffer and
757 * preview-buffer:: Buffer local variables of preview-buffer 765 * preview-buffer:: Buffer local variables of preview-buffer
758 @end menu 766 @end menu
759 767
760 @node raw-article-buffer, preview-buffer, Two buffers for an article, Two buffers for an article 768 @node raw-article-buffer, preview-buffer, Two buffers for an article, Two buffers for an article
761 @section buffer local variables of raw-article-buffer 769 @section buffer local variables of raw-article-buffer
770 @cindex content-info
762 771
763 @deffn{Structure} mime::content-info rcnum point-min point-max type parameters encoding children 772 @deffn{Structure} mime::content-info rcnum point-min point-max type parameters encoding children
764 773
765 structure to represent MIME content in raw-article-buffer. It is called 774 structure to represent MIME content in raw-article-buffer. It is called
766 by @cindex{content-info}@strong{content-info}.@refill 775 by @strong{content-info}.@refill
767 776
768 Please use reference function @code{mime::content-info/SLOT-NAME} to 777 Please use reference function @code{mime::content-info/SLOT-NAME} to
769 reference slot of content-info. Their argument is only 778 reference slot of content-info. Their argument is only
770 content-info.@refill 779 content-info.@refill
771 780
854 863
855 864
856 865
857 @node preview-buffer, , raw-article-buffer, Two buffers for an article 866 @node preview-buffer, , raw-article-buffer, Two buffers for an article
858 @section Buffer local variables of preview-buffer 867 @section Buffer local variables of preview-buffer
868 @cindex preview-content-info
859 869
860 @defvar mime::preview/mother-buffer 870 @defvar mime::preview/mother-buffer
861 871
862 Mother buffer of this preview-buffer. 872 Mother buffer of this preview-buffer.
863 @end defvar 873 @end defvar
864 874
865 875
866 @deffn{Structure} mime::preview-content-info point-min point-max buffer content-info 876 @deffn{Structure} mime::preview-content-info point-min point-max buffer content-info
867 877
868 structure to represent MIME content in preview-buffer. It is called by 878 structure to represent MIME content in preview-buffer. It is called by
869 @cindex{preview-content-info}@strong{preview-content-info}.@refill 879 @strong{preview-content-info}.@refill
870 880
871 Please use reference function 881 Please use reference function
872 @code{mime::preview-content-info/SLOT-NAME} to reference slot of 882 @code{mime::preview-content-info/SLOT-NAME} to reference slot of
873 preview-content-info. Their argument is only 883 preview-content-info. Their argument is only
874 preview-content-info.@refill 884 preview-content-info.@refill
930 If @var{cinfo} is omitted, @code{mime::preview/content-list} is used. 940 If @var{cinfo} is omitted, @code{mime::preview/content-list} is used.
931 @end defun 941 @end defun
932 942
933 943
934 944
935 @node API, Concept Index, Two buffers for an article, Top 945 @node API, Acknowledgments, Two buffers for an article, Top
936 @chapter Functions to decode MIME message 946 @chapter Functions to decode MIME message
937 947
938 tm-view provides some available functions to decode and navigate MIME 948 tm-view provides some available functions to decode and navigate MIME
939 message to each MUA (@ref{(tm-en)MUA})s.@refill 949 message to each MUA (@ref{(tm-en)MUA})s.@refill
940 950
1026 folding or raw CR or LF, it unfolds or delete raw CR or LF. 1036 folding or raw CR or LF, it unfolds or delete raw CR or LF.
1027 @end defun 1037 @end defun
1028 1038
1029 1039
1030 1040
1031 @node Concept Index, Function Index, API, Top 1041 @node Acknowledgments, Concept Index, API, Top
1042 @chapter Acknowledgments
1043
1044 First of all, I thank MASUTANI Yasuhiro. He requested me a lot of
1045 important features and gave me a lot of suggestions when tm-view was
1046 born. tm-view is based on his influence.@refill
1047
1048 I thank ENAMI Tsugutomo for work of @file{mime.el}, which is an origin
1049 of @file{tm-ew-d.el} and @file{mel-b.el}, and permission to rewrite for
1050 tm.@refill
1051
1052 I thank OKABE Yasuo for work of internal method for LaTeX and automatic
1053 assembling method for message/partial. I thank UENO Hiroshi for work of
1054 internal method for tar archive.@refill
1055
1056 Last of all, I thank members of two tm mailing lists, Japanese and
1057 English version.
1058
1059
1060 @node Concept Index, Function Index, Acknowledgments, Top
1032 @chapter Concept Index 1061 @chapter Concept Index
1033 1062
1034 @printindex cp 1063 @printindex cp
1035 1064
1036 @node Function Index, Variable Index, Concept Index, Top 1065 @node Function Index, Variable Index, Concept Index, Top