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