(defun list-diary-entries (date number)
"Create and display a buffer containing the relevant lines in diary-file.
-All lines that apply to DATE and the next NUMBER-1 days are included.
-
-Makes all diary entries in the diary file invisible (using selective display),
-*except* those that are relevant.
+The arguments are DATE and NUMBER; the entries selected are those
+for NUMBER days starting with date DATE. The other entries are hidden
+using selective display.
Returns a list of all relevant diary entries found, if any, in order by date.
The list entries have the form ((month day year) string). If the variable
-`diary-list-include-blanks' is t, this list will include a dummy diary entry
-(consisting of the empty string) for a date with no diary entries.
+`diary-list-include-blanks' is t, this list includes a dummy diary entry
+\(consisting of the empty string) for a date with no diary entries.
After the list is prepared, the hooks `nongregorian-diary-listing-hook',
`list-diary-entries-hook', and `diary-display-hook' are run. These hooks
(setq d (cdr d)))))
(defun mark-hebrew-calendar-date-pattern (month day year)
- "Mark all dates in the calendar window that conform to the Hebrew date
-MONTH/DAY/YEAR. A value of 0 in any position is a wild-card."
+ "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR.
+A value of 0 in any position is a wild-card."
(save-excursion
(set-buffer calendar-buffer)
(if (and (/= 0 month) (/= 0 day))
nil))))
(defun diary-block (m1 d1 y1 m2 d2 y2)
- "Block diary entry--entry applies if date is between two dates. Order of
-the parameters is M1, D1, Y1, M2, D2, Y2 `european-calendar-style' is nil, and
+ "Block diary entry.
+Entry applies if date is between two dates. Order of the parameters is
+M1, D1, Y1, M2, D2, Y2 `european-calendar-style' is nil, and
D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t."
(let ((date1 (calendar-absolute-from-gregorian
(if european-calendar-style
entry)))
(defun diary-anniversary (month day year)
- "Anniversary diary entry--entry applies if date is the anniversary of
-MONTH, DAY, YEAR if `european-calendar-style' is nil, and DAY, MONTH, YEAR
-if `european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
+ "Anniversary diary entry.
+Entry applies if date is the anniversary of MONTH, DAY, YEAR if
+`european-calendar-style' is nil, and DAY, MONTH, YEAR if
+`european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
%d will be replaced by the number of years since the MONTH DAY, YEAR and the
%s will be replaced by the ordinal ending of that number (that is, `st', `nd',
`rd' or `th', as appropriate. The anniversary of February 29 is considered
(+ 1721425 (calendar-absolute-from-gregorian date))))
(defun diary-omer ()
- "Omer count diary entry--entry applies if date is within 50 days after
-Passover."
+ "Omer count diary entry.
+Entry applies if date is within 50 days after Passover."
(let* ((passover
(calendar-absolute-from-hebrew
(list 1 15 (+ (extract-calendar-year date) 3760))))
(t "th"))))))
(defun diary-rosh-hodesh ()
- "Rosh Hodesh diary entry--entry applies if date is Rosh Hodesh, the day
-before, or the Saturday before."
+ "Rosh Hodesh diary entry.
+Entry applies if date is Rosh Hodesh, the day before, or the Saturday before."
(let* ((d (calendar-absolute-from-gregorian date))
(h-date (calendar-hebrew-from-absolute d))
(h-month (extract-calendar-month h-date))
(setq d (cdr d)))))
(defun mark-islamic-calendar-date-pattern (month day year)
- "Mark all dates in the calendar window that conform to the Islamic date
-MONTH/DAY/YEAR. A value of 0 in any position is a wild-card."
+ "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR.
+A value of 0 in any position is a wild-card."
(save-excursion
(set-buffer calendar-buffer)
(if (and (/= 0 month) (/= 0 day))