[Emacs-diffs] Changes to emacs/doc/emacs/cal-xtra.texi,v

[Glenn Morris]

CVSROOT:        /sources/emacs
Module name:    emacs
Changes by:     Glenn Morris <gm>       08/04/08 07:00:38

Index: cal-xtra.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/cal-xtra.texi,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- cal-xtra.texi       22 Jan 2008 23:53:35 -0000      1.2
+++ cal-xtra.texi       8 Apr 2008 07:00:38 -0000       1.3
@@ -32,23 +32,22 @@
 date as being a holiday.  Its value may be a single-character string
 to 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 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.
+to mark a date that has diary entries.  By default, the calendar uses
+faces named @code{holiday} and @code{diary} for these purposes.
 
 @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).
 
address@hidden initial-calendar-window-hook
address@hidden calendar-initial-window-hook
   Starting the calendar runs the normal hook
address@hidden  Recomputation of the calendar
address@hidden  Recomputation of the calendar
 display does not run this hook.  But if you leave the calendar with the
 @kbd{q} command and reenter it, the hook runs address@hidden
 
address@hidden today-visible-calendar-hook
-  The variable @code{today-visible-calendar-hook} is a normal hook run
address@hidden calendar-today-visible-hook
+  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
 replace today's date with asterisks; to do that, use the hook function
@@ -56,7 +55,7 @@
 
 @findex calendar-star-date
 @example
-(add-hook 'today-visible-calendar-hook 'calendar-star-date)
+(add-hook 'calendar-today-visible-hook 'calendar-star-date)
 @end example
 
 @noindent
@@ -65,7 +64,7 @@
 
 @findex calendar-mark-today
 @example
-(add-hook 'today-visible-calendar-hook 'calendar-mark-today)
+(add-hook 'calendar-today-visible-hook 'calendar-mark-today)
 @end example
 
 @noindent
@@ -73,12 +72,12 @@
 The variable @code{calendar-today-marker} specifies how to mark
 today's date.  Its value should be a single-character string 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.
+face named @code{calendar-today} is provided for this purpose; that
+symbol is the default for this variable.
 
address@hidden today-invisible-calendar-hook
address@hidden calendar-today-invisible-hook
 @noindent
-  A similar normal hook, @code{today-invisible-calendar-hook} is run if
+  A similar normal hook, @code{calendar-today-invisible-hook} is run if
 the current date is @emph{not} visible in the window.
 
 @vindex calendar-move-hook
@@ -89,50 +88,60 @@
 @subsection Customizing the Holidays
 
 @vindex calendar-holidays
address@hidden christian-holidays
address@hidden hebrew-holidays
address@hidden islamic-holidays
address@hidden holiday-bahai-holidays
address@hidden holiday-christian-holidays
address@hidden holiday-hebrew-holidays
address@hidden holiday-islamic-holidays
   Emacs knows about holidays defined by entries on one of several lists.
 You can customize these lists of holidays to your own needs, adding or
 deleting holidays.  The lists of holidays that Emacs uses are for
-general holidays (@code{general-holidays}), local holidays
-(@code{local-holidays}), Christian holidays (@code{christian-holidays}),
-Hebrew (Jewish) holidays (@code{hebrew-holidays}), Islamic (Muslim)
-holidays (@code{islamic-holidays}), and other holidays
-(@code{other-holidays}).
+general holidays (@code{holiday-general-holidays}), local holidays
+(@code{holiday-local-holidays}), Baha'i holidays
+(@code{holiday-bahai-holidays}), Christian holidays
+(@code{holiday-christian-holidays}), Hebrew (Jewish) holidays
+(@code{holiday-hebrew-holidays}), Islamic (Muslim) holidays
+(@code{holiday-islamic-holidays}), Oriental holidays
+(@code{holiday-oriental-holidays}), sun- and moon-related holidays
+(@code{holiday-solar-holidays}), and other holidays
+(@code{holiday-other-holidays}).
 
address@hidden general-holidays
address@hidden holiday-general-holidays
   The general holidays are, by default, holidays common throughout the
-United States.  To eliminate these holidays, set @code{general-holidays}
-to @code{nil}.
+United States.  To eliminate these holidays, set
address@hidden to @code{nil}.
 
address@hidden local-holidays
address@hidden holiday-local-holidays
   There are no default local holidays (but sites may supply some).  You
-can set the variable @code{local-holidays} to any list of holidays, as
-described below.
+can set the variable @code{holiday-local-holidays} to any list of
+holidays, as described below.
 
address@hidden all-christian-calendar-holidays
address@hidden all-hebrew-calendar-holidays
address@hidden all-islamic-calendar-holidays
address@hidden calendar-bahai-all-holidays-flag
address@hidden calendar-christian-all-holidays-flag
address@hidden calendar-hebrew-all-holidays-flag
address@hidden calendar-islamic-all-holidays-flag
   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
-all) of the variables @code{all-christian-calendar-holidays},
address@hidden, or
address@hidden to @code{t}.  If you want to
+all) of the variables @code{calendar-bahai-all-holidays-flag},
address@hidden,
address@hidden, or
address@hidden to @code{t}.  If you want to
 eliminate the religious holidays, set any or all of the corresponding
-variables @code{christian-holidays}, @code{hebrew-holidays}, and
address@hidden to @address@hidden
+variables @code{holiday-bahai-holidays}, @code{holiday-christian-holidays},
address@hidden, and @code{holiday-islamic-holidays} to
address@hidden@refill
 
address@hidden other-holidays
-  You can set the variable @code{other-holidays} to any list of
address@hidden holiday-other-holidays
+  You can set the variable @code{holiday-other-holidays} to any list of
 holidays.  This list, normally empty, is intended for individual use.
 
 @cindex holiday forms
-  Each of the lists (@code{general-holidays}, @code{local-holidays},
address@hidden, @code{hebrew-holidays},
address@hidden, and @code{other-holidays}) is a list of
address@hidden forms}, each holiday form describing a holiday (or
+  Each of the lists (@code{holiday-general-holidays},
address@hidden, @code{holiday-bahai-holidays},
address@hidden, @code{holiday-hebrew-holidays},
address@hidden, @code{holiday-oriental-holidays},
address@hidden, and @code{holiday-other-holidays}) is a
+list of @dfn{holiday forms}, each holiday form describing a holiday (or
 sometimes a list of holidays).
 
   Here is a table of the possible kinds of holiday form.  Day numbers
@@ -199,8 +208,8 @@
 @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 Hebrew,
-Islamic, and Julian calendars too.  For example,
+  You can specify holidays that occur on fixed days of the Baha'i,
+Hebrew, Islamic, and Julian calendars too.  For example,
 
 @smallexample
 (setq other-holidays
@@ -236,7 +245,7 @@
 @smallexample
 (if (= 0 (% displayed-year 4))
     (fixed 11
-           (extract-calendar-day
+           (calendar-extract-day
              (calendar-gregorian-from-absolute
                (1+ (calendar-dayname-on-or-before
                      1 (+ 6 (calendar-absolute-from-gregorian
@@ -247,7 +256,7 @@
   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{other-holidays}
+for example, add @code{(eclipses)} to @code{holiday-other-holidays}
 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:
@@ -324,31 +333,32 @@
 @node Diary Customizing
 @subsection Customizing the Diary
 
address@hidden holidays-in-diary-buffer
address@hidden diary-show-holidays-flag
   Ordinarily, the mode line of the diary buffer window indicates any
 holidays that fall on the date of the diary entries.  The process of
 checking for holidays can take several seconds, so including holiday
 information delays the display of the diary buffer noticeably.  If you'd
 prefer to have a faster display of the diary buffer but without the
-holiday information, set the variable @code{holidays-in-diary-buffer} to
+holiday information, set the variable @code{diary-show-holidays-flag} to
 @address@hidden
 
address@hidden number-of-diary-entries
-  The variable @code{number-of-diary-entries} controls the number of
address@hidden 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{view-diary-entries-initially} is @code{t}, as
-well as the command @kbd{M-x diary}.  For example, the default value is
-1, which says to display only the current day's diary entries.  If the
-value is 2, both the current day's and the next day's entries are
-displayed.  The value can also be a vector of seven elements: 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.
-
address@hidden print-diary-entries-hook
address@hidden print-diary-entries
-  The variable @code{print-diary-entries-hook} is a normal hook run
+initial display when @code{calendar-view-diary-initially-flag} is
address@hidden, as well as the command @kbd{M-x diary}.  For example, the
+default value is 1, which says to display only the current day's diary
+entries.  If the value is 2, both the current day's and the next day's
+entries are displayed.  The value can also be a vector of seven
+elements: 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.
+
address@hidden diary-print-entries-hook
address@hidden diary-print-entries
+  The variable @code{diary-print-entries-hook} is a normal hook run
 after preparation of a temporary buffer containing just the diary
 entries currently visible in the diary buffer.  (The other, irrelevant
 diary entries are really absent from the temporary buffer; in the diary
@@ -419,33 +429,34 @@
 to match part of a word beyond the date itself to distinguish it from
 the fourth pattern.
 
address@hidden FIXME Baha'i.
 @node Hebrew/Islamic Entries
 @subsection Hebrew- and Islamic-Date Diary Entries
 
-  Your diary file can have entries based on Hebrew or Islamic dates, as
-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,
-you must do this:
-
address@hidden nongregorian-diary-listing-hook
address@hidden nongregorian-diary-marking-hook
address@hidden list-hebrew-diary-entries
address@hidden mark-hebrew-diary-entries
+  Your diary file can have entries based on Baha'i, Hebrew, or Islamic
+dates, as 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, you must do this:
+
address@hidden diary-nongregorian-listing-hook
address@hidden diary-nongregorian-marking-hook
address@hidden diary-hebrew-list-entries
address@hidden diary-hebrew-mark-entries
 @smallexample
-(add-hook 'nongregorian-diary-listing-hook 'list-hebrew-diary-entries)
-(add-hook 'nongregorian-diary-marking-hook 'mark-hebrew-diary-entries)
+(add-hook 'diary-nongregorian-listing-hook 'diary-hebrew-list-entries)
+(add-hook 'diary-nongregorian-marking-hook 'diary-hebrew-mark-entries)
 @end smallexample
 
 @noindent
 If you want Islamic-date entries, do this:
 
address@hidden list-islamic-diary-entries
address@hidden mark-islamic-diary-entries
address@hidden diary-islamic-list-entries
address@hidden diary-islamic-mark-entries
 @smallexample
-(add-hook 'nongregorian-diary-listing-hook 'list-islamic-diary-entries)
-(add-hook 'nongregorian-diary-marking-hook 'mark-islamic-diary-entries)
+(add-hook 'diary-nongregorian-listing-hook 'diary-islamic-list-entries)
+(add-hook 'diary-nongregorian-marking-hook 'diary-islamic-mark-entries)
 @end smallexample
 
   Hebrew- and Islamic-date diary entries have the same formats as
@@ -478,34 +489,34 @@
 @table @kbd
 @item i h d
 Add a diary entry for the Hebrew date corresponding to the selected date
-(@code{insert-hebrew-diary-entry}).
+(@code{diary-hebrew-insert-entry}).
 @item i h m
 Add a diary entry for the day of the Hebrew month corresponding to the
-selected date (@code{insert-monthly-hebrew-diary-entry}).  This diary
+selected date (@code{diary-hebrew-insert-monthly-entry}).  This diary
 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{diary-hebrew-insert-yearly-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
 Add a diary entry for the Islamic date corresponding to the selected date
-(@code{insert-islamic-diary-entry}).
+(@code{diary-islamic-insert-entry}).
 @item i i m
 Add a diary entry for the day of the Islamic month corresponding to the
-selected date (@code{insert-monthly-islamic-diary-entry}).
+selected date (@code{diary-islamic-insert-monthly-entry}).
 @item i i y
 Add a diary entry for the day of the Islamic year corresponding to the
-selected date (@code{insert-yearly-islamic-diary-entry}).
+selected date (@code{diary-islamic-insert-yearly-entry}).
 @end table
 
address@hidden insert-hebrew-diary-entry
address@hidden insert-monthly-hebrew-diary-entry
address@hidden insert-yearly-hebrew-diary-entry
address@hidden insert-islamic-diary-entry
address@hidden insert-monthly-islamic-diary-entry
address@hidden insert-yearly-islamic-diary-entry
address@hidden diary-hebrew-insert-entry
address@hidden diary-hebrew-insert-monthly-entry
address@hidden diary-hebrew-insert-yearly-entry
address@hidden diary-islamic-insert-entry
address@hidden diary-islamic-insert-monthly-entry
address@hidden diary-islamic-insert-yearly-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
@@ -515,17 +526,17 @@
 @node Fancy Diary Display
 @subsection Fancy Diary Display
 @vindex diary-display-hook
address@hidden simple-diary-display
address@hidden diary-simple-display
 
   Diary display works by preparing the diary buffer and then running the
 hook @code{diary-display-hook}.  The default value of this hook
-(@code{simple-diary-display}) hides the irrelevant diary entries and
+(@code{diary-simple-display}) hides the irrelevant diary entries and
 then displays the buffer.  However, if you specify the hook as follows,
 
 @cindex diary buffer
address@hidden fancy-diary-display
address@hidden diary-fancy-display
 @example
-(add-hook 'diary-display-hook 'fancy-diary-display)
+(add-hook 'diary-display-hook diary-'fancy-display)
 @end example
 
 @noindent
@@ -536,11 +547,11 @@
 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
+with @code{diary-print-entries}.  To print a hard copy of a day-by-day
 diary for a week, position point on Sunday of that week, type
address@hidden d}, and then do @kbd{M-x print-diary-entries}.  As usual, the
address@hidden 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{holidays-in-diary-buffer} to
+things up by setting the variable @code{diary-show-holidays-flag} to
 @code{nil}.
 
 @vindex diary-list-include-blanks
@@ -551,12 +562,12 @@
 
 @cindex sorting diary entries
   If you use the fancy diary display, you can use the normal hook
address@hidden to sort each day's diary entries by their
address@hidden to sort each day's diary entries by their
 time of day.  Here's how:
 
address@hidden sort-diary-entries
address@hidden diary-sort-entries
 @example
-(add-hook 'list-diary-entries-hook 'sort-diary-entries t)
+(add-hook 'diary-list-entries-hook 'diary-sort-entries t)
 @end example
 
 @noindent
@@ -579,13 +590,13 @@
 cycle of inclusions, of course.  Here is how to enable the include
 facility:
 
address@hidden list-diary-entries-hook
address@hidden mark-diary-entries-hook
address@hidden include-other-diary-files
address@hidden mark-included-diary-files
address@hidden diary-list-entries-hook
address@hidden diary-mark-entries-hook
address@hidden diary-include-other-diary-files
address@hidden diary-mark-included-diary-files
 @smallexample
-(add-hook 'list-diary-entries-hook 'include-other-diary-files)
-(add-hook 'mark-diary-entries-hook 'mark-included-diary-files)
+(add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
+(add-hook 'diary-mark-entries-hook 'diary-mark-included-diary-files)
 @end smallexample
 
 The include mechanism works only with the fancy diary display, because
@@ -754,6 +765,7 @@
 @findex diary-iso-date
 @findex diary-julian-date
 @findex diary-astro-day-number
address@hidden diary-bahai-date
 @findex diary-hebrew-date
 @findex diary-islamic-date
 @findex diary-french-date
@@ -772,6 +784,8 @@
 Make a diary entry with today's equivalent date on the Julian calendar.
 @item %%(diary-astro-day-number)
 Make a diary entry with today's equivalent astronomical (Julian) day number.
address@hidden %%(diary-bahai-date)
+Make a diary entry with today's equivalent date on the Baha'i calendar.
 @item %%(diary-hebrew-date)
 Make a diary entry with today's equivalent date on the Hebrew calendar.
 @item %%(diary-islamic-date)
@@ -800,27 +814,27 @@
 the Hebrew calendar in certain standard ways:
 
 @cindex rosh hodesh
address@hidden diary-rosh-hodesh
address@hidden diary-hebrew-rosh-hodesh
 @cindex parasha, weekly
address@hidden diary-parasha
address@hidden diary-hebrew-parasha
 @cindex candle lighting times
address@hidden diary-sabbath-candles
address@hidden diary-hebrew-sabbath-candles
 @cindex omer count
address@hidden diary-omer
address@hidden diary-hebrew-omer
 @cindex yahrzeits
address@hidden diary-yahrzeit
address@hidden diary-hebrew-yahrzeit
 @table @code
address@hidden %%(diary-rosh-hodesh)
address@hidden %%(diary-hebrew-rosh-hodesh)
 Make a diary entry that tells the occurrence and ritual announcement of each
 new Hebrew month.
address@hidden %%(diary-parasha)
address@hidden %%(diary-hebrew-parasha)
 Make a Saturday diary entry that tells the weekly synagogue scripture reading.
address@hidden %%(diary-sabbath-candles)
address@hidden %%(diary-hebrew-sabbath-candles)
 Make a Friday diary entry that tells the @emph{local time} of Sabbath
 candle lighting.
address@hidden %%(diary-omer)
address@hidden %%(diary-hebrew-omer)
 Make a diary entry that gives the omer count, when appropriate.
address@hidden %%(diary-yahrzeit @var{month} @var{day} @var{year}) @var{name}
address@hidden %%(diary-hebrew-yahrzeit @var{month} @var{day} @var{year}) 
@var{name}
 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
 on the proper Hebrew calendar anniversary and on the day before.  (In