cal-xtra.texi 35.5 KB
Newer Older
1 2
@c This is part of the Emacs manual.  -*- coding: iso-latin-1 -*-
@c Copyright (C) 2004-2012 Free Software Foundation, Inc.
Eli Zaretskii's avatar
Eli Zaretskii committed
3 4
@c See file emacs.texi for copying conditions.
5 6 7 8 9
@c This file is included either in emacs-xtra.texi (when producing the
@c printed version) or in the main Emacs manual (for the on-line version).

@c Moved here from the Emacs Lisp Reference Manual, 2005-03-26.
@node Advanced Calendar/Diary Usage
@section More advanced features of the Calendar and Diary

12 13 14 15
  This section describes some of the more advanced/specialized
features of the calendar and diary.  It starts with some of the
many ways in which you can customize the calendar and diary to suit
your personal tastes.
16 17

* Calendar Customizing::   Calendar layout and hooks.
19 20 21 22
* Holiday Customizing::    Defining your own holidays.
* Date Display Format::    Changing the format.
* Time Display Format::    Changing the format.
* Diary Customizing::      Defaults you can set.
* Non-Gregorian Diary::    Diary entries based on other calendars.
24 25 26
* Diary Display::          A choice of ways to display the diary.
* Fancy Diary Display::    Sorting diary entries, using included diary files.
* Sexp Diary Entries::     More flexible diary entries.
27 28 29 30
@end menu

@node Calendar Customizing
@subsection Customizing the Calendar
31 32 33

@vindex calendar-intermonth-text
@cindex calendar layout
34 35 36 37
@cindex calendar week numbers
  The calendar display unfortunately cannot be changed from three
months, but you can customize the whitespace used by setting the
variables: @code{calendar-left-margin},
38 39
@code{calendar-day-header-width}, @code{calendar-day-digit-width},
@code{calendar-column-width}, and @code{calendar-intermonth-spacing}.
40 41 42
To display text @emph{between} the months, for example week numbers,
customize the variables @code{calendar-intermonth-header} and
@code{calendar-intermonth-text} as described in their documentation.

Glenn Morris's avatar
Glenn Morris committed
44 45 46 47 48
@vindex calendar-month-header
  The variable @code{calendar-month-header} controls the text that
appears above each month in the calendar.  By default, it shows the
month and year.

49 50
@vindex calendar-holiday-marker
@vindex diary-entry-marker
Paul Eggert's avatar
Paul Eggert committed
@vindex calendar-today-marker
  The variable @code{calendar-holiday-marker} specifies how to mark a
date that is a holiday.  Its value may be a single-character string to
54 55
insert next to the date, or a face name to use for displaying the date.
Likewise, the variable @code{diary-entry-marker} specifies how to mark a
56 57 58
date that has diary entries.  The function @code{calendar-mark-today}
uses @code{calendar-today-marker} to mark today's date.  By default,
the calendar uses faces named @code{holiday}, @code{diary}, and
@code{calendar-today} for these purposes.
60 61 62 63 64 65

@vindex calendar-load-hook
  The variable @code{calendar-load-hook} is a normal hook run when the
calendar package is first loaded (before actually starting to display
the calendar).

@vindex calendar-initial-window-hook
  Starting the calendar runs the normal hook
@code{calendar-initial-window-hook}.  Recomputation of the calendar
69 70 71
display does not run this hook.  But if you leave the calendar with the
@kbd{q} command and reenter it, the hook runs again.@refill

@vindex calendar-today-visible-hook
@findex calendar-star-date
  The variable @code{calendar-today-visible-hook} is a normal hook run
after the calendar buffer has been prepared with the calendar, when the
current date is visible in the window.  One use of this hook is to
77 78
mark today's date; to do that use either of the functions
@code{calendar-mark-today} or @code{calendar-star-date}:
79 80

@findex calendar-mark-today
(add-hook 'calendar-today-visible-hook 'calendar-mark-today)
@end smallexample

@vindex calendar-today-invisible-hook
  A similar normal hook, @code{calendar-today-invisible-hook} is run if
88 89 90 91 92 93 94 95 96 97
the current date is @emph{not} visible in the window.

@vindex calendar-move-hook
  Each of the calendar cursor motion commands runs the hook
@code{calendar-move-hook} after it moves the cursor.

@node Holiday Customizing
@subsection Customizing the Holidays

@vindex calendar-holidays
98 99
@vindex holiday-oriental-holidays
@vindex holiday-solar-holidays
100 101 102 103 104 105 106 107
  There are several variables listing the default holidays that Emacs
knows about.  These are: @code{holiday-general-holidays},
@code{holiday-local-holidays}, @code{holiday-solar-holidays},
@code{holiday-bahai-holidays}, @code{holiday-christian-holidays},
@code{holiday-hebrew-holidays}, @code{holiday-islamic-holidays},
@code{holiday-oriental-holidays}, and @code{holiday-other-holidays}.
The names should be self-explanatory; e.g.@: @code{holiday-solar-holidays}
lists sun- and moon-related holidays.

109 110
You can customize these lists of holidays to your own needs, deleting or
adding holidays as described below.  Set any of them to @code{nil} to
not show the associated holidays.

113 114
@vindex holiday-general-holidays
@vindex holiday-local-holidays
115 116 117 118 119 120
@vindex holiday-other-holidays
  The general holidays are, by default, holidays common throughout the
United States.  In contrast, @code{holiday-local-holidays} and
@code{holiday-other-holidays} are both empty by default.  These are
intended for system-wide settings and your individual use,

122 123 124 125
@vindex holiday-bahai-holidays
@vindex holiday-christian-holidays
@vindex holiday-hebrew-holidays
@vindex holiday-islamic-holidays
126 127 128 129
@vindex calendar-bahai-all-holidays-flag
@vindex calendar-christian-all-holidays-flag
@vindex calendar-hebrew-all-holidays-flag
@vindex calendar-islamic-all-holidays-flag
130 131 132
  By default, Emacs does not include all the holidays of the religions
that it knows, only those commonly found in secular calendars.  For a
more extensive collection of religious holidays, you can set any (or
133 134 135
all) of the variables @code{calendar-bahai-all-holidays-flag},
@code{calendar-hebrew-all-holidays-flag}, or
@code{calendar-islamic-all-holidays-flag} to @code{t}.
137 138

@cindex holiday forms
  Each of the holiday variables is a list of @dfn{holiday forms}, each
140 141 142 143 144
form describing a holiday (or sometimes a list of holidays).  Here is
a table of the possible kinds of holiday form.  Day numbers and month
numbers count starting from 1, but ``dayname'' numbers count Sunday as
0.  The argument @var{string} is always the description of the
holiday, as a string.
145 146 147 148 149

@table @code
@item (holiday-fixed @var{month} @var{day} @var{string})
A fixed date on the Gregorian calendar.

150 151 152 153 154 155
@item (holiday-float @var{month} @var{dayname} @var{k} @var{string}
      &optional @var{day})
The @var{k}th @var{dayname} (@var{dayname}=0 for Sunday, and so on)
after or before Gregorian date @var{month}, @var{day}.  Negative @var{k}
means count back from the end of the month.  Optional @var{day} defaults
to 1 if @var{k} is positive, and the last day of @var{month} otherwise.

157 158 159
@item (holiday-chinese @var{month} @var{day} @var{string})
A fixed date on the Chinese calendar.

160 161 162 163 164 165 166 167 168 169 170 171
@item (holiday-hebrew @var{month} @var{day} @var{string})
A fixed date on the Hebrew calendar.

@item (holiday-islamic @var{month} @var{day} @var{string})
A fixed date on the Islamic calendar.

@item (holiday-julian @var{month} @var{day} @var{string})
A fixed date on the Julian calendar.

@item (holiday-sexp @var{sexp} @var{string})
A date calculated by the Lisp expression @var{sexp}.  The expression
should use the variable @code{year} to compute and return the date of a
172 173
holiday in the form of a list @code{(@var{month} @var{day} @var{year})},
or @code{nil} if the holiday doesn't happen this year.
174 175 176 177 178 179 180 181 182 183

@item (if @var{condition} @var{holiday-form})
A holiday that happens only if @var{condition} is true.

@item (@var{function} @r{[}@var{args}@r{]})
A list of dates calculated by the function @var{function}, called with
arguments @var{args}.
@end table

  For example, suppose you want to add Bastille Day, celebrated in
184 185
France on July 14 (i.e., the fourteenth day of the seventh month).  You
can do this as follows:
186 187

(setq holiday-other-holidays '((holiday-fixed 7 14 "Bastille Day")))
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
@end smallexample

  Many holidays occur on a specific day of the week, at a specific time
of month.  Here is a holiday form describing Hurricane Supplication Day,
celebrated in the Virgin Islands on the fourth Monday in August:

(holiday-float 8 1 4 "Hurricane Supplication Day")
@end smallexample

Here the 8 specifies August, the 1 specifies Monday (Sunday is 0,
Tuesday is 2, and so on), and the 4 specifies the fourth occurrence in
the month (1 specifies the first occurrence, 2 the second occurrence,
@minus{}1 the last occurrence, @minus{}2 the second-to-last occurrence, and
so on).

  You can specify holidays that occur on fixed days of the Bahá'í,
Chinese, Hebrew, Islamic, and Julian calendars too.  For example,
208 209

(setq holiday-other-holidays
211 212 213 214 215 216 217 218 219 220 221 222
      '((holiday-hebrew 10 2 "Last day of Hanukkah")
        (holiday-islamic 3 12 "Mohammed's Birthday")
        (holiday-julian 4 2 "Jefferson's Birthday")))
@end smallexample

adds the last day of Hanukkah (since the Hebrew months are numbered with
1 starting from Nisan), the Islamic feast celebrating Mohammed's
birthday (since the Islamic months are numbered from 1 starting with
Muharram), and Thomas Jefferson's birthday, which is 2 April 1743 on the
Julian calendar.

223 224 225 226
  To include a holiday conditionally, use either Emacs Lisp's @code{if}
or the @code{holiday-sexp} form.  For example, American presidential
elections occur on the first Tuesday after the first Monday in November
of years divisible by 4:
227 228

(holiday-sexp '(if (zerop (% year 4))
230 231 232 233 234 235 236 237 238 239 240
                    (1+ (calendar-dayname-on-or-before
                          1 (+ 6 (calendar-absolute-from-gregorian
                                  (list 11 1 year)))))))
              "US Presidential Election")
@end smallexample


241 242
(if (zerop (% displayed-year 4))
    (holiday-fixed 11
244 245 246 247 248 249 250 251 252 253
               (1+ (calendar-dayname-on-or-before
                     1 (+ 6 (calendar-absolute-from-gregorian
                              (list 11 1 displayed-year)))))))
           "US Presidential Election"))
@end smallexample

  Some holidays just don't fit into any of these forms because special
calculations are involved in their determination.  In such cases you
must write a Lisp function to do the calculation.  To include eclipses,
for example, add @code{(eclipses)} to @code{holiday-other-holidays}
255 256 257 258 259
and write an Emacs Lisp function @code{eclipses} that returns a
(possibly empty) list of the relevant Gregorian dates among the range
visible in the calendar window, with descriptive strings, like this:

(((6 4 2012) "Lunar Eclipse") ((11 13 2012) "Solar Eclipse") ... )
261 262 263 264 265 266
@end smallexample

@node Date Display Format
@subsection Date Display Format
@vindex calendar-date-display-form

267 268
  You can customize the way dates are displayed in the diary, mode
lines, and messages by setting @code{calendar-date-display-form}.
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
This variable holds a list of expressions that can involve the variables
@code{month}, @code{day}, and @code{year}, which are all numbers in
string form, and @code{monthname} and @code{dayname}, which are both
alphabetic strings.  In the American style, the default value of this
list is as follows:

((if dayname (concat dayname ", ")) monthname " " day ", " year)
@end smallexample

while in the European style this value is the default:

((if dayname (concat dayname ", ")) day " " monthname " " year)
@end smallexample

The default ISO date representation is:
288 289

290 291
((format "%s-%.2d-%.2d" year (string-to-number month)
         (string-to-number day)))
292 293 294
@end smallexample

Another typical American format is:
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312

(month "/" day "/" (substring year -2))
@end smallexample

@node Time Display Format
@subsection Time Display Format
@vindex calendar-time-display-form

  The calendar and diary by default display times of day in the
conventional American style with the hours from 1 through 12, minutes,
and either @samp{am} or @samp{pm}.  If you prefer the European style,
also known in the US as military, in which the hours go from 00 to 23,
you can alter the variable @code{calendar-time-display-form}.  This
variable is a list of expressions that can involve the variables
@code{12-hours}, @code{24-hours}, and @code{minutes}, which are all
numbers in string form, and @code{am-pm} and @code{time-zone}, which are
both alphabetic strings.  The default value is:
314 315 316 317 318 319 320 321 322 323 324 325 326 327

(12-hours ":" minutes am-pm
          (if time-zone " (") time-zone (if time-zone ")"))
@end smallexample

Here is a value that provides European style times:

(24-hours ":" minutes
          (if time-zone " (") time-zone (if time-zone ")"))
@end smallexample

328 329 330
Note that few calendar functions return a time of day (at present, only
solar functions).

331 332 333
@node Diary Customizing
@subsection Customizing the Diary

@vindex diary-show-holidays-flag
335 336 337 338 339
  Ordinarily, the diary window indicates any holidays that fall on the
date of the diary entries, either in the mode line or the buffer itself.
The process of checking for holidays can be slow, depending on the
defined holidays.  In that case, setting @code{diary-show-holidays-flag}
to @code{nil} will speed up the diary display.

341 342
@vindex diary-number-of-entries
  The variable @code{diary-number-of-entries} controls the number of
days of diary entries to be displayed at one time.  It affects the
initial display when @code{calendar-view-diary-initially-flag} is
345 346 347 348 349 350 351 352
@code{t}, as well as the command @kbd{M-x diary}.  For example, a value
of 1 (the default) displays only the current day's diary entries,
whereas a value of 2 will also show the next day's entries.  The value
can also be a vector of seven integers: for example, if the value is
@code{[0 2 2 2 2 4 1]} then no diary entries appear on Sunday, the
current date's and the next day's diary entries appear Monday through
Thursday, Friday through Monday's entries appear on Friday, while on
Saturday only that day's entries appear.

@vindex diary-date-forms
  You can customize the form of dates in your diary file by setting the
356 357 358 359 360 361
variable @code{diary-date-forms}.  This variable is a list of patterns
for recognizing a date.  Each date pattern is a list whose elements may
be regular expressions (@pxref{Regular Expressions,,, elisp, the Emacs
Lisp Reference Manual}) or the symbols @code{month}, @code{day},
@code{year}, @code{monthname}, and @code{dayname}.  All these elements
serve as patterns that match certain kinds of text in the diary file.
In order for the date pattern as a whole to match, all of its elements
363 364 365 366 367 368 369 370 371 372
must match consecutively.

  A regular expression in a date pattern matches in its usual fashion,
using the standard syntax table altered so that @samp{*} is a word

  The symbols @code{month}, @code{day}, @code{year}, @code{monthname},
and @code{dayname} match the month number, day number, year number,
month name, and day name of the date being considered.  The symbols that
match numbers allow leading zeros; those that match names allow
373 374 375 376 377
capitalization and abbreviation (as specified by
@code{calendar-month-abbrev-array} and
@code{calendar-day-abbrev-array}).  All the symbols can match @samp{*};
since @samp{*} in a diary entry means ``any day'', ``any month'', and so
on, it should match regardless of the date being considered.
378 379

  The default value of @code{diary-date-forms} in the American style is
provided by @code{diary-american-date-forms}:
381 382 383 384 385 386 387 388 389

((month "/" day "[^/0-9]")
 (month "/" day "/" year "[^0-9]")
 (monthname " *" day "[^,0-9]")
 (monthname " *" day ", *" year "[^0-9]")
 (dayname "\\W"))
@end example

391 392
The variables @code{diary-european-date-forms} and
@code{diary-iso-date-forms} provide other default styles.

394 395 396 397 398 399 400 401 402
  The date patterns in the list must be @emph{mutually exclusive} and
must not match any portion of the diary entry itself, just the date and
one character of whitespace.  If, to be mutually exclusive, the pattern
must match a portion of the diary entry text---beyond the whitespace
that ends the date---then the first element of the date pattern
@emph{must} be @code{backup}.  This causes the date recognizer to back
up to the beginning of the current word of the diary entry, after
finishing the match.  Even if you use @code{backup}, the date pattern
must absolutely not match more than a portion of the first word of the
403 404
diary entry.  For example, the default value of
@code{diary-european-date-forms} is:
405 406 407 408

((day "/" month "[^/0-9]")
 (day "/" month "/" year "[^0-9]")
 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
410 411 412 413 414 415 416 417 418
 (day " *" monthname " *" year "[^0-9]")
 (dayname "\\W"))
@end example

Notice the use of @code{backup} in the third pattern, because it needs
to match part of a word beyond the date itself to distinguish it from
the fourth pattern.

@node Non-Gregorian Diary
@subsection Diary Entries Using non-Gregorian Calendars

  As well as entries based on the standard Gregorian calendar, your
diary can have entries based on Bahá'í, Hebrew, or Islamic dates.
424 425 426 427
Recognition of such entries can be time-consuming, however, and since
most people don't use them, you must explicitly enable their use.  If
you want the diary to recognize Hebrew-date diary entries, for example,
you must do this:
428 429 430 431 432

@vindex diary-nongregorian-listing-hook
@vindex diary-nongregorian-marking-hook
@findex diary-hebrew-list-entries
@findex diary-hebrew-mark-entries
433 434 435 436
@findex diary-islamic-list-entries
@findex diary-islamic-mark-entries
@findex diary-bahai-list-entries
@findex diary-bahai-mark-entries
438 439
(add-hook 'diary-nongregorian-listing-hook 'diary-hebrew-list-entries)
(add-hook 'diary-nongregorian-marking-hook 'diary-hebrew-mark-entries)
440 441 442
@end smallexample

Similarly, for Islamic and Bahá'í entries, add
444 445 446 447 448 449 450 451
@code{diary-islamic-list-entries} and @code{diary-islamic-mark-entries}, or
@code{diary-bahai-list-entries} and @code{diary-bahai-mark-entries}.

@vindex diary-bahai-entry-symbol
@vindex diary-hebrew-entry-symbol
@vindex diary-islamic-entry-symbol
  These diary entries have the same formats as Gregorian-date diary
entries; except that @code{diary-bahai-entry-symbol} (default @samp{B})
must precede a Bahá'í date, @code{diary-hebrew-entry-symbol} (default
453 454 455
@samp{H}) a Hebrew date, and @code{diary-islamic-entry-symbol} (default
@samp{I}) an Islamic date.  Moreover, non-Gregorian month names may not
be abbreviated (because the first three letters are often not unique).
456 457 458
(Note also that you must use ``Adar I'' if you want Adar of a common
Hebrew year.)  For example, a diary entry for the Hebrew date Heshvan 25
could look like this:
459 460 461 462 463 464 465 466 467 468 469 470 471 472

HHeshvan 25 Happy Hebrew birthday!
@end smallexample

and would appear in the diary for any date that corresponds to Heshvan 25
on the Hebrew calendar.  And here is an Islamic-date diary entry that matches
Dhu al-Qada 25:

IDhu al-Qada 25 Happy Islamic birthday!
@end smallexample

473 474 475
  As with Gregorian-date diary entries, non-Gregorian entries are
nonmarking if preceded by @code{diary-nonmarking-symbol} (default

477 478
  Here is a table of commands used in the calendar to create diary
entries that match the selected date and other dates that are similar in
the Bahá'í, Hebrew, or Islamic calendars:
480 481 482

@table @kbd
@item i h d
@item i h m
@item i h y
@item i i d
@item i i m
@item i i y
493 494 495 496 497 498 499
@item i B d
@item i B m
@item i B y
500 501
@end table

502 503 504 505 506 507
@findex diary-hebrew-insert-entry
@findex diary-hebrew-insert-monthly-entry
@findex diary-hebrew-insert-yearly-entry
@findex diary-islamic-insert-entry
@findex diary-islamic-insert-monthly-entry
@findex diary-islamic-insert-yearly-entry
508 509 510
@findex diary-bahai-insert-entry
@findex diary-bahai-insert-monthly-entry
@findex diary-bahai-insert-yearly-entry
511 512
  These commands work much like the corresponding commands for ordinary
diary entries: they apply to the date that point is on in the calendar
513 514 515 516 517 518
window, and what they do is insert just the date portion of a diary
entry at the end of your diary file.  You must then insert the rest of
the diary entry.  The basic commands add an entry for the specific
non-Gregorian date, the @samp{monthly} commands for the given
non-Gregorian day-within-month in every month, and the @samp{yearly}
commands for the given non-Gregorian day and month in every year.

520 521
@node Diary Display
@subsection Diary Display
@vindex diary-display-function
@findex diary-simple-display
524 525
@findex diary-fancy-display
@cindex diary buffer

527 528 529
  Diary display works by preparing the list of diary entries and then
running the function specified by the variable
@code{diary-display-function}.  The default value
530 531
@code{diary-fancy-display} displays diary entries and holidays by
copying them into a special buffer that exists only for the sake of
532 533 534
display.  Copying diary entries to a separate buffer provides an
opportunity to change the displayed text to make it prettier---for
example, to sort the entries by the dates they apply to.
535 536

@vindex diary-list-include-blanks
537 538 539
  Ordinarily, the fancy diary buffer does not show days for which there
are no diary entries, even if that day is a holiday.  If you want such
days to be shown in the fancy diary buffer, set the variable
540 541
@code{diary-list-include-blanks} to @code{t}.@refill

542 543 544 545 546 547 548
  The fancy diary buffer enables View mode
(@pxref{View Mode,,, emacs, the Emacs Manual}).
@end iftex
(@pxref{View Mode}).
@end ifnottex
549 550 551 552 553 554 555 556 557 558 559

  The alternative display method @code{diary-simple-display} shows the
actual diary buffer, and uses invisible text to hide entries that don't
apply.  Holidays are shown in the mode line.  The advantage of this
method is that you can edit the buffer and save your changes directly to
the diary file.  This method is not as flexible as the fancy method,
however.  For example, it cannot sort entries.  Another disadvantage is
that invisible text can be confusing.  For example, if you copy a region
of text in order to paste it elsewhere, invisible text may be included.
Similarly, since the diary buffer as you see it is an illusion, simply
printing the buffer may not print what you see on your screen.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578

@vindex diary-print-entries-hook
@findex diary-print-entries
  For this reason, there is a special command to print hard copy of the
diary buffer @emph{as it appears}; this command is @kbd{M-x
diary-print-entries}.  It works with either display method, although
with the fancy display you can also print the buffer like any other.  To
print a hard copy of a day-by-day diary for a week, position point on
the first day of the week, type @kbd{7 d}, and then do @kbd{M-x
diary-print-entries}.  As usual, the inclusion of the holidays slows
down the display slightly; you can speed things up by setting the
variable @code{diary-show-holidays-flag} to @code{nil}.

  This command prepares a temporary buffer that contains only the diary
entries currently visible in the diary buffer.  Unlike with the simple
display, the other irrelevant entries are really absent, not just
hidden.  After preparing the buffer, it runs the hook
@code{diary-print-entries-hook}.  The default value of this hook sends
the data directly to the printer with the command @code{lpr-buffer}
579 580 581 582 583 584 585
(@pxref{Printing,,, emacs, the Emacs Manual}).
@end iftex
@end ifnottex
If you want to use a different command to do the
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
printing, just change the value of this hook.  Other uses might include,
for example, rearranging the lines into order by day and time.

  You can edit the diary entries as they appear in the simple diary
window, but it is important to remember that the buffer displayed
contains the @emph{entire} diary file, with portions of it concealed
from view.  This means, for instance, that the @kbd{C-f}
(@code{forward-char}) command can put point at what appears to be the
end of the line, but what is in reality the middle of some concealed

  @emph{Be careful when editing the diary entries in the simple display!}
Inserting additional lines or adding/deleting characters in the middle
of a visible line cannot cause problems, but editing at the end of a
line may not do what you expect.  Deleting a line may delete other
invisible entries that follow it.  Before editing the simple diary
buffer, it is best to display the entire file with @kbd{s}

@node Fancy Diary Display
@subsection Fancy Diary Display

The following features only work with the fancy diary display.

@cindex sorting diary entries
611 612
  You can use the normal hook @code{diary-list-entries-hook} to sort
each day's diary entries by their time of day.  Here's how:

@findex diary-sort-entries
(add-hook 'diary-list-entries-hook 'diary-sort-entries t)
617 618 619 620 621
@end example

For each day, this sorts diary entries that begin with a recognizable
time of day according to their times.  Diary entries without times come
622 623 624
first within each day.  Note how the sort command is placed at the end
of the hook list, in case earlier members of the list change the order
of the diary entries, or add items.

Glenn Morris's avatar
Glenn Morris committed
626 627 628 629 630
@vindex diary-comment-start
  You can write @samp{comments} in diary entries, by setting the
variables @code{diary-comment-start} and @code{diary-comment-end} to
strings that delimit comments.  The fancy display does not print
comments.  You might want to put meta-data for the use of other packages
(e.g.@: the appointment package,
Glenn Morris's avatar
Glenn Morris committed
632 633 634 635 636 637 638 639
@pxref{Appointments,,,emacs, the Emacs Manual})
@end iftex
@end ifnottex
inside comments.

@vindex diary-include-string
641 642 643
  Your main diary file can include other files.  This permits a group of
people to share a diary file for events that apply to all of them.
Lines in the diary file starting with @code{diary-include-string}:
644 645 646 647 648 649

#include "@var{filename}"
@end smallexample

650 651 652 653 654
include the diary entries from the file @var{filename} in the fancy
diary buffer.  The include mechanism is recursive, so that included
files can include other files, and so on (you must be careful not to
have a cycle of inclusions, of course).  Here is how to enable the
include facility:

656 657 658 659
@vindex diary-list-entries-hook
@vindex diary-mark-entries-hook
@findex diary-include-other-diary-files
@findex diary-mark-included-diary-files
661 662
(add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
(add-hook 'diary-mark-entries-hook 'diary-mark-included-diary-files)
663 664 665
@end smallexample

The include mechanism works only with the fancy diary display, because
simple diary display shows the entries directly from your diary file.
667 668 669 670 671

@node Sexp Diary Entries
@subsection Sexp Entries and the Fancy Diary Display
@cindex sexp diary entries

@vindex diary-sexp-entry-symbol
  Sexp diary entries allow you to do more than just have complicated
674 675
conditions under which a diary entry applies.  Sexp entries should be
preceded by @code{diary-sexp-entry-symbol} (default @samp{%%}) in the
676 677
diary file.  With the fancy diary display, sexp entries can generate the
text of the entry depending on the date itself.
678 679

For example, an anniversary diary entry can insert
the number of years since the anniversary date into the text of the
diary entry.  Thus the @samp{%d} in this diary entry:
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714

@findex diary-anniversary
%%(diary-anniversary 10 31 1948) Arthur's birthday (%d years old)
@end smallexample

gets replaced by the age, so on October 31, 1990 the entry appears in
the fancy diary buffer like this:

Arthur's birthday (42 years old)
@end smallexample

If the diary file instead contains this entry:

%%(diary-anniversary 10 31 1948) Arthur's %d%s birthday
@end smallexample

the entry in the fancy diary buffer for October 31, 1990 appears like this:

Arthur's 42nd birthday
@end smallexample

  Similarly, cyclic diary entries can interpolate the number of repetitions
that have occurred:

@findex diary-cyclic
%%(diary-cyclic 50 1 1 2012) Renew medication (%d%s time)
716 717 718 719 720 721 722 723 724 725
@end smallexample

looks like this:

Renew medication (5th time)
@end smallexample

in the fancy diary display on September 7, 2012.

  There is an ``early reminder'' diary sexp that includes its entry in the
729 730 731 732 733 734 735 736 737 738
diary not only on the date of occurrence, but also on earlier dates.
For example, if you want a reminder a week before your anniversary, you
can use

@findex diary-remind
%%(diary-remind '(diary-anniversary 12 22 1968) 7) Ed's anniversary
@end smallexample

739 740
and the fancy diary will show @samp{Ed's anniversary} both on December
15 and on December 22.
741 742 743 744

@findex diary-date
  The function @code{diary-date} applies to dates described by a month,
day, year combination, each of which can be an integer, a list of
integers, or @code{t} (meaning all values).  For example,
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764

%%(diary-date '(10 11 12) 22 t) Rake leaves
@end smallexample

causes the fancy diary to show

Rake leaves
@end smallexample

on October 22, November 22, and December 22 of every year.

@findex diary-float
  The function @code{diary-float} allows you to describe diary entries
that apply to dates like the third Friday of November, or the last
Tuesday in April.  The parameters are the @var{month}, @var{dayname},
and an index @var{n}.  The entry appears on the @var{n}th @var{dayname}
766 767 768 769 770 771 772 773
after the first day of @var{month}, where @var{dayname}=0 means Sunday,
1 means Monday, and so on.  If @var{n} is negative it counts backward
from the end of @var{month}.  The value of @var{month} can be a list of
months, a single month, or @code{t} to specify all months.  You can also
use an optional parameter @var{day} to specify the @var{n}th
@var{dayname} on or after/before @var{day} of @var{month}; the value of
@var{day} defaults to 1 if @var{n} is positive and to the last day of
@var{month} if @var{n} is negative.  For example,
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814

%%(diary-float t 1 -1) Pay rent
@end smallexample

causes the fancy diary to show

Pay rent
@end smallexample

on the last Monday of every month.

  The generality of sexp diary entries lets you specify any diary
entry that you can describe algorithmically.  A sexp diary entry
contains an expression that computes whether the entry applies to any
given date.  If its value is non-@code{nil}, the entry applies to that
date; otherwise, it does not.  The expression can use the variable
@code{date} to find the date being considered; its value is a list
(@var{month} @var{day} @var{year}) that refers to the Gregorian

  The sexp diary entry applies to a date when the expression's value
is non-@code{nil}, but some values have more specific meanings.  If
the value is a string, that string is a description of the event which
occurs on that date.  The value can also have the form
@code{(@var{mark} . @var{string})}; then @var{mark} specifies how to
mark the date in the calendar, and @var{string} is the description of
the event.  If @var{mark} is a single-character string, that character
appears next to the date in the calendar.  If @var{mark} is a face
name, the date is displayed in that face.  If @var{mark} is
@code{nil}, that specifies no particular highlighting for the date.

  Suppose you get paid on the 21st of the month if it is a weekday, and
on the Friday before if the 21st is on a weekend.  Here is how to write
a sexp diary entry that matches those dates:

&%%(let ((dayname (calendar-day-of-week date))
         (day (cadr date)))
816 817 818 819 820 821 822 823 824
      (or (and (= day 21) (memq dayname '(1 2 3 4 5)))
          (and (memq day '(19 20)) (= dayname 5)))
         ) Pay check deposited
@end smallexample

  The following sexp diary entries take advantage of the ability (in the fancy
diary display) to concoct diary entries whose text varies based on the date:

@findex diary-sunrise-sunset
@findex diary-lunar-phases
826 827 828 829
@findex diary-day-of-year
@findex diary-iso-date
@findex diary-julian-date
@findex diary-astro-day-number
@findex diary-bahai-date
831 832 833
@findex diary-chinese-date
@findex diary-coptic-date
@findex diary-ethiopic-date
834 835 836 837
@findex diary-hebrew-date
@findex diary-islamic-date
@findex diary-french-date
@findex diary-mayan-date
@findex diary-persian-date
839 840
@table @code
@item %%(diary-sunrise-sunset)
Make a diary entry for today's local times of sunrise and sunset.
@item %%(diary-lunar-phases)
843 844 845 846 847 848 849
Make a diary entry for the phases (quarters) of the moon.
@item %%(diary-day-of-year)
Make a diary entry with today's day number in the current year and the number
of days remaining in the current year.
@item %%(diary-iso-date)
Make a diary entry with today's equivalent ISO commercial date.
@item %%(diary-julian-date)
Make a diary entry with today's equivalent Julian calendar date.
851 852
@item %%(diary-astro-day-number)
Make a diary entry with today's equivalent astronomical (Julian) day number.
@item %%(diary-bahai-date)
Make a diary entry with today's equivalent Bahá'í calendar date.
855 856 857 858 859 860
@item %%(diary-chinese-date)
Make a diary entry with today's equivalent Chinese calendar date.
@item %%(diary-coptic-date)
Make a diary entry with today's equivalent Coptic calendar date.
@item %%(diary-ethiopic-date)
Make a diary entry with today's equivalent Ethiopic calendar date.
861 862 863
@item %%(diary-french-date)
Make a diary entry with today's equivalent date on the French Revolutionary
864 865 866 867
@item %%(diary-hebrew-date)
Make a diary entry with today's equivalent Hebrew calendar date.
@item %%(diary-islamic-date)
Make a diary entry with today's equivalent Islamic calendar date.
@item %%(diary-mayan-date)
869 870 871
Make a diary entry with today's equivalent Mayan calendar date.
@item %%(diary-persian-date)
Make a diary entry with today's equivalent Persian calendar date.
872 873 874
@end table

For example, including the diary entry

@end smallexample
880 881 882 883

causes every day's diary display to contain the equivalent date on the
Hebrew calendar, if you are using the fancy diary display.  (With simple
884 885
diary display, the literal line @samp{&%%(diary-hebrew-date)} appears in
the diary for any date.)

887 888
  This function has been used to construct certain standard Hebrew sexp
diary entries:
889 890

@cindex rosh hodesh
@findex diary-hebrew-rosh-hodesh
@cindex parasha, weekly
@findex diary-hebrew-parasha
@cindex candle lighting times
@findex diary-hebrew-sabbath-candles
@cindex omer count
@findex diary-hebrew-omer
@cindex yahrzeits
@findex diary-hebrew-yahrzeit
@findex diary-hebrew-birthday
@table @code
@item %%(diary-hebrew-rosh-hodesh)
903 904
Make a diary entry that tells the occurrence and ritual announcement of each
new Hebrew month.
@item %%(diary-hebrew-parasha)
Make a Saturday diary entry that tells the weekly synagogue scripture reading.
@item %%(diary-hebrew-sabbath-candles)
908 909
Make a Friday diary entry that tells the @emph{local time} of Sabbath
candle lighting.
@item %%(diary-hebrew-omer)
Make a diary entry that gives the omer count, when appropriate.
@item %%(diary-hebrew-yahrzeit @var{month} @var{day} @var{year}) @var{name}
913 914
Make a diary entry marking the anniversary of a date of death.  The date
is the @emph{Gregorian} (civil) date of death.  The diary entry appears
915 916 917
on the proper Hebrew calendar anniversary and on the day before.  (The
order of the parameters changes according to the calendar date style;
for example in the European style to @var{day}, @var{month}, @var{year}.)
918 919
@item %%(diary-hebrew-birthday @var{month} @var{day} @var{year})
Make a diary entry for a birthday on the Hebrew calendar.
920 921 922 923 924
@end table

  All the functions documented above take an optional argument
@var{mark} which specifies how to mark the date in the calendar display.
If one of these functions decides that it applies to a certain date,
it returns a value that contains @var{mark}, as described above.