aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman1994-05-08 06:45:49 +0000
committerRichard M. Stallman1994-05-08 06:45:49 +0000
commit6b1abbd18635f4a8a90331493e0ea4e3eef53d70 (patch)
tree11b4af66c8b18965e391f269ee2fe4dce672532d
parentbe6231e3d15f63b31bec28137ab7a571c239c2bb (diff)
downloademacs-6b1abbd18635f4a8a90331493e0ea4e3eef53d70.tar.gz
emacs-6b1abbd18635f4a8a90331493e0ea4e3eef53d70.zip
Doc fixes.
-rw-r--r--lisp/calendar/calendar.el37
1 files changed, 19 insertions, 18 deletions
diff --git a/lisp/calendar/calendar.el b/lisp/calendar/calendar.el
index 0e6450b671a..a1661e106f4 100644
--- a/lisp/calendar/calendar.el
+++ b/lisp/calendar/calendar.el
@@ -226,7 +226,7 @@ and reentering it will cause these functions to be called again.")
226This can be used, for example, to replace today's date with asterisks; a 226This can be used, for example, to replace today's date with asterisks; a
227function `calendar-star-date' is included for this purpose: 227function `calendar-star-date' is included for this purpose:
228 (setq today-visible-calendar-hook 'calendar-star-date) 228 (setq today-visible-calendar-hook 'calendar-star-date)
229It can also be used to mark the current date with calendar-today-marker; 229It can also be used to mark the current date with `calendar-today-marker';
230a function is also provided for this: 230a function is also provided for this:
231 (setq today-visible-calendar-hook 'calendar-mark-today) 231 (setq today-visible-calendar-hook 'calendar-mark-today)
232 232
@@ -285,9 +285,10 @@ instead, if you execute `european-calendar' when in the calendar, or set
285To revert to the default American style from the European style, execute 285To revert to the default American style from the European style, execute
286`american-calendar' in the calendar. 286`american-calendar' in the calendar.
287 287
288A diary entry can be preceded by a diary-nonmarking-symbol (ordinarily `&') 288A diary entry can be preceded by the character
289to make that entry nonmarking--that is, it will not be marked on dates in 289`diary-nonmarking-symbol' (ordinarily `&') to make that entry
290the calendar window but will appear in a diary window. 290nonmarking--that is, it will not be marked on dates in the calendar
291window but will appear in a diary window.
291 292
292Multiline diary entries are made by indenting lines after the first with 293Multiline diary entries are made by indenting lines after the first with
293either a TAB or one or more spaces. 294either a TAB or one or more spaces.
@@ -397,7 +398,7 @@ characters with or without a period.")
397 (monthname " *" day ", *" year "[^0-9]") 398 (monthname " *" day ", *" year "[^0-9]")
398 (dayname "\\W")) 399 (dayname "\\W"))
399 "*List of pseudo-patterns describing the American patterns of date used. 400 "*List of pseudo-patterns describing the American patterns of date used.
400See the documentation of diary-date-forms for an explanation.") 401See the documentation of `diary-date-forms' for an explanation.")
401 402
402;;;###autoload 403;;;###autoload
403(defvar european-date-diary-pattern 404(defvar european-date-diary-pattern
@@ -407,7 +408,7 @@ See the documentation of diary-date-forms for an explanation.")
407 (day " *" monthname " *" year "[^0-9]") 408 (day " *" monthname " *" year "[^0-9]")
408 (dayname "\\W")) 409 (dayname "\\W"))
409 "*List of pseudo-patterns describing the European patterns of date used. 410 "*List of pseudo-patterns describing the European patterns of date used.
410See the documentation of diary-date-forms for an explanation.") 411See the documentation of `diary-date-forms' for an explanation.")
411 412
412(defvar diary-date-forms 413(defvar diary-date-forms
413 (if european-calendar-style 414 (if european-calendar-style
@@ -446,7 +447,7 @@ See the documentation of calendar-date-display-form for an explanation.")
446(defvar american-calendar-display-form 447(defvar american-calendar-display-form
447 '((if dayname (concat dayname ", ")) monthname " " day ", " year) 448 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
448 "*Pseudo-pattern governing the way a date appears in the American style. 449 "*Pseudo-pattern governing the way a date appears in the American style.
449See the documentation of calendar-date-display-form for an explanation.") 450See the documentation of `calendar-date-display-form' for an explanation.")
450 451
451(defvar calendar-date-display-form 452(defvar calendar-date-display-form
452 (if european-calendar-style 453 (if european-calendar-style
@@ -504,7 +505,7 @@ It is to be used for diary entries that are not found in the diary file.
504 505
505A function `include-other-diary-files' is provided for use as the value of 506A function `include-other-diary-files' is provided for use as the value of
506this hook. This function enables you to use shared diary files together 507this hook. This function enables you to use shared diary files together
507with your own. The files included are specified in the diary-file by lines 508with your own. The files included are specified in the diary file by lines
508of the form 509of the form
509 510
510 #include \"filename\" 511 #include \"filename\"
@@ -513,7 +514,7 @@ This is recursive; that is, #include directives in files thus included are
513obeyed. You can change the \"#include\" to some other string by changing 514obeyed. You can change the \"#include\" to some other string by changing
514the variable `diary-include-string'. When you use `include-other-diary-files' 515the variable `diary-include-string'. When you use `include-other-diary-files'
515as part of the list-diary-entries-hook, you will probably also want to use the 516as part of the list-diary-entries-hook, you will probably also want to use the
516function `mark-included-diary-files' as part of the mark-diary-entries-hook. 517function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
517 518
518For example, you could use 519For example, you could use
519 520
@@ -521,7 +522,7 @@ For example, you could use
521 '(include-other-diary-files sort-diary-entries)) 522 '(include-other-diary-files sort-diary-entries))
522 (setq diary-display-hook 'fancy-diary-display) 523 (setq diary-display-hook 'fancy-diary-display)
523 524
524in your .emacs file to cause the fancy diary buffer to be displayed with 525in your `.emacs' file to cause the fancy diary buffer to be displayed with
525diary entries from various included files, each day's entries sorted into 526diary entries from various included files, each day's entries sorted into
526lexicographic order.") 527lexicographic order.")
527 528
@@ -567,14 +568,14 @@ describes the style of such diary entries.")
567 568
568A function `mark-included-diary-files' is also provided for use as the 569A function `mark-included-diary-files' is also provided for use as the
569mark-diary-entries-hook; it enables you to use shared diary files together 570mark-diary-entries-hook; it enables you to use shared diary files together
570with your own. The files included are specified in the diary-file by lines 571with your own. The files included are specified in the diary file by lines
571of the form 572of the form
572 #include \"filename\" 573 #include \"filename\"
573This is recursive; that is, #include directives in files thus included are 574This is recursive; that is, #include directives in files thus included are
574obeyed. You can change the \"#include\" to some other string by changing the 575obeyed. You can change the \"#include\" to some other string by changing the
575variable `diary-include-string'. When you use `mark-included-diary-files' as 576variable `diary-include-string'. When you use `mark-included-diary-files' as
576part of the mark-diary-entries-hook, you will probably also want to use the 577part of the mark-diary-entries-hook, you will probably also want to use the
577function `include-other-diary-files' as part of the list-diary-entries-hook.") 578function `include-other-diary-files' as part of `list-diary-entries-hook'.")
578 579
579;;;###autoload 580;;;###autoload
580(defvar nongregorian-diary-marking-hook nil 581(defvar nongregorian-diary-marking-hook nil
@@ -1185,7 +1186,7 @@ to be replaced by asterisks to highlight it whenever it is in the window."
1185 1186
1186(autoload 'view-diary-entries "diary" 1187(autoload 'view-diary-entries "diary"
1187 "Prepare and display a buffer with diary entries. 1188 "Prepare and display a buffer with diary entries.
1188Searches the file diary-file for entries that match ARG days starting with 1189Searches your diary file for entries that match ARG days starting with
1189the date indicated by the cursor position in the displayed three-month 1190the date indicated by the cursor position in the displayed three-month
1190calendar." 1191calendar."
1191 t) 1192 t)
@@ -1247,15 +1248,15 @@ calendar."
1247 t) 1248 t)
1248 1249
1249(autoload 'show-all-diary-entries "diary" 1250(autoload 'show-all-diary-entries "diary"
1250 "Show all of the diary entries in the diary-file. 1251 "Show all of the diary entries in the diary file.
1251This function gets rid of the selective display of the diary-file so that 1252This function gets rid of the selective display of the diary file so that
1252all entries, not just some, are visible. If there is no diary buffer, one 1253all entries, not just some, are visible. If there is no diary buffer, one
1253is created." 1254is created."
1254 t) 1255 t)
1255 1256
1256(autoload 'mark-diary-entries "diary" 1257(autoload 'mark-diary-entries "diary"
1257 "Mark days in the calendar window that have diary entries. 1258 "Mark days in the calendar window that have diary entries.
1258Each entry in diary-file visible in the calendar window is marked." 1259Each entry in diary file visible in the calendar window is marked."
1259 t) 1260 t)
1260 1261
1261(autoload 'insert-diary-entry "diary-ins" 1262(autoload 'insert-diary-entry "diary-ins"
@@ -1632,7 +1633,7 @@ The following commands control the diary:
1632 \\[view-diary-entries] display diary entries \\[show-all-diary-entries] show all diary entries 1633 \\[view-diary-entries] display diary entries \\[show-all-diary-entries] show all diary entries
1633 \\[print-diary-entries] print diary entries 1634 \\[print-diary-entries] print diary entries
1634 1635
1635Displaying the diary entries causes the diary entries from the diary-file 1636Displaying the diary entries causes the diary entries from the diary file
1636\(for the date indicated by the cursor in the calendar window) to be 1637\(for the date indicated by the cursor in the calendar window) to be
1637displayed in another window. This function takes an integer argument that 1638displayed in another window. This function takes an integer argument that
1638specifies the number of days of calendar entries to be displayed, starting 1639specifies the number of days of calendar entries to be displayed, starting
@@ -1646,7 +1647,7 @@ displayed, independently of the calendar. The number of days of entries is
1646governed by number-of-diary-entries. 1647governed by number-of-diary-entries.
1647 1648
1648The format of the entries in the diary file is described in the 1649The format of the entries in the diary file is described in the
1649documentation string for the variable diary-file. 1650documentation string for the variable `diary-file'.
1650 1651
1651When diary entries are in view in the window, they can be edited. It is 1652When diary entries are in view in the window, they can be edited. It is
1652important to keep in mind that the buffer displayed contains the entire 1653important to keep in mind that the buffer displayed contains the entire