annotate lispref/calendar.texi @ 13715:89ffc133f813

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