Update.
[elisp/semi.git] / NEWS
1 SEMI NEWS --- history of major-changes.
2 Copyright (C) 1998,1999 Free Software Foundation, Inc.
3
4 * Changes in SEMI 1.13
5
6 ** Function `mime-play-entity'
7
8 Function `mime-play-entity' was renamed from `mime-raw-play-entity'
9 and changed interface.
10
11 Current interface is:
12
13     mime-play-entity (entity &optional situation ignored-method)
14
15 Please use `situation' if you would like to specify `mode' and
16 `ignore-examples'.
17
18
19 ** Now acting-method must not expect to run in raw-buffer
20
21 Function `mime-play-entity' was changed to permit to run in any buffer
22 (may be called in preview-buffer).  So each acting-method is called in
23 any buffer.
24
25
26 ** Text property `mime-view-entity-{header|body}'
27
28 Now mime-view put text property `mime-view-entity-header' and
29 `mime-view-entity-body' in header and body of each entity.
30
31
32 ** Behavior change about `mime-display-header-hook'
33
34 Function `mime-display-entity' runs `mime-display-header-hook' before
35 it inserts "\n".
36
37 In addition, now it is cleared that current point means beginning of
38 header when `mime-display-entity' runs `mime-display-header-hook'.
39 Therefore header-presentation-method must not change current point.
40
41 \f
42 * Changes in SEMI 1.12
43
44 There are no user-visible changes.
45
46 ** New function `eliminate-top-spaces'
47
48 Now mime-edit has it.
49
50 \f
51 * Changes in SEMI 1.11
52
53 ** New function `mime-edit-decode-message-in-buffer'
54
55 Add new function `mime-edit-decode-message-in-buffer'.  Function
56 `mime-edit-decode-buffer' was abolished.
57
58
59 ** Requires FLIM 1.12 API
60
61 \f
62 * Changes in SEMI 1.10
63
64 ** Abolish variable `mime-temp-directory'
65
66   FLIM 1.11 and SEMI 1.10 use variable `temporary-file-directory'
67 instead of `mime-temp-directory'.  So environment variable
68 "MIME_TMP_DIR" and "TM_TMP_DIR" are not effective to specify temporary
69 directory of FLIM and SEMI.
70
71
72 ** Abolish function `mime-text-insert-decoded-body'
73
74   SEMI 1.10 uses function `mime-insert-text-content' of FLIM 1.11 API
75 instead of `mime-text-insert-decoded-body'.
76
77   Now `mime-view-caesar' does not run `mime-text-decode-hook'.
78
79 \f
80 * Changes in SEMI 1.9
81
82 ** User option `mime-encoding-list'
83
84   SEMI 1.9 requires FLIM 1.10 API.  In FLIM 1.10 API, variable
85 `mime-file-encoding-method-alist' was abolished.  If you want to use
86 non-standard Content-Transfer-Encoding to insert a file into sending
87 message, please edit new user option `mime-encoding-list' instead of
88 `mime-file-encoding-method-alist'.
89
90
91 ** Constant `mime-user-interface-product'
92
93   Constant `mime-user-interface-version' was renamed to
94 `mime-user-interface-product'.  Notice that data format is changed
95 too.
96
97   FLIM 1.10 API provides following macros to access a slot of the new
98 data format:
99
100      mime-product-name (product)
101
102      mime-product-version (product)
103
104      mime-product-code-name (product)
105
106 Please use them to get elements of the constant
107 `mime-user-interface-product'.
108
109 \f
110 * Changes in SEMI 1.8
111
112 ** Don't use "file" command to detect content of entity
113
114   Acting-method to detect content of entity was modified not to use
115 "file" command.
116
117   Variable `mime-file-content-type-alist' was abolished.  Instead of
118 it, new variable `mime-magic-type-alist' is available to customize.
119 It is an alist of regexp about magic-number vs. corresponding
120 media-types.  Each element looks like (REGEXP TYPE SUBTYPE).  REGEXP
121 is a regular expression to match against the beginning of the content
122 of entity.  TYPE is symbol to indicate primary type of media-type.
123 SUBTYPE is symbol to indicate subtype of media-type.
124
125
126 ** Abolish external X-Face viewer
127
128
129 ** Abolish obsolete utility for *-field-list and *-field-regexp
130
131   Abolish function `tm:set-fields', `tm:add-fields' and
132 `tm:delete-fields'.
133
134
135 ** Change MUA interface of automatic message/partial combining
136
137   Abolish variable `mime-view-partial-message-method-alist'.
138
139   Instead of it, `request-partial-message-method' in acting-situation
140 is available to specify MUA depended implementation.
141
142   Each element of `mime-view-partial-message-method-alist' were
143 required to display message at current summary line, and its return
144 value were ignored.  On the other hand,
145 `request-partial-message-method' is required to return structure of
146 message at current summary line.  Format of it is mime-entity.
147
148
149 ** User-Agent field
150
151   MIME-Edit inserts User-Agent field instaed of X-Emacs field if
152 `mime-edit-insert-user-agent-field' is not nil.  Contents of
153 User-Agent is specified by mime-edit-user-agent-value'.
154
155   X-Emacs field related features were abolished.
156
157 \f
158 * Changes in SEMI 1.7
159
160 ** Header-presentation-method
161
162   Now MIME-View uses header-presentation-method instead of
163 header-filter.
164
165   - abolish variable `mime-view-content-header-filter-alist'
166
167   - abolish function `mime-view-cut-header'
168
169   - Rename `mime-view-content-header-filter-hook' to
170     `mime-display-header-hook'
171
172
173 ** Abolish `mime-view-ignored-field-regexp'
174
175   Now mime-view uses `mime-view-ignored-field-list' directly in
176 default header-presentation-method.
177
178
179 ** Abolish body filter support
180
181   Please use body-presentation-method.
182
183
184 ** Methods for MUAs
185
186   - Rename `mime-view-following-method-alist' to
187     `mime-preview-following-method-alist'
188
189   - Rename `mime-method-to-combine-message/partial-pieces' to
190     `mime-combine-message/partial-pieces-automatically'
191
192 \f
193 * Changes in SEMI 1.6
194
195 ** Abolish tm-compatible external method support
196
197   Abolish tm-compatible external method support.  Please use mailcap
198 method instead of it.
199
200
201 ** Abolish `mime-edit-signing-type' and `mime-edit-encrypting-type'
202
203   C-c C-m C-s encloses as "pgp-signed" which means PGP/MIME signature.
204
205   C-c C-m C-e encloses as "pgp-encrypted" which means PGP/MIME
206 encryption.
207
208
209 ** New method to detect content of entity
210
211   Now MIME-View can detect content of entity for
212 application/octet-stream in default setting.
213
214   It uses "file" command to detect.  User can customize
215 `mime-file-content-type-alist' to specify media-type for output of
216 "file" command.  It is an alist of "file" output patterns
217 vs. corresponding media-types.  Each element looks like (REGEXP TYPE
218 SUBTYPE).  REGEXP is pattern for "file" command output.  TYPE is
219 symbol to indicate primary type of media-type.  SUBTYPE is symbol to
220 indicate subtype of media-type.
221
222
223 ** New interface to display message
224
225 - Function `mime-view-buffer'
226 - Function `mime-view-display-message'
227
228
229 ** Change interface of internal playback method
230
231   Interface of internal playback method was changed to
232
233         (entity situation)
234
235 It is as same as interface of body-presentation-method.
236
237
238 ** Change interface of `mime-view-entity-button-visible-p'
239
240 ** Change interface of `mime-view-insert-entity-button'
241
242
243 ** `mime-preview-original-major-mode'
244
245   Abolish variable `mime-preview-original-major-mode'.
246
247   Please use function `mime-preview-original-major-mode' instead of
248 it.
249
250
251 ** mime-preview-over-to-{previous|next}-method-alist
252
253   `mime-preview-over-to-{previous|next}-method-alist' were renamed
254 from `mime-view-over-to-{previous|next}-method-alist'.
255
256 \f
257 * Changes in SEMI 1.5
258
259 ** mime-w3
260
261   Add inline text/html preview feature using w3.  If
262 `mime-setup-enable-inline-html' is not nil, semi-setup.el sets up it.
263
264
265 ** `pgp-elkins' -> `pgp-mime'
266
267   Rename `pgp-elkins' -> `pgp-mime'.  Variable
268 `mime-edit-signing-type' and `mime-edit-encrypting-type' does not
269 allow `pgp-elkins'.
270
271
272 ** type-subtype-score
273
274   Now MIME-View chooses one entity to display body in
275 multipart/alternative.  In this mechanism,
276 `mime-view-type-subtype-score-alist' is used to specify priority of
277 each entity.
278
279   Variable `mime-view-type-subtype-score-alist' is alist of
280 TYPE-SUBTYPE vs. SCORE.  TYPE-SUBTYPE is cons pair (TYPE . SUBTYPE),
281 symbol TYPE or t.  TYPE and SUBTYPE are symbol.  `t' means default.
282 SCORE is integer.  Larger number is larger priority.
283
284
285 ** text presentation
286
287   Change text presentation mechanism.  In anything older than SEMI
288 1.4, text presentation mechanism is based on filter model.  However it
289 has design problem about conversion between byte representation and
290 text presentation.  So SEMI was changed to use
291 body-presentation-method to display text entity.  In this purpose, old
292 text decoding features were abolished and introduces news features
293 (cf. next section).
294
295
296 ** mime-raw-representation-type and mime-raw-representation-type-alist
297
298   Abolish `mime-text-decoder' and `mime-text-decoder-alist' because of
299 text presentation mechanism change (cf. previous section).  Instead of
300 it, SEMI introduces variable about representation-type of
301 mime-raw-buffer.  If it is `binary', mime-raw-buffer is as same as
302 network representation.  If it is `cooked', mime-raw-buffer is
303 code-converted.
304
305   `mime-raw-representation-type-alist' is an alist of major-mode
306 vs. representation-type.  Each element looks like
307
308     (SYMBOL . REPRESENTATION-TYPE).
309
310 SYMBOL is major-mode or t.  t means default.
311
312   `mime-raw-representation-type' is a buffer local variable of
313 mime-raw-buffer.  If it is non-nil, it overrides
314 `mime-raw-representation-type-alist'.
315
316   In addition, `mime-raw-buffer-coding-system-alist' was abolished.
317 Because representation-type has enough information.
318
319 \f
320 * Changes in SEMI 1.4
321
322 ** mailcap
323
324   mailcap was supported to set up 'mime-acting-condition.
325
326   tm-external-method scripts written by born shell were abolished.
327
328
329 ** mime-add-condition
330
331   New function to set up 'mime-preview-condition and/or
332 'mime-acting-condition.
333
334
335 ** signature setting in semi-setup.el
336
337   Abolish MUA depended signature setting.
338
339   Setting for mail-mode were moved to mail-mime-setup.el.
340
341 \f
342 * Changes in SEMI 1.3
343
344 ** mime-acting-condition
345
346   Format of variable 'mime-acting-condition was changed from `atype'
347 to `condition tree'.  Its format is as same as
348 'mime-preview-condition.
349
350   If there are two or more conditions are found when matching, menu
351 pops up to select method to run.  Selected situation will be added to
352 example database. (cf. mime-acting-situation-examples-file)
353
354 ** New variables
355
356 *** mime-view-find-every-acting-situation
357
358         Find every available acting-situation if non-nil.
359
360 *** mime-acting-situation-examples-file
361
362         File name of example about acting-situation demonstrated by
363         user.
364
365 \f
366 * Changes in SEMI 1.2
367
368 ** User setting
369
370 *** hooks
371
372   'mime-view-plain-text-preview-hook was renamed to
373 'mime-preview-text/plain-hook.
374
375 *** Variable
376
377   Variable 'mime-view-childrens-header-showing-Content-Type-list was
378 abolished.  Please use 'mime-preview-condition instead.
379
380 *** API about visible-predicates were abolished
381
382   Following functions were abolished:
383
384     mime-view-header-visible-p (entity message-info)
385
386     mime-view-body-visible-p (entity message-info)
387
388     mime-view-entity-separator-visible-p (entity message-info)
389
390 Please use 'mime-preview-condition instead.
391
392   Function 'mime-view-entity-button-visible-p is not abolished, but it
393 is obsoleted.
394
395 *** mime-preview-condition
396
397   Following are added as pre-defined keys:
398
399         'childrens-situation    default preview-situation for children
400         'message-button         to specify to display message-button
401                                     nil:        default (invisible)
402                                     'visible:   visible
403                                     'invisible: invisible
404         'entity-button          to specify to display entity-button
405                                     nil:        default (visible)
406                                     'visible:   visible
407                                     'invisible: invisible
408         'header                 to specify to display header
409                                     nil:        default (invisible)
410                                     'visible:   visible
411                                     'invisible: invisible
412
413 ** API
414
415 *** Interface for body-filter
416
417   'mime-view-filter-for-* was renamed to 'mime-preview-filter-for-*.
418
419
420 *** mime-text-decode-body
421
422   Function 'mime-decode-text-body was renamed to
423 'mime-text-decode-body and changed interface.  New interface is
424 following:
425
426         mime-text-decode-body (SITUATION)
427
428 SITUATION is preview-situation.  Content-Transfer-Encoding and
429 MIME-charset are specified in field of it.
430
431 \f
432 * Changes in SEMI 1.1
433
434 ** User setting
435
436 *** Setting variable about visible body
437
438   'mime-view-visible-media-type-list and
439 'mime-view-content-filter-alist were abolished.  Please use
440 'mime-preview-condition instead.
441
442   Notice that 'mime-preview-condition is not list of
443 media-type/subtype string nor association-list.  It uses new
444 data-structure `ctree' (condition-tree; it is introduced to replace
445 `atype').  Function 'ctree-set-calist-strictly and
446 'ctree-set-calist-with-default may be useful to modify it (`calist'
447 (condition-alist) is as same as `atype').
448
449
450 *** API about visible-predicates
451
452   Interface of visible-predicates for entity elements were changed.
453 New interfaces are following:
454
455     mime-view-entity-button-visible-p (entity message-info)
456
457     mime-view-header-visible-p (entity message-info)
458
459     mime-view-body-visible-p (entity message-info)
460
461     mime-view-entity-separator-visible-p (entity message-info)
462
463
464 ** API
465
466 *** entity representation
467
468   Structure 'mime-entity-info was renamed to 'mime-entity.  So various
469 functions were renamed too.
470
471
472 *** Interface for entity-button generators
473
474   Interface of entity-button generators was changed.  New interfaces
475 is following:
476
477     mime-view-insert-entity-button (entity message-info subject)
478
479
480 *** mime-preview-condition and preview-situation
481
482   Conditions about preview generation are unified to
483 'mime-preview-condition.  Namely other variables, such as
484 'mime-view-visible-media-type-list, 'mime-view-content-filter-alist,
485 'mime-view-image-converter-alist were abolished.
486
487   Preview-situation is generated from entity information, running
488 environment and 'mime-preview-condition.  These elements are checked
489 to match with each other. (it is similar to acting-situation)
490
491   Format of preview-situation is association-list.  Following key is
492 pre-defined:
493
494         'type                     media-type
495         'subtype                  media-subtype
496         'encoding                 content-transfer-encoding
497         'major-mode               major-mode of MUA
498         <STRING>                  attribute of Content-Type field.
499         'body-presentation-method body-presentation-method
500
501 If 'body-presentation-method is 'with-filter, 'body-filter is used to
502 specify body-filter function.  If 'body-presentation-method is
503 function, it is called to generate presentation of entity body.
504
505 Body-filter function 'mime-view-filter-for-image refers 'image-format.
506
507 Setting for message/partial button is specified by
508 'mime-preview-condition instead of hard-coding.
509
510
511 *** Interface for body-filter
512
513   Interface of body-filter was changed.  New interfaces is following:
514
515     <body-filter> (situation)
516
517 Current pre-defined filters are following:
518
519         mime-view-filter-for-text/plain (situation)
520         mime-view-filter-for-text/richtext (situation)
521         mime-view-filter-for-text/enriched (situation)
522         mime-view-filter-for-image (situation) ; if available
523
524 'mime-view-filter-for-application/postscript was abolished.
525
526
527 *** Format of mime-acting-condition (acting-situation)
528
529   Format of `mime-acting-condition' were changed.  `type' and
530 `subtype' are separated and changed to symbol.
531
532
533 *** Renaming
534
535 - mime-view-buffer -> mime-preview-buffer
536
537 \f
538 Local variables:
539 mode: outline
540 paragraph-separate: "[  \f]*$"
541 end: