X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/22697dac66806b67eca956ad8cf8907b16d750b4..d3c91027f319adabab13e92f645fd4e7503ca3d1:/lispref/calendar.texi diff --git a/lispref/calendar.texi b/lispref/calendar.texi index 8e42a530f2..f132ea8868 100644 --- a/lispref/calendar.texi +++ b/lispref/calendar.texi @@ -1,8 +1,8 @@ @c -*-texinfo-*- @c This is part of the GNU Emacs Lisp Reference Manual. -@c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc. +@c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998 Free Software Foundation, Inc. @c See the file elisp.texi for copying conditions. -@node Calendar, Tips, Display, Top +@node Calendar, System Interface, Display, Top @chapter Customizing the Calendar and Diary There are many customizations that you can use to make the calendar and @@ -16,7 +16,7 @@ diary suit your personal tastes. * Daylight Savings:: Changing the default. * Diary Customizing:: Defaults you can set. * Hebrew/Islamic Entries:: How to obtain them. -* Fancy Diary Display:: Enhancing the diary display, sorting entries, +* Fancy Diary Display:: Enhancing the diary display, sorting entries, using included diary files. * Sexp Diary Entries:: Fancy things you can do. * Appt Customizing:: Customizing appointment reminders. @@ -30,7 +30,7 @@ diary suit your personal tastes. @code{t}, calling up the calendar automatically displays the diary entries for the current date as well. The diary dates appear only if the current date is visible. If you add both of the following lines to -your @file{.emacs} file:@refill +your init file:@refill @example (setq view-diary-entries-initially t) @@ -52,8 +52,7 @@ window. @code{t} in order to mark any dates with diary entries. This takes effect whenever the calendar window contents are recomputed. There are two ways of marking these dates: by changing the face (@pxref{Faces}), -if the display supports that, or by placing a plus sign (@samp{+}) -beside the date otherwise. +or by placing a plus sign (@samp{+}) beside the date. @vindex mark-holidays-in-calendar Similarly, setting the variable @code{mark-holidays-in-calendar} to @@ -68,8 +67,7 @@ the date, or a face name to use for displaying the date. Likewise, the variable @code{diary-entry-marker} specifies how to mark a date that has diary entries. The calendar creates faces named @code{holiday-face} and @code{diary-face} for these purposes; those symbols are the default -values of these variables, when Emacs supports multiple faces on your -terminal. +values of these variables. @vindex calendar-load-hook The variable @code{calendar-load-hook} is a normal hook run when the @@ -109,14 +107,17 @@ The variable @code{calendar-today-marker} specifies how to mark today's date. Its value should be a character to insert next to the date or a face name to use for displaying the date. A face named @code{calendar-today-face} is provided for this purpose; that symbol is -the default for this variable when Emacs supports multiple faces on your -terminal. +the default for this variable. @vindex today-invisible-calendar-hook @noindent A similar normal hook, @code{today-invisible-calendar-hook} is run if the current date is @emph{not} visible in the window. +@vindex calendar-move-hook + Starting in Emacs 21, each of the calendar cursor motion commands +runs the hook @code{calendar-move-hook} after it moves the cursor. + @node Holiday Customizing @section Customizing the Holidays @@ -254,12 +255,12 @@ occur on the first Tuesday after the first Monday in November of years divisible by 4: @smallexample -(holiday-sexp (if (= 0 (% year 4)) +(holiday-sexp '(if (= 0 (% year 4)) (calendar-gregorian-from-absolute (1+ (calendar-dayname-on-or-before 1 (+ 6 (calendar-absolute-from-gregorian - (list 11 1 year)))))) - "US Presidential Election")) + (list 11 1 year))))))) + "US Presidential Election") @end smallexample @noindent @@ -542,7 +543,7 @@ the fourth pattern. well as entries based on the world-standard Gregorian calendar. However, because recognition of such entries is time-consuming and 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, +want the diary to recognize Hebrew-date diary entries, for example, you must do this: @vindex nongregorian-diary-listing-hook @@ -577,7 +578,7 @@ HHeshvan 25 Happy Hebrew birthday! @noindent and would appear in the diary for any date that corresponds to Heshvan 25 -on the Hebrew calendar. And here is Islamic-date diary entry that matches +on the Hebrew calendar. And here is an Islamic-date diary entry that matches Dhu al-Qada 25: @smallexample @@ -602,7 +603,7 @@ entry matches any date that has the same Hebrew day-within-month as the selected date. @item i h y Add a diary entry for the day of the Hebrew year corresponding to the -selected date (@code{insert-yearly-hebrew-diary-entry}). This diary +selected date (@code{insert-yearly-hebrew-diary-entry}). This diary entry matches any date which has the same Hebrew month and day-within-month as the selected date. @item i i d @@ -625,7 +626,7 @@ selected date (@code{insert-yearly-islamic-diary-entry}). These commands work much like the corresponding commands for ordinary diary entries: they apply to the date that point is on in the calendar 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 +at the end of your diary file. You must then insert the rest of the diary entry. @node Fancy Diary Display @@ -653,8 +654,8 @@ the entries by the dates they apply to. As with simple diary display, you can print a hard copy of the buffer with @code{print-diary-entries}. To print a hard copy of a day-by-day -diary for a week by positioning point on Sunday of that week, type -@kbd{7 d} and then do @kbd{M-x print-diary-entries}. As usual, the +diary for a week, position point on Sunday of that week, type +@kbd{7 d}, and then do @kbd{M-x print-diary-entries}. As usual, the inclusion of the holidays slows down the display slightly; you can speed things up by setting the variable @code{holidays-in-diary-buffer} to @code{nil}. @@ -668,7 +669,7 @@ shown in the fancy diary buffer, set the variable @cindex sorting diary entries If you use the fancy diary display, you can use the normal hook @code{list-diary-entries-hook} to sort each day's diary entries by their -time of day. Here's how +time of day. Here's how: @findex sort-diary-entries @example @@ -763,13 +764,91 @@ Renew medication (5th time) @noindent in the fancy diary display on September 8, 1990. - 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 calendar. + There is an early reminder diary sexp that includes its entry in the +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 +@smallexample +%%(diary-remind '(diary-anniversary 12 22 1968) 7) Ed's anniversary +@end smallexample + +@noindent +and the fancy diary will show +@smallexample +Ed's anniversary +@end smallexample +@noindent +both on December 15 and on December 22. + +@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}. The value @code{t} means all values. For +example, + +@smallexample +%%(diary-date '(10 11 12) 22 t) Rake leaves +@end smallexample + +@noindent +causes the fancy diary to show + +@smallexample +Rake leaves +@end smallexample + +@noindent +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} +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} of +@var{month} on or after/before @var{day}; 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, + +@smallexample +%%(diary-float t 1 -1) Pay rent +@end smallexample + +@noindent +causes the fancy diary to show + +@smallexample +Pay rent +@end smallexample + +@noindent +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 +calendar. + + 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 @@ -866,6 +945,11 @@ the European style, the order of the parameters is changed to @var{day}, @var{month}, @var{year}.) @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}. + @node Appt Customizing @section Customizing Appointment Reminders @@ -883,7 +967,7 @@ how far in advance it begins doing so, by setting these variables: @table @code @item appt-message-warning-time The time in minutes before an appointment that the reminder begins. The -default is 10 minutes. +default is 12 minutes. @item appt-audible If this is non-@code{nil}, Emacs rings the terminal bell for appointment reminders. The default is @code{t}. @@ -904,5 +988,9 @@ This variable holds a function to use to get rid of the appointment message window, when its time is up. @item appt-display-duration The number of seconds to display an appointment message. The default -is 5 seconds. +is 10 seconds. @end table + +@ignore + arch-tag: 8e50c766-4703-4888-a421-af15244cca7e +@end ignore