Mercurial > emacs
annotate lispref/calendar.texi @ 10484:08e1b7f85e5e
(remote-shell-program): Reorder search path.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Thu, 19 Jan 1995 22:24:43 +0000 |
parents | ab6b8aa5002e |
children | 7601ae23cf92 |
rev | line source |
---|---|
6387 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @node Calendar, Tips, Display, Top | |
6 @chapter Customizing the Calendar and Diary | |
7 | |
8 There are many customizations that you can use to make the calendar and | |
9 diary suit your personal tastes. | |
10 | |
11 @menu | |
12 * Calendar Customizing:: Defaults you can set. | |
13 * Holiday Customizing:: Defining your own holidays. | |
14 * Date Display Format:: Changing the format. | |
15 * Time Display Format:: Changing the format. | |
16 * Daylight Savings:: Changing the default. | |
17 * Diary Customizing:: Defaults you can set. | |
18 * Hebrew/Islamic Entries:: How to obtain them. | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
19 * Fancy Diary Display:: Enhancing the diary display, sorting entries, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
20 using included diary files. |
6387 | 21 * Sexp Diary Entries:: Fancy things you can do. |
22 * Appt Customizing:: Customizing appointment reminders. | |
23 @end menu | |
24 | |
25 @node Calendar Customizing | |
26 @section Customizing the Calendar | |
27 @vindex view-diary-entries-initially | |
28 | |
29 If you set the variable @code{view-diary-entries-initially} to | |
30 @code{t}, calling up the calendar automatically displays the diary | |
31 entries for the current date as well. The diary dates appear only if | |
32 the current date is visible. If you add both of the following lines to | |
33 your @file{.emacs} file:@refill | |
34 | |
35 @example | |
36 (setq view-diary-entries-initially t) | |
37 (calendar) | |
38 @end example | |
39 | |
40 @noindent | |
7688 | 41 this displays both the calendar and diary windows whenever you start Emacs. |
6387 | 42 |
43 @vindex view-calendar-holidays-initially | |
44 Similarly, if you set the variable | |
45 @code{view-calendar-holidays-initially} to @code{t}, entering the | |
7688 | 46 calendar automatically displays a list of holidays for the current |
47 three-month period. The holiday list appears in a separate | |
48 window. | |
6387 | 49 |
50 @vindex mark-diary-entries-in-calendar | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
51 You can set the variable @code{mark-diary-entries-in-calendar} to |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
52 @code{t} in order to mark any dates with diary entries. This takes |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
53 effect whenever the calendar window contents are recomputed. There are |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
54 two ways of marking these dates: by changing the face (@pxref{Faces}), |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
55 if the display supports that, or by placing a plus sign (@samp{+}) |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
56 beside the date otherwise. |
6387 | 57 |
58 @vindex mark-holidays-in-calendar | |
59 Similarly, setting the variable @code{mark-holidays-in-calendar} to | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
60 @code{t} marks holiday dates, either with a change of face or with an |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
61 asterisk (@samp{*}). |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
62 |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
63 @vindex calendar-holiday-marker |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
64 @vindex diary-entry-marker |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
65 The variable @code{calendar-holiday-marker} specifies how to mark a |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
66 date as being a holiday. Its value may be a character to insert next to |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
67 the date, or a face name to use for displaying the date. Likewise, the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
68 variable @code{diary-entry-marker} specifies how to mark a date that has |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
69 diary entries. |
6387 | 70 |
71 @vindex calendar-load-hook | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
72 The variable @code{calendar-load-hook} is a normal hook run when the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
73 calendar package is first loaded (before actually starting to display |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
74 the calendar). |
6387 | 75 |
76 @vindex initial-calendar-window-hook | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
77 Starting the calendar runs the normal hook |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
78 @code{initial-calendar-window-hook}. Recomputation of the calendar |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
79 display does not run this hook. But if you leave the calendar with the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
80 @kbd{q} command and reenter it, the hook runs again.@refill |
6387 | 81 |
82 @vindex today-visible-calendar-hook | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
83 The variable @code{today-visible-calendar-hook} is a normal hook run |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
84 after the calendar buffer has been prepared with the calendar when the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
85 current date is visible in the window. One use of this hook is to |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
86 replace today's date with asterisks; to do that, use the hook function |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
87 @code{calendar-star-date}. |
6387 | 88 |
89 @findex calendar-star-date | |
90 @example | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
91 (add-hook 'today-visible-calendar-hook 'calendar-star-date) |
6387 | 92 @end example |
93 | |
94 @noindent | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
95 Another standard hook function marks the current date, either by |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
96 changing its face or by adding an asterisk. Here's how to use it: |
6387 | 97 |
98 @findex calendar-mark-today | |
99 @example | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
100 (add-hook 'today-visible-calendar-hook 'calendar-mark-today) |
6387 | 101 @end example |
102 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
103 @noindent |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
104 @vindex calendar-today-marker |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
105 The variable @code{calendar-today-marker} specifies how to mark today's |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
106 date. Its value should be a character to insert next to the date or a |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
107 face name to use for displaying the date. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
108 |
6387 | 109 @vindex today-invisible-calendar-hook |
110 @noindent | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
111 A similar normal hook, @code{today-invisible-calendar-hook} is run if |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
112 the current date is @emph{not} visible in the window. |
6387 | 113 |
114 @node Holiday Customizing | |
115 @section Customizing the Holidays | |
116 | |
117 @vindex calendar-holidays | |
118 @vindex christian-holidays | |
119 @vindex hebrew-holidays | |
120 @vindex islamic-holidays | |
121 Emacs knows about holidays defined by entries on one of several lists. | |
7688 | 122 You can customize these lists of holidays to your own needs, adding or |
123 deleting holidays. The lists of holidays that Emacs uses are for | |
124 general holidays (@code{general-holidays}), local holidays | |
125 (@code{local-holidays}), Christian holidays (@code{christian-holidays}), | |
126 Hebrew (Jewish) holidays (@code{hebrew-holidays}), Islamic (Moslem) | |
127 holidays (@code{islamic-holidays}), and other holidays | |
128 (@code{other-holidays}). | |
6387 | 129 |
130 @vindex general-holidays | |
131 The general holidays are, by default, holidays common throughout the | |
132 United States. To eliminate these holidays, set @code{general-holidays} | |
133 to @code{nil}. | |
134 | |
135 @vindex local-holidays | |
136 There are no default local holidays (but sites may supply some). You | |
137 can set the variable @code{local-holidays} to any list of holidays, as | |
138 described below. | |
139 | |
140 @vindex all-christian-calendar-holidays | |
141 @vindex all-hebrew-calendar-holidays | |
142 @vindex all-islamic-calendar-holidays | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
143 By default, Emacs does not include all the holidays of the religions |
7688 | 144 that it knows, only those commonly found in secular calendars. For a |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
145 more extensive collection of religious holidays, you can set any (or |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
146 all) of the variables @code{all-christian-calendar-holidays}, |
6387 | 147 @code{all-hebrew-calendar-holidays}, or |
148 @code{all-islamic-calendar-holidays} to @code{t}. If you want to | |
149 eliminate the religious holidays, set any or all of the corresponding | |
150 variables @code{christian-holidays}, @code{hebrew-holidays}, and | |
151 @code{islamic-holidays} to @code{nil}.@refill | |
152 | |
153 @vindex other-holidays | |
154 You can set the variable @code{other-holidays} to any list of | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
155 holidays. This list, normally empty, is intended for individual use. |
6387 | 156 |
157 @cindex holiday forms | |
158 Each of the lists (@code{general-holidays}, @code{local-holidays}, | |
159 @code{christian-holidays}, @code{hebrew-holidays}, | |
160 @code{islamic-holidays}, and @code{other-holidays}) is a list of | |
161 @dfn{holiday forms}, each holiday form describing a holiday (or | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
162 sometimes a list of holidays). |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
163 |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
164 Here is a table of the possible kinds of holiday form. Day numbers |
7688 | 165 and month numbers count starting from 1, but ``dayname'' numbers |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
166 count Sunday as 0. The element @var{string} is always the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
167 name of the holiday, as a string. |
6387 | 168 |
169 @table @code | |
170 @item (holiday-fixed @var{month} @var{day} @var{string}) | |
7688 | 171 A fixed date on the Gregorian calendar. |
6387 | 172 |
173 @item (holiday-float @var{month} @var{dayname} @var{k} @var{string}) | |
174 The @var{k}th @var{dayname} in @var{month} on the Gregorian calendar | |
175 (@var{dayname}=0 for Sunday, and so on); negative @var{k} means count back | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
176 from the end of the month. |
6387 | 177 |
178 @item (holiday-hebrew @var{month} @var{day} @var{string}) | |
7688 | 179 A fixed date on the Hebrew calendar. |
6387 | 180 |
181 @item (holiday-islamic @var{month} @var{day} @var{string}) | |
7688 | 182 A fixed date on the Islamic calendar. |
6387 | 183 |
184 @item (holiday-julian @var{month} @var{day} @var{string}) | |
7688 | 185 A fixed date on the Julian calendar. |
6387 | 186 |
187 @item (holiday-sexp @var{sexp} @var{string}) | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
188 A date calculated by the Lisp expression @var{sexp}. The expression |
7688 | 189 should use the variable @code{year} to compute and return the date of a |
190 holiday, or @code{nil} if the holiday doesn't happen this year. The | |
191 value of @var{sexp} must represent the date as a list of the form | |
192 @code{(@var{month} @var{day} @var{year})}. | |
193 | |
194 @item (if @var{condition} @var{holiday-form}) | |
195 A holiday that happens only if @var{condition} is true. | |
6387 | 196 |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
197 @item (@var{function} @r{[}@var{args}@r{]}) |
7688 | 198 A list of dates calculated by the function @var{function}, called with |
199 arguments @var{args}. | |
6387 | 200 @end table |
201 | |
202 For example, suppose you want to add Bastille Day, celebrated in | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
203 France on July 14. You can do this as follows: |
6387 | 204 |
205 @smallexample | |
206 (setq other-holidays '((holiday-fixed 7 14 "Bastille Day"))) | |
207 @end smallexample | |
208 | |
209 @noindent | |
210 The holiday form @code{(holiday-fixed 7 14 "Bastille Day")} specifies the | |
211 fourteenth day of the seventh month (July). | |
212 | |
213 Many holidays occur on a specific day of the week, at a specific time | |
214 of month. Here is a holiday form describing Hurricane Supplication Day, | |
215 celebrated in the Virgin Islands on the fourth Monday in August: | |
216 | |
217 @smallexample | |
218 (holiday-float 8 1 4 "Hurricane Supplication Day") | |
219 @end smallexample | |
220 | |
221 @noindent | |
222 Here the 8 specifies August, the 1 specifies Monday (Sunday is 0, | |
223 Tuesday is 2, and so on), and the 4 specifies the fourth occurrence in | |
224 the month (1 specifies the first occurrence, 2 the second occurrence, | |
225 @minus{}1 the last occurrence, @minus{}2 the second-to-last occurrence, and | |
226 so on). | |
227 | |
228 You can specify holidays that occur on fixed days of the Hebrew, | |
229 Islamic, and Julian calendars too. For example, | |
230 | |
231 @smallexample | |
232 (setq other-holidays | |
233 '((holiday-hebrew 10 2 "Last day of Hanukkah") | |
234 (holiday-islamic 3 12 "Mohammed's Birthday") | |
235 (holiday-julian 4 2 "Jefferson's Birthday"))) | |
236 @end smallexample | |
237 | |
238 @noindent | |
239 adds the last day of Hanukkah (since the Hebrew months are numbered with | |
240 1 starting from Nisan), the Islamic feast celebrating Mohammed's | |
241 birthday (since the Islamic months are numbered from 1 starting with | |
242 Muharram), and Thomas Jefferson's birthday, which is 2 April 1743 on the | |
243 Julian calendar. | |
244 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
245 To include a holiday conditionally, use either Emacs Lisp's @code{if} or the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
246 @code{holiday-sexp} form. For example, American presidential elections |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
247 occur on the first Tuesday after the first Monday in November of years |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
248 divisible by 4: |
6387 | 249 |
250 @smallexample | |
251 (holiday-sexp (if (= 0 (% year 4)) | |
252 (calendar-gregorian-from-absolute | |
7688 | 253 (1+ (calendar-dayname-on-or-before |
254 1 (+ 6 (calendar-absolute-from-gregorian | |
255 (list 11 1 year)))))) | |
6387 | 256 "US Presidential Election")) |
257 @end smallexample | |
258 | |
259 @noindent | |
260 or | |
261 | |
262 @smallexample | |
263 (if (= 0 (% displayed-year 4)) | |
264 (fixed 11 | |
265 (extract-calendar-day | |
266 (calendar-gregorian-from-absolute | |
267 (1+ (calendar-dayname-on-or-before | |
268 1 (+ 6 (calendar-absolute-from-gregorian | |
269 (list 11 1 displayed-year))))))) | |
270 "US Presidential Election")) | |
271 @end smallexample | |
272 | |
273 Some holidays just don't fit into any of these forms because special | |
274 calculations are involved in their determination. In such cases you | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
275 must write a Lisp function to do the calculation. To include eclipses, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
276 for example, add @code{(eclipses)} to @code{other-holidays} |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
277 and write an Emacs Lisp function @code{eclipses} that returns a |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
278 (possibly empty) list of the relevant Gregorian dates among the range |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
279 visible in the calendar window, with descriptive strings, like this: |
6387 | 280 |
281 @smallexample | |
282 (((6 27 1991) "Lunar Eclipse") ((7 11 1991) "Solar Eclipse") ... ) | |
283 @end smallexample | |
284 | |
285 @node Date Display Format | |
286 @section Date Display Format | |
287 @vindex calendar-date-display-form | |
288 | |
7688 | 289 You can customize the manner of displaying dates in the diary, in mode |
290 lines, and in messages by setting @code{calendar-date-display-form}. | |
291 This variable holds a list of expressions that can involve the variables | |
292 @code{month}, @code{day}, and @code{year}, which are all numbers in | |
293 string form, and @code{monthname} and @code{dayname}, which are both | |
294 alphabetic strings. In the American style, the default value of this | |
295 list is as follows: | |
6387 | 296 |
297 @smallexample | |
298 ((if dayname (concat dayname ", ")) monthname " " day ", " year) | |
299 @end smallexample | |
300 | |
301 @noindent | |
302 while in the European style this value is the default: | |
303 | |
304 @smallexample | |
305 ((if dayname (concat dayname ", ")) day " " monthname " " year) | |
306 @end smallexample | |
307 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
308 @noindent |
6387 | 309 The ISO standard date representation is this: |
310 | |
311 @smallexample | |
312 (year "-" month "-" day) | |
313 @end smallexample | |
314 | |
315 @noindent | |
316 This specifies a typical American format: | |
317 | |
318 @smallexample | |
319 (month "/" day "/" (substring year -2)) | |
320 @end smallexample | |
321 | |
322 @node Time Display Format | |
323 @section Time Display Format | |
324 @vindex calendar-time-display-form | |
325 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
326 The calendar and diary by default display times of day in the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
327 conventional American style with the hours from 1 through 12, minutes, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
328 and either @samp{am} or @samp{pm}. If you prefer the European style, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
329 also known in the US as military, in which the hours go from 00 to 23, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
330 you can alter the variable @code{calendar-time-display-form}. This |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
331 variable is a list of expressions that can involve the variables |
7688 | 332 @code{12-hours}, @code{24-hours}, and @code{minutes}, which are all |
333 numbers in string form, and @code{am-pm} and @code{time-zone}, which are | |
334 both alphabetic strings. The default value of | |
335 @code{calendar-time-display-form} is as follows: | |
6387 | 336 |
337 @smallexample | |
338 (12-hours ":" minutes am-pm | |
339 (if time-zone " (") time-zone (if time-zone ")")) | |
340 @end smallexample | |
341 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
342 @noindent |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
343 Here is a value that provides European style times: |
6387 | 344 |
345 @smallexample | |
346 (24-hours ":" minutes | |
347 (if time-zone " (") time-zone (if time-zone ")")) | |
348 @end smallexample | |
349 | |
350 @node Daylight Savings | |
351 @section Daylight Savings Time | |
352 @cindex daylight savings time | |
353 | |
354 Emacs understands the difference between standard time and daylight | |
355 savings time---the times given for sunrise, sunset, solstices, | |
356 equinoxes, and the phases of the moon take that into account. The rules | |
357 for daylight savings time vary from place to place and have also varied | |
358 historically from year to year. To do the job properly, Emacs needs to | |
359 know which rules to use. | |
360 | |
361 Some operating systems keep track of the rules that apply to the place | |
362 where you are; on these systems, Emacs gets the information it needs | |
363 from the system automatically. If some or all of this information is | |
364 missing, Emacs fills in the gaps with the rules currently used in | |
7688 | 365 Cambridge, Massachusetts, which is the center of GNU's world. |
366 | |
6387 | 367 |
368 @vindex calendar-daylight-savings-starts | |
369 @vindex calendar-daylight-savings-ends | |
7688 | 370 If the default choice of rules is not appropriate for your location, |
371 you can tell Emacs the rules to use by setting the variables | |
372 @code{calendar-daylight-savings-starts} and | |
373 @code{calendar-daylight-savings-ends}. Their values should be Lisp | |
6387 | 374 expressions that refer to the variable @code{year}, and evaluate to the |
375 Gregorian date on which daylight savings time starts or (respectively) | |
376 ends, in the form of a list @code{(@var{month} @var{day} @var{year})}. | |
377 The values should be @code{nil} if your area does not use daylight | |
378 savings time. | |
379 | |
7688 | 380 Emacs uses these expressions to determine the start and end dates of |
381 daylight savings time as holidays and for correcting times of day in the | |
382 solar and lunar calculations. | |
6387 | 383 |
384 The values for Cambridge, Massachusetts are as follows: | |
385 | |
386 @example | |
387 @group | |
388 (calendar-nth-named-day 1 0 4 year) | |
389 (calendar-nth-named-day -1 0 10 year) | |
390 @end group | |
391 @end example | |
392 | |
393 @noindent | |
394 i.e., the first 0th day (Sunday) of the fourth month (April) in | |
395 the year specified by @code{year}, and the last Sunday of the tenth month | |
396 (October) of that year. If daylight savings time were | |
397 changed to start on October 1, you would set | |
398 @code{calendar-daylight-savings-starts} to this: | |
399 | |
400 @example | |
401 (list 10 1 year) | |
402 @end example | |
403 | |
404 For a more complex example, suppose daylight savings time begins on | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
405 the first of Nisan on the Hebrew calendar. You should set |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
406 @code{calendar-daylight-savings-starts} to this value: |
6387 | 407 |
408 @example | |
409 (calendar-gregorian-from-absolute | |
410 (calendar-absolute-from-hebrew | |
411 (list 1 1 (+ year 3760)))) | |
412 @end example | |
413 | |
414 @noindent | |
415 because Nisan is the first month in the Hebrew calendar and the Hebrew | |
416 year differs from the Gregorian year by 3760 at Nisan. | |
417 | |
418 If there is no daylight savings time at your location, or if you want | |
419 all times in standard time, set @code{calendar-daylight-savings-starts} | |
420 and @code{calendar-daylight-savings-ends} to @code{nil}. | |
421 | |
422 @vindex calendar-daylight-time-offset | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
423 The variable @code{calendar-daylight-time-offset} specifies the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
424 difference between daylight savings time and standard time, measured in |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
425 minutes. The value for Cambridge is 60. |
6387 | 426 |
427 @vindex calendar-daylight-savings-starts-time | |
428 @vindex calendar-daylight-savings-ends-time | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
429 The variable @code{calendar-daylight-savings-starts-time} and the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
430 variable @code{calendar-daylight-savings-ends-time} specify the number |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
431 of minutes after midnight local time when the transition to and from |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
432 daylight savings time should occur. For Cambridge, both variables' |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
433 values are 120. |
6387 | 434 |
435 @node Diary Customizing | |
436 @section Customizing the Diary | |
437 | |
438 @vindex holidays-in-diary-buffer | |
439 Ordinarily, the mode line of the diary buffer window indicates any | |
440 holidays that fall on the date of the diary entries. The process of | |
441 checking for holidays can take several seconds, so including holiday | |
442 information delays the display of the diary buffer noticeably. If you'd | |
443 prefer to have a faster display of the diary buffer but without the | |
444 holiday information, set the variable @code{holidays-in-diary-buffer} to | |
445 @code{nil}.@refill | |
446 | |
447 @vindex number-of-diary-entries | |
448 The variable @code{number-of-diary-entries} controls the number of | |
449 days of diary entries to be displayed at one time. It affects the | |
450 initial display when @code{view-diary-entries-initially} is @code{t}, as | |
451 well as the command @kbd{M-x diary}. For example, the default value is | |
452 1, which says to display only the current day's diary entries. If the | |
453 value is 2, both the current day's and the next day's entries are | |
7688 | 454 displayed. The value can also be a vector of seven elements: for |
455 example, if the value is @code{[0 2 2 2 2 4 1]} then no diary entries | |
456 appear on Sunday, the current date's and the next day's diary entries | |
457 appear Monday through Thursday, Friday through Monday's entries appear | |
458 on Friday, while on Saturday only that day's entries appear. | |
6387 | 459 |
460 @vindex print-diary-entries-hook | |
461 @findex print-diary-entries | |
462 The variable @code{print-diary-entries-hook} is a normal hook run | |
463 after preparation of a temporary buffer containing just the diary | |
464 entries currently visible in the diary buffer. (The other, irrelevant | |
465 diary entries are really absent from the temporary buffer; in the diary | |
466 buffer, they are merely hidden.) The default value of this hook does | |
467 the printing with the command @code{lpr-buffer}. If you want to use a | |
468 different command to do the printing, just change the value of this | |
469 hook. Other uses might include, for example, rearranging the lines into | |
470 order by day and time. | |
471 | |
472 @vindex diary-date-forms | |
473 You can customize the form of dates in your diary file, if neither the | |
474 standard American nor European styles suits your needs, by setting the | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
475 variable @code{diary-date-forms}. This variable is a list of patterns |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
476 for recognizing a date. Each date pattern is a list whose elements may |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
477 be regular expressions (@pxref{Regular Expressions}) or the symbols |
6387 | 478 @code{month}, @code{day}, @code{year}, @code{monthname}, and |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
479 @code{dayname}. All these elements serve as patterns that match certain |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
480 kinds of text in the diary file. In order for the date pattern, as a |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
481 whole, to match, all of its elements must match consecutively. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
482 |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
483 A regular expression in a date pattern matches in its usual fashion, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
484 using the standard syntax table altered so that @samp{*} is a word |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
485 constituent. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
486 |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
487 The symbols @code{month}, @code{day}, @code{year}, @code{monthname}, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
488 and @code{dayname} match the month number, day number, year number, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
489 month name, and day name of the date being considered. The symbols that |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
490 match numbers allow leading zeros; those that match names allow |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
491 three-letter abbreviations and capitalization. All the symbols can |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
492 match @samp{*}; since @samp{*} in a diary entry means ``any day'', ``any |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
493 month'', and so on, it should match regardless of the date being |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
494 considered. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
495 |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
496 The default value of @code{diary-date-forms} in the American style is |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
497 this: |
6387 | 498 |
499 @example | |
500 ((month "/" day "[^/0-9]") | |
501 (month "/" day "/" year "[^0-9]") | |
502 (monthname " *" day "[^,0-9]") | |
503 (monthname " *" day ", *" year "[^0-9]") | |
504 (dayname "\\W")) | |
505 @end example | |
506 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
507 The date patterns in the list must be @emph{mutually exclusive} and |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
508 must not match any portion of the diary entry itself, just the date and |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
509 one character of whitespace. If, to be mutually exclusive, the pattern |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
510 must match a portion of the diary entry text---beyond the whitespace |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
511 that ends the date---then the first element of the date pattern |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
512 @emph{must} be @code{backup}. This causes the date recognizer to back |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
513 up to the beginning of the current word of the diary entry, after |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
514 finishing the match. Even if you use @code{backup}, the date pattern |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
515 must absolutely not match more than a portion of the first word of the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
516 diary entry. The default value of @code{diary-date-forms} in the |
6387 | 517 European style is this list: |
518 | |
519 @example | |
520 ((day "/" month "[^/0-9]") | |
521 (day "/" month "/" year "[^0-9]") | |
522 (backup day " *" monthname "\\W+\\<[^*0-9]") | |
523 (day " *" monthname " *" year "[^0-9]") | |
524 (dayname "\\W")) | |
525 @end example | |
526 | |
527 @noindent | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
528 Notice the use of @code{backup} in the third pattern, because it needs |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
529 to match part of a word beyond the date itself to distinguish it from |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
530 the fourth pattern. |
6387 | 531 |
532 @node Hebrew/Islamic Entries | |
533 @section Hebrew- and Islamic-Date Diary Entries | |
534 | |
535 Your diary file can have entries based on Hebrew or Islamic dates, as | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
536 well as entries based on the world-standard Gregorian calendar. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
537 However, because recognition of such entries is time-consuming and most |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
538 people don't use them, you must explicitly enable their use. If you |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
539 want the diary to recognize Hebrew-date diary entries, for example, |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
540 you must do this: |
6387 | 541 |
542 @vindex nongregorian-diary-listing-hook | |
543 @vindex nongregorian-diary-marking-hook | |
544 @findex list-hebrew-diary-entries | |
545 @findex mark-hebrew-diary-entries | |
546 @smallexample | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
547 (add-hook 'nongregorian-diary-listing-hook 'list-hebrew-diary-entries) |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
548 (add-hook 'nongregorian-diary-marking-hook 'mark-hebrew-diary-entries) |
6387 | 549 @end smallexample |
550 | |
551 @noindent | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
552 If you want Islamic-date entries, do this: |
6387 | 553 |
554 @findex list-islamic-diary-entries | |
555 @findex mark-islamic-diary-entries | |
556 @smallexample | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
557 (add-hook 'nongregorian-diary-listing-hook 'list-islamic-diary-entries) |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
558 (add-hook 'nongregorian-diary-marking-hook 'mark-islamic-diary-entries) |
6387 | 559 @end smallexample |
560 | |
561 Hebrew- and Islamic-date diary entries have the same formats as | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
562 Gregorian-date diary entries, except that @samp{H} precedes a Hebrew |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
563 date and @samp{I} precedes an Islamic date. Moreover, because the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
564 Hebrew and Islamic month names are not uniquely specified by the first |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
565 three letters, you may not abbreviate them. For example, a diary entry |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
566 for the Hebrew date Heshvan 25 could look like this: |
6387 | 567 |
568 @smallexample | |
569 HHeshvan 25 Happy Hebrew birthday! | |
570 @end smallexample | |
571 | |
572 @noindent | |
573 and would appear in the diary for any date that corresponds to Heshvan 25 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
574 on the Hebrew calendar. And here is Islamic-date diary entry that matches |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
575 Dhu al-Qada 25: |
6387 | 576 |
577 @smallexample | |
578 IDhu al-Qada 25 Happy Islamic birthday! | |
579 @end smallexample | |
580 | |
581 As with Gregorian-date diary entries, Hebrew- and Islamic-date entries | |
582 are nonmarking if they are preceded with an ampersand (@samp{&}). | |
583 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
584 Here is a table of commands used in the calendar to create diary entries |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
585 that match the selected date and other dates that are similar in the Hebrew |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
586 or Islamic calendar: |
6387 | 587 |
588 @table @kbd | |
589 @item i h d | |
590 Add a diary entry for the Hebrew date corresponding to the selected date | |
591 (@code{insert-hebrew-diary-entry}). | |
592 @item i h m | |
593 Add a diary entry for the day of the Hebrew month corresponding to the | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
594 selected date (@code{insert-monthly-hebrew-diary-entry}). This diary |
7688 | 595 entry matches any date that has the same Hebrew day-within-month as the |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
596 selected date. |
6387 | 597 @item i h y |
598 Add a diary entry for the day of the Hebrew year corresponding to the | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
599 selected date (@code{insert-yearly-hebrew-diary-entry}). This diary |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
600 entry matches any date which has the same Hebrew month and day-within-month |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
601 as the selected date. |
6387 | 602 @item i i d |
603 Add a diary entry for the Islamic date corresponding to the selected date | |
604 (@code{insert-islamic-diary-entry}). | |
605 @item i i m | |
606 Add a diary entry for the day of the Islamic month corresponding to the | |
607 selected date (@code{insert-monthly-islamic-diary-entry}). | |
608 @item i i y | |
609 Add a diary entry for the day of the Islamic year corresponding to the | |
610 selected date (@code{insert-yearly-islamic-diary-entry}). | |
611 @end table | |
612 | |
613 @findex insert-hebrew-diary-entry | |
614 @findex insert-monthly-hebrew-diary-entry | |
615 @findex insert-yearly-hebrew-diary-entry | |
616 @findex insert-islamic-diary-entry | |
617 @findex insert-monthly-islamic-diary-entry | |
618 @findex insert-yearly-islamic-diary-entry | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
619 These commands work much like the corresponding commands for ordinary |
7688 | 620 diary entries: they apply to the date that point is on in the calendar |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
621 window, and what they do is insert just the date portion of a diary entry |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
622 at the end of your diary file. You must then insert the rest of the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
623 diary entry. |
6387 | 624 |
625 @node Fancy Diary Display | |
626 @section Fancy Diary Display | |
627 @vindex diary-display-hook | |
628 @findex simple-diary-display | |
629 | |
630 Diary display works by preparing the diary buffer and then running the | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
631 hook @code{diary-display-hook}. The default value of this hook |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
632 (@code{simple-diary-display}) hides the irrelevant diary entries and |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
633 then displays the buffer. However, if you specify the hook as follows, |
6387 | 634 |
635 @cindex diary buffer | |
636 @findex fancy-diary-display | |
637 @example | |
638 (add-hook 'diary-display-hook 'fancy-diary-display) | |
639 @end example | |
640 | |
641 @noindent | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
642 this enables fancy diary display. It displays diary entries and |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
643 holidays by copying them into a special buffer that exists only for the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
644 sake of display. Copying to a separate buffer provides an opportunity |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
645 to change the displayed text to make it prettier---for example, to sort |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
646 the entries by the dates they apply to. |
6387 | 647 |
648 As with simple diary display, you can print a hard copy of the buffer | |
649 with @code{print-diary-entries}. To print a hard copy of a day-by-day | |
650 diary for a week by positioning point on Sunday of that week, type | |
651 @kbd{7 d} and then do @kbd{M-x print-diary-entries}. As usual, the | |
652 inclusion of the holidays slows down the display slightly; you can speed | |
653 things up by setting the variable @code{holidays-in-diary-buffer} to | |
654 @code{nil}. | |
655 | |
656 @vindex diary-list-include-blanks | |
657 Ordinarily, the fancy diary buffer does not show days for which there are | |
658 no diary entries, even if that day is a holiday. If you want such days to be | |
659 shown in the fancy diary buffer, set the variable | |
660 @code{diary-list-include-blanks} to @code{t}.@refill | |
661 | |
662 @cindex sorting diary entries | |
663 If you use the fancy diary display, you can use the normal hook | |
664 @code{list-diary-entries-hook} to sort each day's diary entries by their | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
665 time of day. Here's how |
6387 | 666 |
667 @findex sort-diary-entries | |
668 @example | |
669 (add-hook 'list-diary-entries-hook 'sort-diary-entries) | |
670 @end example | |
671 | |
672 @noindent | |
673 For each day, this sorts diary entries that begin with a recognizable | |
674 time of day according to their times. Diary entries without times come | |
675 first within each day. | |
676 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
677 Fancy diary display also has the ability to process included diary |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
678 files. This permits a group of people to share a diary file for events |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
679 that apply to all of them. Lines in the diary file of this form: |
6387 | 680 |
681 @smallexample | |
682 #include "@var{filename}" | |
683 @end smallexample | |
684 | |
685 @noindent | |
686 includes the diary entries from the file @var{filename} in the fancy | |
7688 | 687 diary buffer. The include mechanism is recursive, so that included files |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
688 can include other files, and so on; you must be careful not to have a |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
689 cycle of inclusions, of course. Here is how to enable the include |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
690 facility: |
6387 | 691 |
692 @vindex list-diary-entries-hook | |
693 @vindex mark-diary-entries-hook | |
694 @findex include-other-diary-files | |
695 @findex mark-included-diary-files | |
696 @smallexample | |
697 (add-hook 'list-diary-entries-hook 'include-other-diary-files) | |
698 (add-hook 'mark-diary-entries-hook 'mark-included-diary-files) | |
699 @end smallexample | |
700 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
701 The include mechanism works only with the fancy diary display, because |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
702 ordinary diary display shows the entries directly from your diary file. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
703 |
6387 | 704 @node Sexp Diary Entries |
705 @section Sexp Entries and the Fancy Diary Display | |
706 @cindex sexp diary entries | |
707 | |
708 Sexp diary entries allow you to do more than just have complicated | |
709 conditions under which a diary entry applies. If you use the fancy | |
710 diary display, sexp entries can generate the text of the entry depending | |
711 on the date itself. For example, an anniversary diary entry can insert | |
712 the number of years since the anniversary date into the text of the | |
713 diary entry. Thus the @samp{%d} in this dairy entry: | |
714 | |
715 @findex diary-anniversary | |
716 @smallexample | |
717 %%(diary-anniversary 10 31 1948) Arthur's birthday (%d years old) | |
718 @end smallexample | |
719 | |
720 @noindent | |
721 gets replaced by the age, so on October 31, 1990 the entry appears in | |
722 the fancy diary buffer like this: | |
723 | |
724 @smallexample | |
725 Arthur's birthday (42 years old) | |
726 @end smallexample | |
727 | |
728 @noindent | |
729 If the diary file instead contains this entry: | |
730 | |
731 @smallexample | |
732 %%(diary-anniversary 10 31 1948) Arthur's %d%s birthday | |
733 @end smallexample | |
734 | |
735 @noindent | |
736 the entry in the fancy diary buffer for October 31, 1990 appears like this: | |
737 | |
738 @smallexample | |
739 Arthur's 42nd birthday | |
740 @end smallexample | |
741 | |
742 Similarly, cyclic diary entries can interpolate the number of repetitions | |
743 that have occurred: | |
744 | |
745 @findex diary-cyclic | |
746 @smallexample | |
747 %%(diary-cyclic 50 1 1 1990) Renew medication (%d%s time) | |
748 @end smallexample | |
749 | |
750 @noindent | |
751 looks like this: | |
752 | |
753 @smallexample | |
754 Renew medication (5th time) | |
755 @end smallexample | |
756 | |
757 @noindent | |
758 in the fancy diary display on September 8, 1990. | |
759 | |
760 The generality of sexp diary entries lets you specify any diary entry | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
761 that you can describe algorithmically. A sexp diary entry contains an |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
762 expression that computes whether the entry applies to any given date. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
763 If its value is non-@code{nil}, the entry applies to that date; |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
764 otherwise, it does not. The expression can use the variable @code{date} |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
765 to find the date being considered; its value is a list (@var{month} |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
766 @var{day} @var{year}) that refers to the Gregorian calendar. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
767 |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
768 Suppose you get paid on the 21st of the month if it is a weekday, and |
7688 | 769 on the Friday before if the 21st is on a weekend. Here is how to write |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
770 a sexp diary entry that matches those dates: |
6387 | 771 |
772 @smallexample | |
773 &%%(let ((dayname (calendar-day-of-week date)) | |
774 (day (car (cdr date)))) | |
775 (or (and (= day 21) (memq dayname '(1 2 3 4 5))) | |
776 (and (memq day '(19 20)) (= dayname 5))) | |
777 ) Pay check deposited | |
778 @end smallexample | |
779 | |
780 The following sexp diary entries take advantage of the ability (in the fancy | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
781 diary display) to concoct diary entries whose text varies based on the date: |
6387 | 782 |
783 @findex diary-sunrise-sunset | |
784 @findex diary-phases-of-moon | |
785 @findex diary-day-of-year | |
786 @findex diary-iso-date | |
787 @findex diary-julian-date | |
788 @findex diary-astro-day-number | |
789 @findex diary-hebrew-date | |
790 @findex diary-islamic-date | |
791 @findex diary-french-date | |
792 @findex diary-mayan-date | |
793 @table @code | |
794 @item %%(diary-sunrise-sunset) | |
795 Make a diary entry for the local times of today's sunrise and sunset. | |
796 @item %%(diary-phases-of-moon) | |
797 Make a diary entry for the phases (quarters) of the moon. | |
798 @item %%(diary-day-of-year) | |
799 Make a diary entry with today's day number in the current year and the number | |
800 of days remaining in the current year. | |
801 @item %%(diary-iso-date) | |
802 Make a diary entry with today's equivalent ISO commercial date. | |
803 @item %%(diary-julian-date) | |
804 Make a diary entry with today's equivalent date on the Julian calendar. | |
805 @item %%(diary-astro-day-number) | |
806 Make a diary entry with today's equivalent astronomical (Julian) day number. | |
807 @item %%(diary-hebrew-date) | |
808 Make a diary entry with today's equivalent date on the Hebrew calendar. | |
809 @item %%(diary-islamic-date) | |
810 Make a diary entry with today's equivalent date on the Islamic calendar. | |
811 @item %%(diary-french-date) | |
812 Make a diary entry with today's equivalent date on the French Revolutionary | |
813 calendar. | |
814 @item %%(diary-mayan-date) | |
815 Make a diary entry with today's equivalent date on the Mayan calendar. | |
816 @end table | |
817 | |
818 @noindent | |
819 Thus including the diary entry | |
820 | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
821 @example |
6387 | 822 &%%(diary-hebrew-date) |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
823 @end example |
6387 | 824 |
825 @noindent | |
826 causes every day's diary display to contain the equivalent date on the | |
827 Hebrew calendar, if you are using the fancy diary display. (With simple | |
828 diary display, the line @samp{&%%(diary-hebrew-date)} appears in the | |
829 diary for any date, but does nothing particularly useful.) | |
830 | |
7688 | 831 These functions can be used to construct sexp diary entries based on |
832 the Hebrew calendar in certain standard ways: | |
6387 | 833 |
834 @cindex rosh hodesh | |
835 @findex diary-rosh-hodesh | |
836 @cindex parasha, weekly | |
837 @findex diary-parasha | |
838 @cindex candle lighting times | |
839 @findex diary-sabbath-candles | |
840 @cindex omer count | |
841 @findex diary-omer | |
842 @cindex yahrzeits | |
843 @findex diary-yahrzeit | |
844 @table @code | |
845 @item %%(diary-rosh-hodesh) | |
846 Make a diary entry that tells the occurrence and ritual announcement of each | |
847 new Hebrew month. | |
848 @item %%(diary-parasha) | |
849 Make a Saturday diary entry that tells the weekly synagogue scripture reading. | |
850 @item %%(diary-sabbath-candles) | |
851 Make a Friday diary entry that tells the @emph{local time} of Sabbath | |
852 candle lighting. | |
853 @item %%(diary-omer) | |
854 Make a diary entry that gives the omer count, when appropriate. | |
855 @item %%(diary-yahrzeit @var{month} @var{day} @var{year}) @var{name} | |
856 Make a diary entry marking the anniversary of a date of death. The date | |
857 is the @emph{Gregorian} (civil) date of death. The diary entry appears | |
858 on the proper Hebrew calendar anniversary and on the day before. (In | |
859 the European style, the order of the parameters is changed to @var{day}, | |
860 @var{month}, @var{year}.) | |
861 @end table | |
862 | |
863 @node Appt Customizing | |
864 @section Customizing Appointment Reminders | |
865 | |
7688 | 866 You can specify exactly how Emacs reminds you of an appointment, and |
867 how far in advance it begins doing so, by setting these variables: | |
6387 | 868 |
869 @vindex appt-message-warning-time | |
870 @vindex appt-audible | |
871 @vindex appt-visible | |
872 @vindex appt-display-mode-line | |
873 @vindex appt-msg-window | |
874 @vindex appt-display-duration | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
875 @vindex appt-disp-window-function |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
876 @vindex appt-delete-window-function |
6387 | 877 @table @code |
878 @item appt-message-warning-time | |
879 The time in minutes before an appointment that the reminder begins. The | |
880 default is 10 minutes. | |
881 @item appt-audible | |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
882 If this is non-@code{nil}, Emacs rings the |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
883 terminal bell for appointment reminders. The default is @code{t}. |
6387 | 884 @item appt-visible |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
885 If this is non-@code{nil}, Emacs displays the appointment |
7688 | 886 message in the echo area. The default is @code{t}. |
6387 | 887 @item appt-display-mode-line |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
888 If this is non-@code{nil}, Emacs displays the number of minutes |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
889 to the appointment on the mode line. The default is @code{t}. |
6387 | 890 @item appt-msg-window |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
891 If this is non-@code{nil}, Emacs displays the appointment |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
892 message in another window. The default is @code{t}. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
893 @item appt-disp-window-function |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
894 This variable holds a function to use to create the other window |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
895 for the appointment message. |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
896 @item appt-delete-window-function |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
897 This variable holds a function to use to get rid of the appointment |
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
898 message window, when its time is up. |
6387 | 899 @item appt-display-duration |
7401
afe506bf7264
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6387
diff
changeset
|
900 The number of seconds to display an appointment message. The default |
6387 | 901 is 5 seconds. |
902 @end table |