vars.el.in 164 KB
Newer Older
David Byers's avatar
David Byers committed
1
;;;;; -*-coding: raw-text;mode: emacs-lisp;-*-
Linus Tolke's avatar
Linus Tolke committed
2
;;;;; $Id$
3
;;;;; Copyright (C) 1991-2002  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
4
;;;;;
5
;;;;; This file is part of the LysKOM Emacs LISP client.
Linus Tolke's avatar
Linus Tolke committed
6
7
8
;;;;; 
;;;;; LysKOM is free software; you can redistribute it and/or modify it
;;;;; under the terms of the GNU General Public License as published by 
9
;;;;; the Free Software Foundation; either version 2, or (at your option) 
Linus Tolke's avatar
Linus Tolke committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
;;;;; any later version.
;;;;; 
;;;;; LysKOM is distributed in the hope that it will be useful, but WITHOUT
;;;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;;;;; FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
;;;;; for more details.
;;;;; 
;;;;; You should have received a copy of the GNU General Public License
;;;;; along with LysKOM; see the file COPYING.  If not, write to
;;;;; Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
;;;;; or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
;;;;; MA 02139, USA.
;;;;;
;;;;; Please mail bug reports to bug-lyskom@lysator.liu.se. 
;;;;;
Per Cederqvist's avatar
.    
Per Cederqvist committed
25
26
27
28
29
30
31
32
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: vars.el
;;;;
;;;; This file contains almost all the variables used in lyskom.
;;;;

33
34
;;;; Note: put "**" at the front of docstrings that are ready
;;;; for use in DocBook autogeneration.
35
36
37
;;;;
;;;; Rules for documentation that can be translated to DocBook
;;;; is in interndoc/vardoc
38

Per Cederqvist's avatar
.    
Per Cederqvist committed
39

David Byers's avatar
X    
David Byers committed
40
41
42
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))
43

44
45
(defvar lyskom-dummy-variable-to-fool-the-byte-compiler)

David Byers's avatar
David Byers committed
46
(defvar lyskom-mule-compiled
47
48
  (eval-when-compile (and (fboundp 'multibyte-string-p)
                          (multibyte-string-p "ÅÄÖ")))
David Byers's avatar
David Byers committed
49
50
  "Non-nil if the client was compiled with multibyte characters enabled")

David Byers's avatar
X    
David Byers committed
51
(provide 'lyskom)
52

David Byers's avatar
X    
David Byers committed
53
(require 'lyskom-defvar "defvar")
Per Cederqvist's avatar
.    
Per Cederqvist committed
54

55
56
57
(defconst lyskom-global-variable-types
  '((boolean (read . lyskom-flag-read-boolean)
             (write . lyskom-flag-write-boolean))
58
59
    (integer (read . lyskom-flag-read-integer)
             (write . lyskom-flag-write-integer))
60
61
62
63
    (symbol-list (read . lyskom-flag-read-symbol-list)
                 (write . lyskom-flag-write-symbol-list))
    (t (read . lyskom-flag-read-from-string)
       (write . prin1-to-string))))
David Byers's avatar
David Byers committed
64

David Byers's avatar
X    
David Byers committed
65
66

(defun lyskom-protect-variable (sym) 
David Byers's avatar
David Byers committed
67
  "Protect SYM from being killed when deleting local variables."
David Byers's avatar
X    
David Byers committed
68
69
70
71
72
  (put sym 'permanent-local t)
  (lyskom-local-variable sym)
  (add-to-list 'lyskom-protected-variables sym))

(defun lyskom-local-variable (sym)
David Byers's avatar
David Byers committed
73
  "Define SYM as a buffer-local variable"
David Byers's avatar
X    
David Byers committed
74
75
76
  (add-to-list 'lyskom-local-variables sym))

(defun lyskom-inherited-variable (sym)
David Byers's avatar
David Byers committed
77
78
  "Define SYM as a variable that is inherited when creating new buffers.
Inheritance only works with the LysKOM buffer handling functions."
David Byers's avatar
X    
David Byers committed
79
80
81
82
  (add-to-list 'lyskom-inherited-variable sym)
  (lyskom-protect-variable sym))

(defun lyskom-setup-local-variables ()
David Byers's avatar
David Byers committed
83
  "Set up all globally defined local variables in the current buffer."
David Byers's avatar
X    
David Byers committed
84
  (mapcar 'make-local-variable lyskom-local-variables)
85
  (mapcar 'lyskom-make-local-hook lyskom-local-hooks))
Per Cederqvist's avatar
.    
Per Cederqvist committed
86

David Byers's avatar
David Byers committed
87
88
89
(defvar lyskom-is-loaded nil
  "Non-nil when lyskom has been loaded.")

90
91
92
(defvar lyskom-have-one-login nil
  "Non-nil after the first login")

David Byers's avatar
David Byers committed
93

David Byers's avatar
David Byers committed
94
95
(def-kom-var kom-dont-read-saved-variables '(kom-dont-read-saved-variables
                                             lyskom-login-hook)
David Byers's avatar
David Byers committed
96
  "**Determines which LysKOM variables to not store in the server.
97
98
99
100
101
102
103
104
105
106

For the most part you do not have to modify this variable. Any variables
set before LysKOM is loaded will not be read from the server.
This variable should `nil', `t' or a list of symbols. 

The value `nil' means read all variables from the server. The value
`t' means read no variables from the server. When the value is a list
of symbols, those variables will not be read from the server.

Any other values are reserved for future use.")
David Byers's avatar
David Byers committed
107

108
109
110
111
(defmacro lyskom-maybe-setq (var value)
  "This is a wrapper around setq that does nothing
if the variable is in kom-dont-read-saved-variables."
  `(cond ((eq kom-dont-read-saved-variables t) nil)
112
         ((memq ,var kom-dont-read-saved-variables) nil)
David Byers's avatar
David Byers committed
113
         (t (set ,var ,value))))
114
115
116
117
118

(defmacro lyskom-maybe-setq-default (var value)
  "This is a wrapper around setq-default that does nothing
if the variable is in kom-dont-read-saved-variables."
  `(cond ((eq kom-dont-read-saved-variables t) nil)
119
         ((memq ,var kom-dont-read-saved-variables) nil)
120
         (t (set-default ',var ,value))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
121
122
123
124
125
126
127

;;;; ================================================================
;;;;                     Variables and constants.


;;; User flags

128
129
130
131
132
133
134
135
136
137
138
(def-kom-var kom-auto-confirm-new-conferences nil
  "**Determines behavior of `kom-list-new-conferences' and `kom-list-new-persons'.

When this variable is set to `t', `kom-list-new-conferences' and
`kom-list-new-persons' will automatically mark all listed conferences
and persons as known. When set to `nil', these commands will ask for
confirmation before marking the listed conferences and persons as known.

Values other than `t' and `nil' are reserved for future use."
  server)

David Byers's avatar
David Byers committed
139
(def-kom-var kom-dont-complain-about-missing-presentation nil
140
  "**Controls whether the client complains when you don't have
David Byers's avatar
David Byers committed
141
142
143
144
145
146
147
a presentation. When set to non-nil, the client will never
complain.

This variable should not be documented. Anybody asocial enough
to want this feature ought to have to work to find it."
  server)

148
149
150
151
152
153
154
155
156
157
158
159
(def-kom-var kom-show-sync-messages nil
  "**Controls display of database saving message.

When this variable is set to `t', the client will show a message in
the echo area when the LysKOM server signals that it is saving the
database. When set to `nil', no message is shown (the mode line is
changed regardless of the setting of this variable).

Values other than `t' and `nil' are reserved for future use."
  server)


160
161
162
163
(def-kom-var kom-text-links
  '((t ("\\<bug[ \t\n]+\\([0-9]+\\)\\>"
	"http://bugzilla.lysator.liu.se/show_bug.cgi?id=\\1"
	0 t)))
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
  "**Defines patterns for automatic links in the text.

This variable defines patterns to look for in text and convert to
links to URLs. The value of this variable must be an alist, where the
key (car) is a conference number and the value (cdr) is a list of link
specifications for that conference. The special value `t' for the key
indicates a list of patterns to apply in all conferences. Key values
other than positive integers and `t' are reserved for future use.

Each link specification is in turn a list \(`PATTERN' `REPLACEMENT'
`HIGHLIGHT' `IGNORE-CASE'), where `PATTERN' is a regular expression to
look for in the text, `REPLACEMENT' is used to generate a URL from the
text matching `PATTERN', `HIGHLIGHT' is the pattern group to highlight
as a URL and `IGNORE-CASE' specifies whether matching is
case-sensitive or not.

Each text is examined for each `PATTERN'. If a match is found, a URL
181
182
is created from `REPLACEMENT'. All characters except backslash are
copied verbatim. The backslash character starts one of the following
183
184
185
sequences:

    Sequence    Meaning
186
187
188
189
    -----------------------------------------------------------------
    `\\&'          Substitute the matched text

    `\\N'          Substitute match for text matching the Nth (...)
190
                group in `PATTERN'
191
192
193

    `\\\\'          Insert one backslash.
    -----------------------------------------------------------------
194
195

The `HIGHLIGHT' parameter specifies which (...) group in `PATTERN'
196
to highlight as an URL. Use 0 to highlight the entire match.
197
198
199
200
201
202
203
204

Finally, if `IGNORE-CASE' is `t', then ignore character case while
looking for `PATTERN'. Values other than `t' and `nil' are reserved
for future use.

When a text has more than one recipient, links will be generated for
all recipients. The order in which the recipients are examined and
the priority among links that match the same text is undefined."
205
206
  server)

207

208
(def-kom-var lyskom-default-conference-strategy
209
210
211
212
  '((kom-start-anew (what-is-your-name
                     (default . (lyskom-default-conference-empty))))

    (kom-delete-conf (what-conf-to-delete
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
                      (default . (lyskom-default-conference-empty))))

    (kom-sub-self (leave-what-conf
                   (filter . (lyskom-default-conference-not-self))))

    (kom-change-priority (what-to-change-pres-you
                          (default . (lyskom-default-conference-at-point
                                      lyskom-default-conference-self))))

    (kom-change-presentation (what-to-change-pres-you
                              (default . (lyskom-default-conference-at-point
                                          lyskom-default-conference-self))))

    (kom-change-conf-motd (who-to-put-motd-for
                           (default . (lyskom-default-conference-at-point
                                       lyskom-default-conference-self))))

230
    (kom-set-presentation (what-to-set-pres-you
231
232
233
                           (default . (lyskom-default-conference-at-point
                                       lyskom-default-conference-self))))

234
    (kom-set-motd-text (what-to-set-motd-you
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
                        (default . (lyskom-default-conference-at-point
                                    lyskom-default-conference-self))))

    (kom-remove-presentation (who-to-remove-pres-for
                              (default . (lyskom-default-conference-at-point
                                          lyskom-default-conference-self))))

    (kom-unset-conf-motd (who-to-remove-motd-for
                          (default . (lyskom-default-conference-at-point
                                      lyskom-default-conference-self))))

    (kom-go-to-conf (go-to-conf-p
                     (default . (lyskom-default-conference-at-point
                                 lyskom-default-conference-self))
                     (filter . (lyskom-default-conference-not-current))))

    (kom-list-created-conferences (list-confs-created-by
                                   (default . (lyskom-default-conference-at-point
                                               lyskom-default-conference-self))))

    (kom-change-name (name-to-be-changed
                      (default . (lyskom-default-conference-at-point
                                  lyskom-default-conference-self))))

    (kom-change-parenthesis (name-to-be-changed
                             (default . (lyskom-default-conference-at-point
                                         lyskom-default-conference-self))))

    (kom-change-password (whos-passwd
                          (default . (lyskom-default-conference-at-point
                                      lyskom-default-conference-self))))

    (kom-redirect-comments (redirect-for-whom
                            (default . (lyskom-default-conference-at-point
                                        lyskom-default-conference-self)))
                           (redirect-to-which-conf))

    (kom-filter-author (filter-author
                        (default . (lyskom-default-conference-at-point
                                    lyskom-default-conference-last-author))
                        (filter . (lyskom-default-conference-not-self)))
                       (filter-in-conf
                        (filter . (lyskom-default-conference-not-self))))


280
    (kom-review-by-to (review-by-whom
281
282
                       (default . (lyskom-default-conference-at-point
                                   lyskom-default-conference-empty)))
283
                      (review-to-conf))
284

285
    (kom-review-first (review-by-whom
286
287
                       (default . (lyskom-default-conference-at-point
                                   lyskom-default-conference-empty)))
288
                      (review-to-conf))
289

290
    (kom-review-all (review-by-whom
291
292
                     (default . (lyskom-default-conference-at-point
                                 lyskom-default-conference-empty)))
293
                    (review-to-conf))
294

295
    (kom-unread-by-to (unread-by-whom
296
297
                       (default . (lyskom-default-conference-at-point
                                   lyskom-default-conference-empty)))
298
                      (unread-to-conf))
299

300
    (kom-unread-first (unread-by-whom
301
302
                      (default . (lyskom-default-conference-at-point
                                  lyskom-default-conference-empty)))
303
                      (unread-to-conf))
304

305
    (kom-unread-all (unread-by-whom 
306
307
                     (default . (lyskom-default-conference-at-point
                                 lyskom-default-conference-empty)))
308
                    (unread-to-conf))
309

310
311
312
313
    (kom-set-permitted-submitters (conf-to-set-permitted-submitters-q)
                                  (new-permitted-submitters-q
                                   (default . (lyskom-default-conference-empty))))

314
315
316
317
    (lyskom (what-is-your-name 
             (default . (lyskom-default-conference-empty))))


318
319
320
    (kom-add-recipient (who-to-add-q 
                        (default . ((lyskom-default-conference-saved last-added-rcpt)))
                        (save last-added-rcpt)))
321

322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
    (kom-add-copy (who-to-add-copy-q 
                   (default . ((lyskom-default-conference-saved last-added-cc)))
                   (save last-added-cc)))

    (kom-add-bcc (who-to-add-bcc-q 
                  (default . ((lyskom-default-conference-saved last-added-bcc)))
                  (save last-added-bcc)))

    (kom-sub-recipient (who-to-sub-q
                        (default . (lyskom-default-conference-at-point
                                    (lyskom-default-conference-saved last-sub-recipient)
                                    lyskom-default-conference-current
                                    lyskom-default-conference-restriction))
                        (save last-sub-recipient)))

    (kom-move-text (who-to-move-from-q
                    (default . (lyskom-default-conference-at-point
                                (lyskom-default-conference-saved last-sub-recipient)
                                lyskom-default-conference-current
                                lyskom-default-conference-restriction))
                    (save last-sub-recipient))
                   (who-to-move-to-q
                    (default . ((lyskom-default-conference-saved last-added-rcpt)
                                lyskom-default-conference-current))
                    (save last-added-rcpt)))

    (kom-move-text-tree (who-to-move-from-q
                         (default . (lyskom-default-conference-at-point
                                     (lyskom-default-conference-saved last-sub-recipient)
                                     lyskom-default-conference-current
                                     lyskom-default-conference-restriction))
                         (save last-sub-recipient))
                        (who-to-move-to-or-sub-q
                         (default . ((lyskom-default-conference-saved last-added-rcpt)
                                     lyskom-default-conference-current))
357
                         (save last-added-rcpt))
358
                        (who-to-move-to-q
David Byers's avatar
David Byers committed
359
360
361
362
                         (default . ((lyskom-default-conference-saved last-added-rcpt)
                                     lyskom-default-conference-current))
                         (save last-added-rcpt))
                        (who-to-add-q
363
364
365
366
367
368
                         (default . ((lyskom-default-conference-saved last-added-rcpt)
                                     lyskom-default-conference-current))
                         (save last-added-rcpt)))

    (kom-send-message (who-to-send-message-to
                       (default . (lyskom-default-conference-for-send-message))))
369

David Byers's avatar
David Byers committed
370
371
372
    (kom-send-alarm (who-to-send-message-to
                     (default . (lyskom-default-conference-for-send-message))))

373
374
375
376
    (kom-is-person-member-of-conference (pers-to-check-mship-for)
                                        (conf-to-check-mship-of))


377
378
379

    ;; Defaults and commands that use the defaults

380
381
382
383
384
    (kom-remote-autoreply (remote-control-who))
    (kom-remote-set-message (remote-control-who))
    (kom-remote-list-messages (remote-control-who))
    (kom-remote-erase-messages (remote-control-who))
    (kom-remote-quit (remote-control-who))
385
386
387
388
389
390
391
392
    (kom-review-presentation (presentation-for-whom))
    (kom-unread-presentation (unread-presentation-for-whom))
    (kom-add-member (who-to-add) (where-to-add))
    (kom-add-self (where-to-add-self))
    (kom-change-priority (change-priority-for-q))
    (kom-sub-member (who-to-exclude) (where-from-exclude))
    (kom-write-text (who-send-text-to))
    (kom-send-letter (who-letter-to))
393
    (kom-force-logoout (who-to-throw-out))
394
395
396
397
398
399
400
    (kom-change-supervisor (what-to-change-supervisor-for) (new-supervisor))
    (kom-who-is-on-in-conference (who-is-on-in-what-conference))
    (kom-who-is-present-in-conference (who-is-present-in-what-conference))
    (kom-add-cross-reference (which-conf-to-xref) (which-pers-to-xref))
    (kom-edit-add-cross-reference (which-conf-to-xref) (which-pers-to-xref))
    (kom-edit-insert-link (which-conf-to-link) (which-pers-to-link))
    (kom-status-conf (conf-for-status))
401
    (kom-status-session (session-for-status))
David Byers's avatar
David Byers committed
402
    (kom-force-logout (who-to-throw-out))
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
    (kom-status-person (pers-for-status))
    (kom-set-garb-nice (conf-to-set-garb-nice-q))
    (kom-set-super-conf (conf-to-set-super-conf-q) (new-super-conf-q))
    (kom-set-personal-label (label-what-pers) (label-what-conf))
    (kom-will-person-read-text (pers-to-check-will-read-for))
    (kom-create-aux-item (which-conf-to-add-aux-to))
    (kom-recommend-conference (recommend-which-conf))
    (kom-limit-import (limit-import-to-conf))
    (kom-edit-add-recipient (added-recipient))
    (kom-edit-add-bcc (added-blank-carbon-copy))
    (kom-edit-add-copy (added-carbon-copy))
    (kom-edit-move-text (who-to-move-to-q))
    (kom-add-faq (conf-to-add-faq))
    (kom-del-faq (conf-to-del-faq))
    (kom-review-faq (view-which-faq))
    (kom-unread-faq (unread-which-faq))
    (kom-change-conf-faq (what-to-change-faq-you))
    (kom-list-faqs (conf-to-list-faqs))
    (kom-filter-subject (filter-in-conf))
    (kom-filter-recipient (filter-recipient))
    (kom-filter-text (filter-in-conf))
424
425
    (kom-change-conf-type (what-conf-to-change))
    (kom-change-privileges (what-pers-privs-to-change))
426
    (kom-change-message-flag (set-message-flag-for-conf))
427
428
429
430
431

    (t (t (default . (lyskom-default-conference-at-point
                      lyskom-default-conference-current))))
    )

432
433
  "Strategy for the initial value for conference defaults.

David Byers's avatar
David Byers committed
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
Each element in this list identifies an Emacs och LysKOM command, and
defines the initial values for queries it makes for conference names.

Each element has the following format:

    \(COMMAND . \(\(PROMPT-1 . \(\(default . \(INITIAL-VALUES\\)\\)
                             \(filter  . \(EXCLUDED-CONFS\)\)
                             \(save    . \(SAVE-GROUPS\)\)\)\)
                \(PROMPT-2 . \(\(default . \(INITIAL-VALUES\)\)
                             \(filter  . \(EXCLUDED-CONFS\)\)
                             \(save    . \(SAVE-GROUPS\)\)\)\)
                ...\)\)

COMMAND is the name of a LysKOM or Emacs command. PROMPT-1 and
PROMPT-2 \(there can be any number of prompts liste in a single
command\) are symbols representing the prompt. These are defined
in lyskom-messages in swedish-strings.el and english-strings.el. 

INITIAL-VALUES are functions to call to generate a list of possible
initial values for the prompt. These functions must return lists of
conference numbers. EXCLUDED-CONFS are functions that are called to
eliminate possible initial values. These must take a single argument,
an uconf-stat, and should return the uconf-stat itself if it is a
valid candidate for the initial value, or nil if it is not. Finally,
SAVE-GROUPS are symbols under which the value the user inputs will be
saved.

As a special case, a list in INITIAL-VALUES is interpreted as a
function with arguments. The first element in the list is applied to
the remaining elements.

If `t' is used for COMMAND, it indicates the default to use when no
COMMAND listed matches the current command. If `t' is used for PROMPT,
it indicates defaults, filters and save groups to use when no other
PROMPT matches.


Some useful functions for INITIAL-VALUES are:

lyskom-default-conference-at-point returns the conference shown where
point is. If point is on a conference name, that name will be used as
the initial value.

lyskom-default-conference-current returns the current conference.

lyskom-default-conference-self returns the logged-in person.

lyskom-default-conference-last-author returns the author of the most
recently read text.

lyskom-default-conference-saved returns saved input. This must be
specified as a list in INITAL-VALUES, where the argument (second
element of the list) is the symbol under which the input was saved,
from \(SAVE-GROUPS\) in one or more commands.


Some useful functions for EXCLUDE-CONFS are:

lyskom-default-conference-not-self excludes the logged-in person.

lyskom-default-conference-not-current excludes the current conference.


The format of this variable may change in the future.
")
499
500


501
(defconst kom-old-farts-text-prompt-strategy
502
  '((kom-comment-previous (nil lyskom-get-previous-text))
503
504
505
506
507
508
509
510
511
    (kom-view-previous-commented-text (nil lyskom-get-previous-text))
    (kom-private-answer-previous (nil lyskom-get-previous-text))
    (t  (t   lyskom-get-last-read-text)
        (nil     lyskom-get-last-read-text)
        (0       lyskom-get-text-at-point)
        (lyskom-eq-dash   (lambda () (lyskom-get-text-above-point 1)))
        (listp   (lambda () (lyskom-tnpa-prompt (lyskom-get-last-read-text))))
        (plusp   current-prefix-arg)
        (minusp  (lambda () (lyskom-get-text-above-point (- current-prefix-arg))))))
David Byers's avatar
David Byers committed
512
513
514
515
516
517
518
519
"Put in your `kom-pick-text-no-strategy-alist' to get the 0.46 behaviour:
 * No prefix argument refers to the most recently read text.
 * The prefix argument zero refers to the text under point.
 * A positive prefix argument is interpreted as a text-no.
 * A negative prefix argument will try to find the text-no
   of the text `arg' messages above point from the current
   kom buffer.")

520
521
522
523
(defconst lyskom-old-farts-text-prompt-strategy
  kom-old-farts-text-prompt-strategy
  "Obsolete: Alias for kom-old-farts-text-prompt-strategy.")

David Byers's avatar
David Byers committed
524
(def-kom-var kom-pick-text-no-strategy-alist
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
  '(

    ;; Abstract specifications

    (read-or-written
     (t   (lambda () (lyskom-tnpa-prompt (lyskom-get-text-at-point))))
     (nil lyskom-get-text-at-point
          (lambda () (lyskom-tnpa-valid
                      (lyskom-tnpa-prompt (lyskom-get-last-written-or-read-by-me))))
          :constraint lyskom-text-written-by-me-p))
    (previous-text (nil lyskom-get-previous-text))
    (commented-text (nil lyskom-maybe-get-commented-text))
    (footnoted-text (nil lyskom-maybe-get-footnoted-text))

    ;; Specifications for actual commands

    (kom-comment-previous             :refer previous-text)
    (kom-view-previous-commented-text :refer previous-text)
    (kom-unread-previous-commented-text :refer previous-text)
    (kom-private-answer-previous      :refer previous-text)
    (kom-sub-comment                  :refer commented-text)
    (kom-sub-footnote                 :refer footnoted-text)
    (kom-write-footnote               :refer read-or-written)
    (kom-add-no-comments              :refer read-or-written)
    (kom-add-private-answer           :refer read-or-written)
    (kom-add-request-confirm          :refer read-or-written)

    ;; Default specification

    (t (nil     lyskom-get-text-at-point)
       (0       (lambda () (lyskom-tnpa-prompt (lyskom-get-text-at-point))))
       (lyskom-eq-dash (lambda () (lyskom-get-text-above-point 1)))
       (car     (lambda () (lyskom-get-text-at-point-ancestor (/ (logb (car current-prefix-arg)) 2))))
       (plusp   (lambda () (lyskom-get-text-below-point current-prefix-arg)))
       (minusp  (lambda () (lyskom-get-text-above-point (- current-prefix-arg))))
       (t       (lambda () (lyskom-tnpa-prompt (lyskom-get-text-at-point))))
       :constraint nil
       :filter  nil
       )
    )
David Byers's avatar
David Byers committed
565
566
  "**Defines how prefix arguments are used by commands to find a text to operate on.

567
568
The format of this list is as follows:

569
<
570
571
572
573
574
575
\((FN-KEY . ((PFX-KEY-1 . (FN1 FN2 ... PROP1 VAL1 PROP2 VAL2 ...)) 
            (PFX-KEY-2 . (FN1 FN2 ... PROP1 VAL1 PROP2 VAL2 ...))
            GPROP1 GVAL1
            GPROP2 GVAL2
            ...))
 ...)
576
>
577

578
`FN-KEY' is the name of a command, `t' or a symbol that does not
579
580
581
582
583
584
correspond to any function. Keys corresponding to commands indicate
configuration for that command. The `t' key indicates fallback
condiguration that applies to all commands, unless overridden by a
command-specific configuration. Other keys can be referenced from
command-specific configurations.

585
`PFX-KEY' is a key that indicates a prefix. If it is an atom not bound
586
to a function, it indicates configuration for prefix arguments eq to
587
the atom \(e.g. 0, - or `nil'). The special key `t' indicates fallback
588
589
590
configuration, used when all prefix-specific configurationas failed to
generate valid values.

591
`FN' is a function or variable used to generate lists of text numbers.
592
593
594
595
If a variable name, the value of the variable is used to generate a
list of text numbers. If a function, the function is called with no
arguments, and is expected to return a list of text numbers.

596
`PROP' is a property name \(see below) and VAL is the corresponding
597
598
599
value. Properties defined at the inner level apply only to results
generated for that prefix. Properties defined at the outer level apply
irrespective of prefix arguments. Properties defined in the default
600
element \(with `FN-KEY' set to `t'\) always apply, unless overridden by
601
602
603
604
non-nil properties in command-specific elements.

The following properties are available:

605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
    Key             Value
    ------------------------------------------------------------------
    `:filter'       A function that is called on all text numbers. The
                    filter function is expected to return a new or 
                    modified text number. This can be used to indicate 
                    that the command should prompt or bypass the 
                    constraint.
    
    `:constraint'  A function that is called on all text numbers. It 
                   should return non-nil for text numbers that are 
                   valid for the command.
    
    `:refer'       A symbol indicating a configuration to use. Useful 
                   when several commands share the same (complex)
                   configuration. May not be used in the default 
                   element.
    ------------------------------------------------------------------
622
623
624
625


The following filter functions may be useful:

626
627
628
629
630
631
632
633
634
    Name                    What it does
    ------------------------------------------------------------------
    `lyskom-tnpa-prompt'    Prompt the user for the text number. The 
                            number used as the argument will be the 
                            default. 
    
    `lyskom-tnpa-valid'     Declare that the text number is valid, 
                            regardless of any constraint functions.
    ------------------------------------------------------------------
635
636
637
638
639
640
641
642
643
644

When `lyskom-read-text-no-prefix-arg' is called, this list is searched
both for a command-specific element and for the default element. Any
`:refer' links are resolved in the command-specific element. The
filter and constraint properties are extracted. These elements are
then searched for prefix-specific elements that match the current
prefix argument. The first text number that is generated that passes
the filter and constraint functions is used as the text number
argument for the command."
)
David Byers's avatar
David Byers committed
645

David Byers's avatar
David Byers committed
646
(def-kom-var kom-url-transformation-rules 
647
648
649
  '(
    ("^http://[^/]*aftonbladet\\.se/.*/story/.*html?$" . "\\&.")
    )
David Byers's avatar
David Byers committed
650
651
  "**An alist specifying transformations to be applied to URLs.

652
Elements in this list are of the form \(`PATTERN' . `REPLACEMENT').
David Byers's avatar
David Byers committed
653
654
655
Before an URL is opened, it is transformed by matching the URL against
each `PATTERN' in turn, and when a match is found, generating a new
URL according to `REPLACEMENT'.
David Byers's avatar
David Byers committed
656

657
All characters in `REPLACEMENT' except \\ are copied verbatim. The
David Byers's avatar
David Byers committed
658
backslash character starts one of the following sequences:
David Byers's avatar
David Byers committed
659

David Byers's avatar
David Byers committed
660
    Sequence    Meaning
661
662
663
664
    ---------------------------------------------------------------
    `\\&'        Substitute the matched text

    `\\N'        Substitute match for text matching the Nth (...)
David Byers's avatar
David Byers committed
665
                group in `PATTERN'
666
667
668

    `\\\\'        Insert one backslash.
    ---------------------------------------------------------------
David Byers's avatar
David Byers committed
669
"
David Byers's avatar
David Byers committed
670
671
672
673
  server
  )


674
(def-kom-var kom-check-configuration-on-startup t
David Byers's avatar
David Byers committed
675
676
677
678
679
680
681
682
683
684
685
686
687
  "**When non-nil, check Emacs configuration on client startup.

Valid values for this variable are `t' and `nil'. All other values are
reserved for future extensions. When non-nil, several checks will be
performed:

* Check that multibyte character support is enabled, if available.

* Check that the character coding Emacs uses matches the coding system
  used by the server.

Warnings will be shown in the LysKOM buffer on logon.
")
688

David Byers's avatar
David Byers committed
689

690
(def-kom-var kom-keyboard-menu-immediate-selection nil
David Byers's avatar
David Byers committed
691
692
693
694
695
696
697
698
699
  "**Controls how keyboard menus work.

When displaying text-based menus (typically by pressing the `=' key
when the cursor is on an active area), there are two modes of
selection. Setting this variable to `t' means pressing the letter
corresponding to an item selects that item. When this variable is
`nil', selection has to be confirmed by pressing enter.

Values other tha `t' and `nil' are reserved for future use."
700
701
702
  server)


703
(def-kom-var kom-edit-hide-add-button nil
David Byers's avatar
David Byers committed
704
705
706
707
  "**Controls the \"add\" button in the edit buffer.

When set to `t', hide the add button shown after the headers when
editing a text. When set to `nil' (the default), show the button.
708

David Byers's avatar
David Byers committed
709
Values other than `t' and `nil' are reserved for future use."
710
711
712
  server
)

David Byers's avatar
David Byers committed
713
(def-kom-var kom-max-overlays 120
David Byers's avatar
David Byers committed
714
715
716
717
  "**Maximum number of overlays to use to highlight texts.

When a text is displayed with its own background color (see
`kom-highlight-text-body', `kom-highlight-first-line',
718
`kom-highlight-dashed-lines', `kom-async-highlight-text-body' and
David Byers's avatar
David Byers committed
719
720
721
722
723
724
725
726
727
`kom-async-highlight-dashed-lines') one or more overlays are created.
Since a large number of overlays has a serious impact on performance,
the total number of overlays in the buffer can be limited using this
variable.

When set to a positive integer, limit the number of overlays to that
number. When set to `nil', do not limit the number of overlays. Values
other than a positive integer and `nil' are reserved for future use
and may cause unpredictible results."
David Byers's avatar
David Byers committed
728
729
730
  server
)

731
(def-kom-var kom-highlight-text-body t
David Byers's avatar
David Byers committed
732
733
734
  "**Controls highlighting of text bodies.

If `t', overlay `kom-text-body-face' on printed text bodies in LysKOM.
David Byers's avatar
David Byers committed
735
736
When this is enabled, an overlay or extent will be created that may
override certain aspects of the underlying text's formatting. Values
David Byers's avatar
David Byers committed
737
738
739
740
other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
741
742
743
  server
)

744
(def-kom-var kom-highlight-first-line t
David Byers's avatar
David Byers committed
745
746
747
748
749
750
751
752
753
  "**Controls highlighting of the first line of text headers.

If `t', overlay `kom-first-line-face' on the first header line of
texts. When this is enabled, an overlay or extent will be created that
may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
754
755
756
757
  server
)

(def-kom-var kom-highlight-dashed-lines t
David Byers's avatar
David Byers committed
758
759
760
761
762
763
764
765
766
  "**Controls highlighting of dashed lines around texts.

If `t', overlay `kom-dashed-lines-face' on the lines surrounding
texts. When this is enabled, an overlay or extent will be created that
may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
767
768
769
  server
)

770
(def-kom-var kom-async-highlight-text-body t
David Byers's avatar
David Byers committed
771
772
773
774
775
776
777
778
779
  "**Controls highlighting of asynchronous messages.

If `t', overlay `kom-async-text-body-face' on asynchronous messages in
LysKOM. When this is enabled, an overlay or extent will be created
that may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
780
781
782
783
  server
)

(def-kom-var kom-async-highlight-dashed-lines t
David Byers's avatar
David Byers committed
784
785
786
787
788
789
790
791
792
  "**Controls highlighting of dashed lines around asynchronous messages.

If `t', overlay `kom-dashed-lines-face' on the lines surrounding
messages. When this is enabled, an overlay or extent will be created
that may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
793
794
795
  server
)

David Byers's avatar
David Byers committed
796
(def-kom-var kom-extended-status-information nil
David Byers's avatar
David Byers committed
797
798
799
  "**Controls display of extra information when displaying LysKOM objects.

If `t', extended status information is listed for all objects in
800
801
802
803
804
805
806
LysKOM. If set to an association list, each element is a pair of tag
and value. The tag specifies a type of extended information. If the
corresponding value is `t', the information is shown. If the
corresponding value is `nil', the information is not shown.

Valid tags are:

807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
    Tag                   Meaning
    ------------------------------------------------------------------
    `conf'                Show all extended information for conferences

    `pers'                Show all extended information for persons

    `server'              Show all extended information for the server

    `read-faq'            Show read FAQs

    `raw-server-stats'    Show raw server statistics

    `raw-boottime-info'   Show raw boot-time server information

    `t'                   Any information not explicitly listed
    ------------------------------------------------------------------
823
824
825
826
827
828
829
830
831

The information controlled by this variable is the kind of data that
most users are not interested in, and, if displayed, would make more
important information hard to find.

Currently this includes read FAQs (for letterboxes) and full
statistics and boot-time information (for the server).

Values other than those specified are reserved for future extensions."
David Byers's avatar
David Byers committed
832
server )
833

David Byers's avatar
David Byers committed
834
(def-kom-var kom-auto-list-faqs t
David Byers's avatar
David Byers committed
835
836
837
838
839
840
841
842
  "**Controls automatic display of FAQs.

When this variable is set to `t', list unread FAQs when entering a
conference or logging on to the server. When entering a conference,
list FAQs for that conference that have not been read. When logging
on, list FAQs for the server that have not been read.

Values other than `t' or `nil' are reserved for future extension."
David Byers's avatar
David Byers committed
843
844
845
  server
)

846
(def-kom-var kom-auto-review-faqs t
David Byers's avatar
David Byers committed
847
848
849
850
851
852
853
854
855
  "**Controls automatic review of FAQs.

When set to `t', automatically review unread FAQs when entering a
conference or logging on to the server. When entering a conference,
FAQs that are unread for that conference will be reviewed. When
logging on, FAQs that are unread for the server will be reviewed.

Values other than `t' or `nil' are reserved for future use."

856
857
858
  server
)

David Byers's avatar
X    
David Byers committed
859
(def-kom-var kom-allow-incompleteness nil
David Byers's avatar
David Byers committed
860
861
862
863
864
865
866
867
868
869
  "**Allow or disallow operation on incomplete membership information.

If `nil', commands like `kom-list-news' will wait for all membership
information to be read. If this flag is set to `t', commands will not
wait for all membership information. Not waiting for complete
information allows certain commands to execute faster, particularly
during the login phase, but may result in incorrect or incomplete
answers.

Values other than `t' or `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
870
871
  server
)
872

David Byers's avatar
X    
David Byers committed
873
(def-kom-var kom-bury-buffers t
David Byers's avatar
David Byers committed
874
875
876
877
878
879
880
  "**Controls the behaviour of `kom-next-kom' and its cousins.

If this variable is `t' the current buffer is sent to the back of the
buffer list when one of the commands `kom-next-kom',
`kom-previous-kom' or `kom-next-unread-kom' is invoked.

Values other than `t' or `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
881
  server)
882

David Byers's avatar
X    
David Byers committed
883
(def-kom-var kom-write-texts-in-window nil
David Byers's avatar
David Byers committed
884
  "**Determines where to edit texts.
David Byers's avatar
David Byers committed
885

David Byers's avatar
David Byers committed
886
887
888
889
890
891
892
893
894
895
The value must be one of `nil', `other', `new-frame', `other-frame', a
string or a buffer.

When set to `nil', edit texts in the same window as the LysKOM buffer.
When set to `other', edit in another window, creating it if necessary.
When set to `other-frame', edit in another frame, if there is one
\(otherwise edit in the same window as the LysKOM buffer). When set to
`new-frame', create a new frame for editing. This frame will be
removed when editing is finished. A string means edit in the buffer
with that name. A buffer means edit in that buffer."
David Byers's avatar
X    
David Byers committed
896
  server)
897

David Byers's avatar
X    
David Byers committed
898
(def-kom-var kom-view-commented-in-window 'other
David Byers's avatar
David Byers committed
899
900
901
  "**Where to view commented texts. 

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
902
  server)
David Byers's avatar
David Byers committed
903

David Byers's avatar
X    
David Byers committed
904
(def-kom-var kom-edit-filters-in-window nil
David Byers's avatar
David Byers committed
905
906
907
  "**Where to edit filters with `kom-filter-edit'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
908
  server)
David Byers's avatar
David Byers committed
909

David Byers's avatar
X    
David Byers committed
910
(def-kom-var kom-list-membership-in-window 'other
David Byers's avatar
David Byers committed
911
912
913
  "**Where to list membership with `kom-list-membership'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
914
  server)
915

916
(def-kom-var kom-personal-messages-in-window 'other
David Byers's avatar
David Byers committed
917
918
919
  "**Where to display personal messages. 

See the documentation for `kom-write-texts-in-window' for details."
920
921
  server)

David Byers's avatar
X    
David Byers committed
922
(def-kom-var kom-customize-format 'long
David Byers's avatar
David Byers committed
923
924
925
926
927
928
929
930
  "**Determines the format of the customize buffer.

This variable currently only controls initial display of documentation
in the customize buffer (the buffer shown by `kom-customize'. When set
to the symbol `long', display documentation. When set to the symbol
`short', don't display documentation.

Values other than `long' or `short' are reserved for future use."
David Byers's avatar
X    
David Byers committed
931
  server)
932

David Byers's avatar
X    
David Byers committed
933
(def-kom-var kom-user-prompt-format "%[%c% %m%] - "
David Byers's avatar
David Byers committed
934
935
936
937
938
939
  "**Format of LysKOM prompt when waiting for input.

The value of this variable must be a string, which is displayed as the
LysKOM prompt, while waiting for a command. The string may contain the
following special sequences:

940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
    Sequence      Meaning
    -----------------------------------------------------------------
    `%c'          Inserts the current default command.

    `%['          Inserts `[' if the ansaphone is on.

    `%]'          Inserts `]' is the ansaphone is on.

    `%m'          Inserts information about recorded messages.

    `%s'          Inserts the name of the LysKOM system

    `%S'          Inserts the server name.

    `%p'          Inserts the name of the user currently logged on.

    `%w'          Inserts the name of the current conference.

    `%a'          Inserts `anonymous' in the current language.

    `%A'          Inserts `Anonymous' in the current language.

    `%#'          Inserts the current session number.

    `% '          Inserts a space if it seems necessary (percent SPC).

    `%%'          Inserts a percent sign.
    -----------------------------------------------------------------
David Byers's avatar
David Byers committed
968
969
970

Here are a few examples:

971
972
973
974
975
976
    Format string                 What it does
    -----------------------------------------------------------------
    `\"%[%c% %m%] - \"'           The default prompt

    `\"%[%s: %c% %m%] - \"'       Could display \"LysKOM: Time - \"
    -----------------------------------------------------------------
David Byers's avatar
David Byers committed
977
978

Note that multiline prompts are not supported."
David Byers's avatar
X    
David Byers committed
979
  server)
David Byers's avatar
David Byers committed
980

Per Cederqvist's avatar
.    
Per Cederqvist committed
981

David Byers's avatar
X    
David Byers committed
982
(def-kom-var kom-user-prompt-format-executing "%[%c% %m%]."
David Byers's avatar
David Byers committed
983
984
985
986
  "**Format of LysKOM prompt when executing a default command.

The value of this variable must be a string. See
`kom-user-prompt-format' for details."
David Byers's avatar
X    
David Byers committed
987
  server)
David Byers's avatar
David Byers committed
988
989


David Byers's avatar
X    
David Byers committed
990
(def-kom-var kom-enabled-prompt-format "%[%c% %m%] # "
David Byers's avatar
David Byers committed
991
992
993
994
  "**Format of LysKOM prompt when privileges are enabled..

The value of this variable must be a string. See
`kom-user-prompt-format' for details."
David Byers's avatar
X    
David Byers committed
995
  server)
David Byers's avatar
David Byers committed
996

997

David Byers's avatar
X    
David Byers committed
998
(def-kom-var kom-enabled-prompt-format-executing "%[%c% %m%]."
David Byers's avatar
David Byers committed
999
  "**Format of LysKOM prompt when executing a default command when
David Byers's avatar
David Byers committed
1000
1001
1002
1003
privileges are enabled. 

The value of this variable must be a string. See
`kom-user-prompt-format' for details."
David Byers's avatar
X    
David Byers committed
1004
  server)
David Byers's avatar
David Byers committed
1005

David Byers's avatar
David Byers committed
1006
(def-kom-var kom-anonymous-prompt-format "%[%c% %m%] (%a) - "
David Byers's avatar
David Byers committed
1007
1008
1009
1010
1011
1012
  "**Format of the LysKOM prompt when running anonymously.

The value of this variable must be a string. See
`kom-user-prompt-format' for details. See `kom-become-anonymous' for
information on anonymous mode.
"
David Byers's avatar
David Byers committed
1013
1014
1015
  server)

(def-kom-var kom-anonymous-prompt-format-executing "%[%c% %m%] (%a)."
David Byers's avatar
David Byers committed
1016
1017
1018
1019
1020
  "**Format of the LysKOM prompt when executing a command anonymously.

The value of this variable must be a string. See
`kom-user-prompt-format' for details. See `kom-become-anonymous' for
information on anonymous mode."
David Byers's avatar
David Byers committed
1021
1022
  server)

1023
(def-kom-var kom-show-week-number t
David Byers's avatar
David Byers committed
1024
1025
1026
1027
1028
1029
1030
  "**Controls display of week numbers in `kom-display-time'.

If set to `t' show the ISO week number when displaying the time. If
set to `nil', don't display the time. All other values are reserved
for future use.

For this feature to work, the calendar package must be installed."
1031
1032
  server)

David Byers's avatar
David Byers committed
1033

David Byers's avatar
X    
David Byers committed
1034
(def-kom-var kom-cite-string ">"
David Byers's avatar
David Byers committed
1035
1036
1037
1038
1039
  "**String to insert before each line of a commented text.

When citing a text in edit-mode, this string will be inserted before
each line. Although citing is not common and usually not useful in
LysKOM, there is occasionally reason to cite a commented text."
David Byers's avatar
X    
David Byers committed
1040
  server)
1041

1042
(def-kom-var kom-created-texts-are-saved nil
1043
  "**If non-nil, save all created texts to a file. 
David Byers's avatar
David Byers committed
1044
1045
1046
1047
1048

The value of this variable is the file name on which to save new
texts. Each time a text is created, it is appended to this file.
Values other than a string may produce unpredictible results, and are
reserved for future extensions."
1049
1050
1051
  server
  inherited)

1052
(def-kom-var kom-created-texts-are-read nil
1053
  "**non-nil means automatically mark texts that you create as read.
David Byers's avatar
David Byers committed
1054
1055
1056
1057
1058
1059

When set to `t', all text you write are automatically marked as read,
except when running in anonymous mode. When set to `nil', your texts
will be shown as all others.

Values other than `t' and `nil' are reserved for future extensions."
1060
  common created-texts-are-read boolean)
David Byers's avatar
David Byers committed
1061

1062
(def-kom-var kom-mark-read-texts-as-read-in-new-recipient t
David Byers's avatar
David Byers committed
1063
1064
1065
1066
1067
1068
1069
1070
1071
  "**Controls whether to mark read texts as read in new recipients the acquire.

When this is set to `t', silently mark texts as read when they are
added to a new recipient, if they have been read in any conference.
When `nil', do not mark as read. This feature only works when you are
logged on. Texts added to new conferences while you are not logged on
will not be marked as read in the new recipient.

Values other than `t' or `nil' are reserved for future extensions."
1072
1073
  server)

David Byers's avatar
X    
David Byers committed
1074
(def-kom-var kom-customize-in-window nil
David Byers's avatar
David Byers committed
1075
1076
1077
  "**Where to customize LysKOM with `kom-customize'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
1078
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1079

David Byers's avatar
X    
David Byers committed
1080
(def-kom-var kom-prioritize-in-window nil
David Byers's avatar
David Byers committed
1081
1082
1083
  "**Where to prioritize conferences with `kom-prioritize'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
1084
  server)
David Byers's avatar
David Byers committed
1085

1086
(def-kom-var kom-default-mark nil
David Byers's avatar
David Byers committed
1087
1088
1089
1090
1091
1092
1093
  "**The default mark used by `kom-mark-text'.

When set to an integer, `kom-mark-text' will not ask for a mark, but
simply mark with that number. When set to `nil', `kom-mark-text' will
ask for a mark.

Values other than integers and `nil' are reserved for future use."
1094
1095
  common default-mark integer
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1096

1097
(def-kom-var kom-symbolic-marks-alist '(("Standard" . 100))
David Byers's avatar
David Byers committed
1098
1099
1100
1101
1102
1103
1104
  "**Association list that maps symbolic marks to mark numbers.

Internally, texts can only be marked with numbers. The elisp client
implements symbolic marks through this mapping from mark names to
numbers. Each element of this list is a pair \(`NAME' . `MARK'), where
`NAME' is the name of the mark, and `MARK' is the corresponding
numeric mark."
1105
1106
  server)

David Byers's avatar
X    
David Byers committed
1107
(def-kom-var kom-reading-puts-comments-in-pointers-last t
David Byers's avatar
David Byers committed
1108
1109
1110
1111
1112
1113
1114
  "**Controls the location where comment pointers are shown.

When set to `t', comment references are shwon at the end of texts.
When set to `nil', comment references are shwon in the headers.

`kom-reading-puts-comments-in-pointers-last' set to `nil'

1115
<
David Byers's avatar
David Byers committed
1116
1117
1118
1119
1120
1121
1122
    398331 1996-09-24  13:22  /2 lines/ George Berkeley
    Recipient: Philosophy <1226>
    Comment in text 398374 by John Locke
    Subject: 
    ------------------------------------------------------------
    An abstract idea is a contradiction in terms.
    (398331) -----------------------------------
1123
>
David Byers's avatar
David Byers committed
1124
1125
1126

`kom-reading-puts-comments-in-pointers-last' set to `t'

1127
<
David Byers's avatar
David Byers committed
1128
1129
1130
1131
1132
1133
1134
    398331 1996-09-24  13:22  /2 lines/ George Berkeley
    Recipient: Philosophy <1226>
    Subject: 
    ------------------------------------------------------------
    An abstract idea is a contradiction in terms.
    (398331) -----------------------------------
    Comment in text 398374 by John Locke
1135
>
David Byers's avatar
David Byers committed
1136
"
1137
  common reading-puts-comments-in-pointers-last boolean
David Byers's avatar
David Byers committed
1138
  inherited)
David Byers's avatar
David Byers committed
1139

1140
(def-kom-var kom-review-uses-cache t
David Byers's avatar
David Byers committed
1141
1142
1143
1144
1145
1146
1147
1148
  "**Controls whether review commands use the cache or not.

When set to `t', review commands (such as `kom-review-by-to') will get
texts from the client cache, if possible. This improves performance,
but texts may have changed since they were cached. When set to `nil',
review commands will always get texts from the server.

Values other than `t' and `nil' are reserved for future use."
1149
1150
1151
  server
  inherited)

1152
(def-kom-var kom-review-marks-texts-as-read nil
David Byers's avatar
David Byers committed
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
  "**Controls whether viewing texts with review commands marks then as read.

When set to `t', viewing texts with review commands (e.g.
`kom-review-by-to') will mark unread texts as read. When set to `nil',
texts are not marked as read. 

It is possible to change this setting for a single review command with
the key sequence for `kom-toggle-mark-as-read-prefix'. The value can
be changed for the entire session by using
`kom-make-review-mark-as-read' or `kom-make-review-not-mark-as-read'.

Values other than `t' and `nil' are reserved for future use."
1165
1166
1167
  server
  inherited)

David Byers's avatar
David Byers committed
1168
(def-kom-var kom-postpone-default 17
David Byers's avatar
David Byers committed
1169
1170
1171
1172
  "**The default number of texts to postpone with `kom-postpone'.

The value of this variable must be a positive integer or zero. All
other values are reserved for future use."
David Byers's avatar
David Byers committed
1173
1174
1175
  server)


David Byers's avatar
X    
David Byers committed
1176
(def-kom-var kom-dashed-lines t
David Byers's avatar
David Byers committed
1177
1178
1179
1180
1181
1182
1183
  "**Controls display of dashed lines before and after texts.

when set to `t' display dashed lines. When set to `nil', don't display
dashed lines.

`kom-dashed-lines' set to `t'

1184
<
David Byers's avatar
David Byers committed
1185
1186
1187
1188
1189
1190
    892343 1996-09-24  19:21  /2 lines/ Tycho Brahe
    Recipien: Presentation (of new) Members
    Subject: Tycho Brahe
    ------------------------------------------------------------
    Astronomer and discoverer of stars resident on the island of Ven.
    (892343) -----------------------------------
1191
>
David Byers's avatar
David Byers committed
1192
1193
1194

`kom-dashed-lines' set to `nil'

1195
<
David Byers's avatar
David Byers committed
1196
1197
1198
1199
1200
1201
    892343 1996-09-24  19:21  /2 lines/ Tycho Brahe
    Recipien: Presentation (of new) Members
    Subject: Tycho Brahe

    Astronomer and discoverer of stars resident on the island of Ven.
    (892343)
1202
>
David Byers's avatar
David Byers committed
1203
1204
1205
1206
1207
1208

Values other than `t' and `nil' are reserved for future use. 

See `kom-highlight-dashed-lines' and
`kom-async-highlight-dashed-lines' for additional settings that affect
these lines."
1209
  common dashed-lines boolean
David Byers's avatar
David Byers committed
1210
  inherited)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1211

1212
(def-kom-var kom-long-lines nil
1213
  "**If non-nil, some lines and borders will be made longer.
David Byers's avatar
David Byers committed
1214
1215
1216
1217
1218

When set to `t', most dashed lines will be longer than the default.
When set to `nil',  use the standard length.

See `kom-text-footer-dash-length', `kom-text-header-dash-length' and
1219
`kom-text-footer-format' for other related settings."
1220
1221
1222
1223
  server
  inherited)

(def-kom-var kom-text-footer-dash-length 52
David Byers's avatar
David Byers committed
1224
1225
1226
1227
1228
1229
1230
  "**Control the length of the text footer.

When dashed lines (see `kom-dashed-lines') are in effect, and this is
set to a positive integer, make the text footer at least that many
characters long. Values other than a positive integer are reserved for
future use.

1231
1232
1233
Note that the footer may end up longer than this if one or more elements
together are longer than this length.

David Byers's avatar
David Byers committed
1234
This length is currently ignored when `kom-text-footer-format' is used."
1235
1236
1237
1238
  server
  inherited)

(def-kom-var kom-text-header-dash-length 60
David Byers's avatar
David Byers committed
1239
1240
1241
1242
1243
1244
1245
  "**Control the length of the text footer.

When dashed lines (see `kom-dashed-lines') are in effect, and this is
set to a positive integer, make the dashed line before the text that
many characters long. 

Values other than a positive integer are reserved for future use."
1246
1247
1248
1249
1250
  server
  inherited)



1251
(def-kom-var kom-text-footer-format nil
David Byers's avatar
David Byers committed
1252
  "**Defines the format of the text footer.
1253

David Byers's avatar
David Byers committed
1254
1255
1256
When set to a string, use that string as the text footer, overriding
all other settings that affect the text footer. The string may contain
the following special sequences:
1257

1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
    Directive     Meaning
    -------------------------------------------------------------
    `%n'          Insert the text number

    `%p'          Insert the number of the author

    `%P'          Insert the name of the author

    `%-'          Insert a bunch of dashes

    `%f'          Insert special formatting information
    -------------------------------------------------------------
1270

David Byers's avatar
David Byers committed
1271
1272
1273
1274
1275
Format directives can be prefixed with a number specifying the minimum
field width (e.g. `%20-'. The field width can be prefixed with an
equals sign (e.g. `%=20p' which means that the field is exactly as
wide as specified (contents may be truncated). A negative field width
means left justify the contents.
1276
1277

The field width of %- is special. It specifies the maximum number of
David Byers's avatar
David Byers committed
1278
1279
dashes printed. The actual number will be the maximum minus the length
of the author's name, if it is included anywhere in the format string.
1280

David Byers's avatar
David Byers committed
1281
1282
When set, this variable overrides `kom-dashed-lines' and
`kom-show-author-at-end'.
1283
1284
1285
1286

The default format is equivalent to the following strings, depending on 
the settings of kom-dashed-lines and kom-show-author-at-end.

1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
    `kom-dashed-lines'  `kom-show-author-at-end'   Format
    --------------------------------------------------------------------
    `t'                  `t'                       `\"(%n) /%P/%42-%f\"'

    `t'                  `nil'                     `\"(%n) %42-%f\"'

    `nil'                `t'                       `\"(%n) /%P/ %f\"'

    `nil'                `nil'                     `\"(%n) %f\"'
    --------------------------------------------------------------------
1297
1298
1299
1300
1301
1302
"
  server
  inherited)



1303
(def-kom-var kom-show-creating-software nil
David Byers's avatar
David Byers committed
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
  "**Controls display of the software used to create each text.

When creating a text, it is possible to attach information about which
client was used to create the text. When this variable is set to `t',
this information, when available,  is displayed in all text headers.
When this variable is set to `nil', the information is not shown.

To display creating software for a text when this is off, review the
text using `kom-review-noconversion'.

Values other than `t' and `nil' are reserved for future use."
1315
1316
1317
  server
  inherited)

David Byers's avatar
David Byers committed
1318
(def-kom-var kom-show-author-at-end t
David Byers's avatar
David Byers committed
1319
1320
1321
1322
1323
1324
1325
  "**Controls display of author information in the text footer.

When this is set to `t', display the author of each text immediately
after the text. When set to `nil', the author is not displayed.

`kom-show-author-at-end' set to `t' (with dashed lines on):

1326
<
David Byers's avatar
David Byers committed
1327
1328
1329
1330
1331
1332
  892342 1996-09-24  19:21  /2 lines/ Claude Shannon
  Mottagare: Presentation (of new) Members
  Ärende: Claude Shannon
  ------------------------------------------------------------
  Information theoretician
  (892342) /Claude Shannon/------------------------------
1333
>
David Byers's avatar
David Byers committed
1334
1335
1336

`kom-show-author-at-end' set to `nil':

1337
<
David Byers's avatar
David Byers committed
1338
1339
1340
1341
1342
1343
  892342 1996-09-24  19:21  /2 lines/ Claude Shannon
  Recipient: Presentation (of new) Members
  Subject: Claude Shannon
  ------------------------------------------------------------
  Information theoretician
  (892342) -----------------------------------
1344
>
David Byers's avatar
David Byers committed
1345
1346
1347

If `kom-text-footer-format' is set, the value of this variable is
ignored. Values other than `t' and `nil' are reserved for future use."
David Byers's avatar
David Byers committed
1348
1349
  server
  inherited)
David Byers's avatar
David Byers committed
1350

Peter Liljenberg's avatar