This commit was generated by cvs2svn to compensate for changes in r542,
[elisp/tm.git] / doc / tm-view-cs=en.texi
1 @c $Id: tm-view-cs_en.texi,v 1.1 1995/12/13 09:29:00 morioka Exp $
2
3 @node content-subject, content-header, MIME display, MIME display
4 @comment  node-name,  next,  previous,  up
5 @subsubsection content-subject
6 @cindex content-subject
7
8 content-subject is a part to display abstract for the content. It is
9 placed in top of content.
10
11 In default, it is displayed following design:
12
13 @example
14         [1.3 test (text/plain)]
15 @end example
16
17 First number field represents position of a content in the message. It
18 is called `content-number'. It can be considered as the chapter number
19 in the message.
20
21 Second string part represents title. It is created by following:
22
23 @itemize @bullet
24 @item name paramater or x-name parameter in Content-Type field
25 @item Content-Description field or Subject field
26 @item filename of uuencode
27 @end itemize
28
29 If they are not exists, space is displayed.
30
31 Third parenthesis part represents content-type/subtype of the content. 
32 If it is non-MIME part, @code{nil} is displayed.
33
34 Content-subject is used like icon when content-header and content-body
35 are hidden. For example,
36
37 @example
38         [2  (image/gif)]
39 @end example
40
41 if you press `v' key, GIF image is displayed.
42
43
44 @defvr{Variable} mime-viewer/content-subject-omitting-Content-Type-list
45
46 List of content-type. If content-type of a content is a member of this
47 list, its content-subject is not displayed.
48
49 This variable is referenced by function
50 @code{mime-viewer/default-content-subject-function}.
51 @end defvr
52
53
54 @deffn{Function} mime-viewer/default-content-subject-function rcnum cinfo ctype params subj
55
56 Default value of the variable
57 @code{mime-viewer/content-subject-function}.  It refers variable
58 @code{mime-viewer/content-subject-omitting-Content-Type-list}.
59 @end deffn
60
61
62 @defvar mime-viewer/content-subject-function rcnum cinfo ctype params subj
63
64 Variable to specify content-subject display function. Default value is
65 the function @code{mime-viewer/default-content-subject-function}.
66 @end defvar