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