This commit was generated by cvs2svn to compensate for changes in r542,
[elisp/tm.git] / doc / tm-view-ch_en.texi
1 @c $Id: tm-view-ch_en.texi,v 1.1 1995/12/13 09:28:43 morioka Exp $
2
3 @node content-header, content-body, content-subject, MIME display
4 @comment  node-name,  next,  previous,  up
5 @subsubsection content-header
6 @cindex content-header
7
8 A content header shows the header portion of a content in the preview
9 buffer.
10
11 When the function @code{mime-viewer/header-visible-p} returns @code{t}
12 for content-number of a content, content-header is displayed. This
13 judge function returns @code{t} when a content is root or content-type
14 of its parent is a member of the variable
15 @code{mime-viewer/childrens-header-showing-Content-Type-list}.
16
17 If you want to change this condition, please redefine it.
18
19 When content-header is displayed, content-header are formated by
20 content-header-filter. Content-header-filter is searched from variable
21 @code{mime-viewer/content-header-filter-alist}. Its key is major-mode
22 of the article buffer. If not found, function
23 @code{mime-viewer/default-content-header-filter} is called.
24
25
26 @defvar mime-viewer/childrens-header-showing-Content-Type-list
27
28 List of content-type. If content-type of parent of a content is a
29 member of this variable, its content-header is displayed. Default
30 value is "message/rfc822".
31
32 This variable is referred by the function
33 @code{mime-viewer/header-visible-p}.
34 @end defvar
35
36
37 @deffn{Function} mime-viewer/header-visible-p rcnum cinfo &optional ctype
38
39 Returns @code{t} if a content is displayed.
40
41 @var{cnum} is content-number. @var{cinfo} is content-info. If you know 
42 content-type, you can specify by @var{ctype}.
43 @end deffn
44
45
46 @defvar mime-viewer/content-header-filter-alist
47
48 Association-list whose key is major-mode of a article buffer, value is
49 content-header-filter.
50 @end defvar
51
52
53 @deffn{Function} mime-viewer/default-content-header-filter
54
55 It is called when content-header-filter is not found in variable
56 @code{mime-viewer/content-header-filter-alist}.
57 @end deffn
58
59
60 @defvar mime-viewer/ignored-field-list
61
62 List of regular expression to represent invisible fields.
63
64 Variable @code{mime-viewer/ignored-field-regexp} is created from it.
65
66 Please use function @code{tm:add-fields} or @code{tm:delete-fields} to 
67 set it.
68 @end defvar