doc/emacs/cal-xtra.texi

8 @c Moved here from the Emacs Lisp Reference Manual, 2005-03-26.
13 features of the calendar and diary.  It starts with some of the
14 many ways in which you can customize the calendar and diary to suit
20 * Mayan Calendar::         Moving to a date specified in a Mayan calendar.
33 @vindex calendar-intermonth-text
34 @cindex calendar layout
35 @cindex calendar week numbers
36   The calendar display unfortunately cannot be changed from three
38 variables: @code{calendar-left-margin},
39 @code{calendar-day-header-width}, @code{calendar-day-digit-width},
40 @code{calendar-column-width}, and @code{calendar-intermonth-spacing}.
42 customize the variables @code{calendar-intermonth-header} and
43 @code{calendar-intermonth-text} as described in their documentation.
45 @vindex calendar-month-header
46 @vindex calendar-day-header-array
47   The variable @code{calendar-month-header} controls the text that
48 appears above each month in the calendar.  By default, it shows the
49 month and year.  The variable @code{calendar-day-header-array}
53 @vindex calendar-holiday-marker
55 @vindex calendar-today-marker
56   The variable @code{calendar-holiday-marker} specifies how to mark a
57 date that is a holiday.  Its value may be a single-character string to
60 date that has diary entries.  The function @code{calendar-mark-today}
61 uses @code{calendar-today-marker} to mark today's date.  By default,
62 the calendar uses faces named @code{holiday}, @code{diary}, and
63 @code{calendar-today} for these purposes.
65 @vindex calendar-initial-window-hook
66   Starting the calendar runs the normal hook
67 @code{calendar-initial-window-hook}.  Recomputation of the calendar
68 display does not run this hook.  But if you leave the calendar with the
71 @vindex calendar-today-visible-hook
72 @findex calendar-star-date
73   The variable @code{calendar-today-visible-hook} is a normal hook run
74 after the calendar buffer has been prepared with the calendar, when the
77 @code{calendar-mark-today} or @code{calendar-star-date}:
79 @findex calendar-mark-today
81 (add-hook 'calendar-today-visible-hook 'calendar-mark-today)
84 @vindex calendar-today-invisible-hook
86   A similar normal hook, @code{calendar-today-invisible-hook} is run if
89 @vindex calendar-move-hook
90   Each of the calendar cursor motion commands runs the hook
91 @code{calendar-move-hook} after it moves the cursor.
96 @vindex calendar-holidays
125 @vindex calendar-bahai-all-holidays-flag
126 @vindex calendar-christian-all-holidays-flag
127 @vindex calendar-hebrew-all-holidays-flag
128 @vindex calendar-islamic-all-holidays-flag
132 all) of the variables @code{calendar-bahai-all-holidays-flag},
133 @code{calendar-christian-all-holidays-flag},
134 @code{calendar-hebrew-all-holidays-flag}, or
135 @code{calendar-islamic-all-holidays-flag} to @code{t}.
141 numbers count starting from 1, but @dfn{dayname} numbers count Sunday as
142 0.  The argument @var{string} is always the description of the
143 holiday, as a string.
146 @item (holiday-fixed @var{month} @var{day} @var{string})
147 A fixed date on the Gregorian calendar.
149 @item (holiday-float @var{month} @var{dayname} @var{k} @var{string}
153 means count back from the end of the month.  Optional @var{day} defaults
156 @item (holiday-chinese @var{month} @var{day} @var{string})
157 A fixed date on the Chinese calendar.
159 @item (holiday-hebrew @var{month} @var{day} @var{string})
160 A fixed date on the Hebrew calendar.
162 @item (holiday-islamic @var{month} @var{day} @var{string})
163 A fixed date on the Islamic calendar.
165 @item (holiday-julian @var{month} @var{day} @var{string})
166 A fixed date on the Julian calendar.
168 @item (holiday-sexp @var{sexp} @var{string})
217 1 starting from Nisan), the Islamic feast celebrating Mohammed's
218 birthday (since the Islamic months are numbered from 1 starting with
220 Julian calendar.
229                    (calendar-gregorian-from-absolute
230                     (1+ (calendar-dayname-on-or-before
231                           1 (+ 6 (calendar-absolute-from-gregorian
242            (calendar-extract-day
243              (calendar-gregorian-from-absolute
244                (1+ (calendar-dayname-on-or-before
245                      1 (+ 6 (calendar-absolute-from-gregorian
256 visible in the calendar window, with descriptive strings, like this:
263 @subsection Converting from the Mayan Calendar
264 @cindex Mayan calendar
266   Here are the commands to select dates based on the Mayan calendar:
270 Move to a date specified by the long count calendar
271 (@code{calendar-mayan-goto-long-count-date}).
274 tzolkin calendar (@code{calendar-mayan-next-tzolkin-date}).
277 tzolkin calendar (@code{calendar-mayan-previous-tzolkin-date}).
280 haab calendar (@code{calendar-mayan-next-haab-date}).
283 haab calendar (@code{calendar-mayan-previous-haab-date}).
286 calendar round (@code{calendar-mayan-next-calendar-round-date}).
289 calendar round (@code{calendar-mayan-previous-calendar-round-date}).
292 @cindex Mayan long count
294 The @dfn{long count} is a counting of days with these units:
302 @findex calendar-mayan-goto-long-count-date
304 Thus, the long count date 12.16.11.16.6 means 12 baktun, 16 katun, 11
305 tun, 16 uinal, and 6 kin.  The Emacs calendar can handle Mayan long
306 count dates as early as 7.17.18.13.3, but no earlier.  When you use the
307 @kbd{g m l} command, type the Mayan long count date with the baktun,
310 @findex calendar-mayan-previous-tzolkin-date
311 @findex calendar-mayan-next-tzolkin-date
312 @cindex Mayan tzolkin calendar
313   The Mayan tzolkin calendar is a cycle of 260 days formed by a pair of
321 @findex calendar-mayan-previous-haab-date
322 @findex calendar-mayan-next-haab-date
323 @cindex Mayan haab calendar
324   The Mayan haab calendar is a cycle of 365 days arranged as 18 months
333 @c This is omitted because it is too long for smallbook format.
334 @c @findex calendar-mayan-previous-calendar-round-date
335 @findex calendar-mayan-next-calendar-round-date
336 @cindex Mayan calendar round
339 @emph{calendar round}.  If you type @kbd{g m p c}, Emacs asks you for
357 @vindex calendar-date-display-form
360 lines, and messages by setting @code{calendar-date-display-form}.
363 string form, and @code{monthname} and @code{dayname}, which are both
382 ((format "%s-%.2d-%.2d" year (string-to-number month)
383          (string-to-number day)))
395 @vindex calendar-time-display-form
397   The calendar and diary by default display times of day in the
398 conventional American style with the hours from 1 through 12, minutes,
400 also known in the US as military, in which the hours go from 00 to 23,
401 you can alter the variable @code{calendar-time-display-form}.  This
404 numbers in string form, and @code{am-pm} and @code{time-zone}, which are
420 Note that few calendar functions return a time of day (at present, only
436 initial display when @code{calendar-view-diary-initially-flag} is
466 @code{calendar-month-abbrev-array} and
467 @code{calendar-day-abbrev-array}).  All the symbols can match @samp{*};
509 to match part of a word beyond the date itself to distinguish it from
515   As well as entries based on the standard Gregorian calendar, your
564 on the Hebrew calendar.  And here is an Islamic-date diary entry that matches
575   Here is a table of commands used in the calendar to create diary
623 diary entries: they apply to the date that point is on in the calendar
703 from view.  This means, for instance, that the @kbd{C-f}
751 @vindex diary-include-string
754 Lines in the diary file starting with @code{diary-include-string}:
761 include the diary entries from the file @var{filename} in the fancy
777 simple diary display shows the entries directly from your diary file.
879 from the end of @var{month}.  The value of @var{month} can be a list of
907 calendar.
911 the value is a string, that string is a description of the event which
913 @code{(@var{mark} . @var{string})}; then @var{mark} specifies how to
914 mark the date in the calendar, and @var{string} is the description of
915 the event.  If @var{mark} is a single-character string, that character
916 appears next to the date in the calendar.  If @var{mark} is a face
925 &%%(let ((dayname (calendar-day-of-week date))
948 @findex diary-mayan-date
961 Make a diary entry with today's equivalent Julian calendar date.
965 Make a diary entry with today's equivalent Bahá'í calendar date.
967 Make a diary entry with today's equivalent Chinese calendar date.
969 Make a diary entry with today's equivalent Coptic calendar date.
971 Make a diary entry with today's equivalent Ethiopic calendar date.
974 calendar.
976 Make a diary entry with today's equivalent Hebrew calendar date.
978 Make a diary entry with today's equivalent Islamic calendar date.
979 @item %%(diary-mayan-date)
980 Make a diary entry with today's equivalent Mayan calendar date.
982 Make a diary entry with today's equivalent Persian calendar date.
994 Hebrew calendar, if you are using the fancy diary display.  (With simple
1007 @cindex omer count
1022 Make a diary entry that gives the omer count, when appropriate.
1026 on the proper Hebrew calendar anniversary and on the day before.  (The
1027 order of the parameters changes according to the calendar date style;
1030 Make a diary entry for a birthday on the Hebrew calendar.
1034 @var{mark} which specifies how to mark the date in the calendar display.