comparison lisp/calendar/diary-lib.el @ 93950:1a435b435254

(diary-hook, diary-display-hook): Move here from calendar.el. (diary-hook): Doc fix.
author Glenn Morris <rgm@gnu.org>
date Thu, 10 Apr 2008 03:44:47 +0000
parents 3ff2b47de8f2
children 3784131a315f
comparison
equal deleted inserted replaced
93949:1f90229f007f 93950:1a435b435254
136 :type 'string 136 :type 'string
137 :group 'diary) 137 :group 'diary)
138 138
139 (define-obsolete-variable-alias 'sexp-diary-entry-symbol 139 (define-obsolete-variable-alias 'sexp-diary-entry-symbol
140 'diary-sexp-entry-symbol "23.1") 140 'diary-sexp-entry-symbol "23.1")
141
142 (defcustom diary-hook nil
143 "List of functions called after the display of the diary.
144 Used for example by the appointment package - see `appt-activate'."
145 :type 'hook
146 :group 'diary)
147
148 (defcustom diary-display-hook nil
149 "List of functions that handle the display of the diary.
150 If nil (the default), `diary-simple-display' is used. Use
151 `ignore' for no diary display.
152
153 Ordinarily, this just displays the diary buffer (with holidays
154 indicated in the mode line), if there are any relevant entries.
155 At the time these functions are called, the variable
156 `diary-entries-list' is a list, in order by date, of all relevant
157 diary entries in the form of ((MONTH DAY YEAR) STRING), where
158 string is the diary entry for the given date. This can be used,
159 for example, a different buffer for display (perhaps combined
160 with holidays), or produce hard copy output.
161
162 A function `diary-fancy-display' is provided for use with this
163 hook; this function prepares a special noneditable diary buffer
164 with the relevant diary entries that has neat day-by-day
165 arrangement with headings. The fancy diary buffer will show the
166 holidays unless the variable `diary-show-holidays-flag' is set to
167 nil. Ordinarily, the fancy diary buffer will not show days for
168 which there are no diary entries, even if that day is a holiday;
169 if you want such days to be shown in the fancy diary buffer, set
170 the variable `diary-list-include-blanks' non-nil."
171 :type 'hook
172 :options '(diary-fancy-display)
173 :initialize 'custom-initialize-default
174 :set 'diary-set-maybe-redraw
175 :group 'diary)
141 176
142 (defcustom diary-list-entries-hook nil 177 (defcustom diary-list-entries-hook nil
143 "List of functions called after diary file is culled for relevant entries. 178 "List of functions called after diary file is culled for relevant entries.
144 You might wish to add `diary-include-other-diary-files', in which case 179 You might wish to add `diary-include-other-diary-files', in which case
145 you will probably also want to add `diary-mark-included-diary-files' to 180 you will probably also want to add `diary-mark-included-diary-files' to