| blob | c34c3b6df884178480dc26011b71f99f7779450c |
1 ;;; gnus-diary.el --- Wrapper around the NNDiary Gnus backend
3 ;; Copyright (c) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
4 ;; Copyright (C) 1999, 2000, 2001 Didier Verna.
6 ;; Author: Didier Verna <didier@xemacs.org>
7 ;; Maintainer: Didier Verna <didier@xemacs.org>
8 ;; Created: Tue Jul 20 10:42:55 1999
9 ;; Keywords: calendar mail news
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published
15 ;; by the Free Software Foundation; either version 2 of the License,
16 ;; or (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful, but
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 ;; General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program; if not, write to the Free Software
25 ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 ;;; Commentary:
30 ;; Contents management by FCM version 0.1.
32 ;; Description:
33 ;; ===========
35 ;; Gnus-Diary is a wrapper around the NNDiary Gnus backend. It is here to
36 ;; make your nndiary-user life easier in different ways. So, you don't have
37 ;; to use it if you don't want to. But, really, you should.
39 ;; Gnus-Diary offers the following features on top of the NNDiary backend:
41 ;; - A nice summary line format:
42 ;; Displaying diary messages in standard summary line format (usually
43 ;; something like "<From Joe>: <Subject>") is pretty useless. Most of the
44 ;; time, you're the one who wrote the message, and you mostly want to see
45 ;; the event's date. Gnus-Diary offers you a nice summary line format
46 ;; which will do this. By default, a summary line will appear like this:
47 ;;
48 ;; <Event Date>: <Subject> <Remaining time>
49 ;;
50 ;; for example, here's how Joe's birthday is displayed in my
51 ;; "nndiary:birhdays" summary buffer (the message is expirable, but will
52 ;; never be deleted, as it specifies a regular event):
53 ;;
54 ;; E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
56 ;; - More article sorting functions:
57 ;; Gnus-Diary adds a new sorting function called
58 ;; `gnus-summary-sort-by-schedule'. This function lets you organize your
59 ;; diary summary buffers from the closest event to the farthest one.
61 ;; - Automatic generation of diary group parameters:
62 ;; When you create a new diary group, or visit one, Gnus-Diary checks your
63 ;; group parameters, and if needed, sets the summary line format to the
64 ;; diary-specific value, adds the diary-specific sorting functions, and
65 ;; also adds the different `X-Diary-*' headers to the group's
66 ;; posting-style. It is then easier to send a diary message, because if
67 ;; you use `C-u a' or `C-u m' on a diary group to prepare a message, these
68 ;; headers will be inserted automatically (but not filled with proper
69 ;; values yet).
71 ;; - An interactive mail-to-diary convertion function:
72 ;; The function `gnus-diary-check-message' ensures that the current message
73 ;; contains all the required diary headers, and prompts you for values /
74 ;; correction if needed. This function is hooked in the nndiary backend so
75 ;; that moving an article to an nndiary group will trigger it
76 ;; automatically. It is also bound to `C-c D c' in message-mode and
77 ;; article-edit-mode in order to ease the process of converting a usual
78 ;; mail to a diary one. This function takes a prefix argument which will
79 ;; force prompting of all diary headers, regardless of their
80 ;; presence/validity. That way, you can very easily reschedule a diary
81 ;; message for instance.
84 ;; Usage:
85 ;; =====
87 ;; 0/ Don't use any `gnus-user-format-function-[d|D]'. Gnus-Diary provides
88 ;; both of these (sorry if you used them before).
89 ;; 1/ Add '(require 'gnus-diary) to your gnusrc file.
90 ;; 2/ Customize your gnus-diary options to suit your needs.
94 ;; Bugs / Todo:
95 ;; ===========
98 ;;; Code:
105 "Utilities on top of the nndiary backend for Gnus."
110 "*Summary line format for nndiary groups."
116 "*Time format to display appointements in nndiary summary buffers.
117 Please refer to `format-time-string' for information on possible values."
122 "*Function called to format a diary delay string.
123 It is passed two arguments. The first one is non nil if the delay is in
124 the past. The second one is of the form ((NUM . UNIT) ...) where NUM is
125 an integer and UNIT is one of 'year 'month 'week 'day 'hour or 'minute.
129 There are currently two built-in format functions:
130 `gnus-diary-delay-format-english' (the default)
131 `gnus-diary-delay-format-french'"
141 ;; Compatibility functions ==================================================
152 ;; Summary line format ======================================================
156 "maintenant!"
157 ;; Keep only a precision of two degrees
161 del)
181 str))))
186 "now!"
187 ;; Keep only a precision of two degrees
191 del)
198 str)
203 ;; Same as `nndiary-schedule', but given a set of headers HEADERS
207 headers))))
210 nndiary-headers))
212 ;; #### NOTE: Gnus sometimes gives me a HEADER not corresponding to any
213 ;; message, with all fields set to nil here. I don't know what it is for, and
214 ;; I just ignore it.
216 ;; Returns an aproximative delay string for the next occurence of this
217 ;; message. The delay is given only in the first non zero unit.
218 ;; Code partly stolen from article-make-date-line
225 "?????"
228 delay)
231 ;; This is a bit convoluted, but basically we go through the time
232 ;; units for years, weeks, etc, and divide things to see whether
233 ;; that results in positive answers.
240 unit num)
246 ))
248 ;; #### NOTE: Gnus sometimes gives me a HEADER not corresponding to any
249 ;; message, with all fields set to nil here. I don't know what it is for, and
250 ;; I just ignore it.
252 ;; Returns a formatted time string for the next occurence of this message.
259 ;; Article sorting functions ================================================
279 "Sort nndiary summary buffers by schedule of appointements.
280 Optional prefix (or REVERSE argument) means sort in reverse order."
290 gnus-summary-sort-by-schedule
292 gnus-newsgroup-name))
298 ;; Group parameters autosetting =============================================
301 ;; Ensure that nndiary groups have convenient group parameters:
302 ;; - a posting style containing X-Diary headers
303 ;; - a nice summary line format
304 ;; - NNDiary specific sorting by schedule functions
305 ;; In general, try not to mess with what the user might have modified.
307 ;; Posting style:
313 ))
314 nndiary-headers)
316 ;; Summary line format:
320 ;; Sorting by schedule:
331 ))
333 ;; Called when a group is subscribed. This is needed because groups created
334 ;; because of mail splitting are *not* created with the backend function.
335 ;; Thus, `nndiary-request-create-group-hooks' is inoperative.
342 ;; Now that we have `gnus-subscribe-newsgroup-hooks', this is not needed
343 ;; anymore. Maybe I should remove this completely.
350 ;; Diary Message Checking ===================================================
353 ;; History variable for header value prompting
354 )
357 "Narrow the current buffer to the header part.
358 Point is left at the beginning of the region.
359 The buffer is assumed to contain a message, but the format is unknown."
367 ))
370 "Add a header to the current buffer.
371 The buffer is assumed to contain a message, but the format is unknown."
381 ))
384 "Ensure that the current message is a valid for NNDiary.
385 This function checks that all NNDiary required headers are present and
386 valid, and prompts for values / correction otherwise.
388 If ARG (or prefix) is non-nil, force prompting for all fields."
395 value invalid)
396 ;; First, try to find the header, and checks for validity:
410 ;; #### NOTE: this (along with the `gnus-diary-add-header'
411 ;; function) could be rewritten in a better way, in particular
412 ;; not to blindly remove an already present header and reinsert
413 ;; it somewhere else afterwards.
416 ))
417 ;; Now, loop until a valid value is provided:
426 nil t value
427 gnus-diary-header-value-history)
429 gnus-diary-header-value-history))))
438 ))
439 nndiary-headers)
440 ))
449 ;; The end ==================================================================
452 "Current Diary backend version."
462 ;;; arch-tag: 98467e70-337e-4ddc-b92d-45d403ff1b4b
463 ;;; gnus-diary.el ends here