diff options
| author | Glenn Morris | 2012-02-17 22:02:12 -0500 |
|---|---|---|
| committer | Glenn Morris | 2012-02-17 22:02:12 -0500 |
| commit | a5987767c5be19c845a5c81ab05097ecfbd5aff0 (patch) | |
| tree | e33f3208b58cf453a19c889dd135424bb28f4fe7 | |
| parent | 37863f2069724d9683467ff9bde05ed2106c665d (diff) | |
| download | emacs-a5987767c5be19c845a5c81ab05097ecfbd5aff0.tar.gz emacs-a5987767c5be19c845a5c81ab05097ecfbd5aff0.zip | |
* doc/emacs/cal-xtra.texi: Copyedits.
* admin/FOR-RELEASE: Related markup.
| -rw-r--r-- | admin/FOR-RELEASE | 2 | ||||
| -rw-r--r-- | doc/emacs/ChangeLog | 2 | ||||
| -rw-r--r-- | doc/emacs/cal-xtra.texi | 82 |
3 files changed, 41 insertions, 45 deletions
diff --git a/admin/FOR-RELEASE b/admin/FOR-RELEASE index ec0107dc110..b9da6f22f35 100644 --- a/admin/FOR-RELEASE +++ b/admin/FOR-RELEASE | |||
| @@ -127,7 +127,7 @@ basic.texi cyd | |||
| 127 | buffers.texi cyd | 127 | buffers.texi cyd |
| 128 | building.texi cyd | 128 | building.texi cyd |
| 129 | calendar.texi rgm | 129 | calendar.texi rgm |
| 130 | cal-xtra.texi | 130 | cal-xtra.texi rgm |
| 131 | cmdargs.texi cyd | 131 | cmdargs.texi cyd |
| 132 | commands.texi cyd | 132 | commands.texi cyd |
| 133 | custom.texi cyd | 133 | custom.texi cyd |
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index b2ef823ac25..0ac87608adf 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,5 +1,7 @@ | |||
| 1 | 2012-02-18 Glenn Morris <rgm@gnu.org> | 1 | 2012-02-18 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * cal-xtra.texi: Copyedits. | ||
| 4 | |||
| 3 | * emacs-xtra.texi: Set encoding to ISO-8859-1. | 5 | * emacs-xtra.texi: Set encoding to ISO-8859-1. |
| 4 | 6 | ||
| 5 | 2012-02-17 Glenn Morris <rgm@gnu.org> | 7 | 2012-02-17 Glenn Morris <rgm@gnu.org> |
diff --git a/doc/emacs/cal-xtra.texi b/doc/emacs/cal-xtra.texi index cce8d9481ce..45760afd7a6 100644 --- a/doc/emacs/cal-xtra.texi +++ b/doc/emacs/cal-xtra.texi | |||
| @@ -9,8 +9,8 @@ | |||
| 9 | @node Advanced Calendar/Diary Usage | 9 | @node Advanced Calendar/Diary Usage |
| 10 | @section Customizing the Calendar and Diary | 10 | @section Customizing the Calendar and Diary |
| 11 | 11 | ||
| 12 | There are many customizations that you can use to make the calendar and | 12 | There are many ways in which you can customize the calendar and |
| 13 | diary suit your personal tastes. | 13 | diary to suit your personal tastes. |
| 14 | 14 | ||
| 15 | @menu | 15 | @menu |
| 16 | * Calendar Customizing:: Calendar layout and hooks. | 16 | * Calendar Customizing:: Calendar layout and hooks. |
| @@ -43,12 +43,12 @@ customize the variables @code{calendar-intermonth-header} and | |||
| 43 | @vindex diary-entry-marker | 43 | @vindex diary-entry-marker |
| 44 | @vindex calendar-today-marker | 44 | @vindex calendar-today-marker |
| 45 | The variable @code{calendar-holiday-marker} specifies how to mark a | 45 | The variable @code{calendar-holiday-marker} specifies how to mark a |
| 46 | date as being a holiday. Its value may be a single-character string to | 46 | date that is a holiday. Its value may be a single-character string to |
| 47 | insert next to the date, or a face name to use for displaying the date. | 47 | insert next to the date, or a face name to use for displaying the date. |
| 48 | Likewise, the variable @code{diary-entry-marker} specifies how to mark a | 48 | Likewise, the variable @code{diary-entry-marker} specifies how to mark a |
| 49 | date that has diary entries, and @code{calendar-today-marker} is used by | 49 | date that has diary entries. The function @code{calendar-mark-today} |
| 50 | the function @code{calendar-mark-today} to mark today's date. By | 50 | uses @code{calendar-today-marker} to mark today's date. By default, |
| 51 | default, the calendar uses faces named @code{holiday}, @code{diary}, and | 51 | the calendar uses faces named @code{holiday}, @code{diary}, and |
| 52 | @code{calendar-today} for these purposes. | 52 | @code{calendar-today} for these purposes. |
| 53 | 53 | ||
| 54 | @vindex calendar-load-hook | 54 | @vindex calendar-load-hook |
| @@ -65,7 +65,7 @@ display does not run this hook. But if you leave the calendar with the | |||
| 65 | @vindex calendar-today-visible-hook | 65 | @vindex calendar-today-visible-hook |
| 66 | @findex calendar-star-date | 66 | @findex calendar-star-date |
| 67 | The variable @code{calendar-today-visible-hook} is a normal hook run | 67 | The variable @code{calendar-today-visible-hook} is a normal hook run |
| 68 | after the calendar buffer has been prepared with the calendar when the | 68 | after the calendar buffer has been prepared with the calendar, when the |
| 69 | current date is visible in the window. One use of this hook is to | 69 | current date is visible in the window. One use of this hook is to |
| 70 | mark today's date; to do that use either of the functions | 70 | mark today's date; to do that use either of the functions |
| 71 | @code{calendar-mark-today} or @code{calendar-star-date}: | 71 | @code{calendar-mark-today} or @code{calendar-star-date}: |
| @@ -90,28 +90,27 @@ the current date is @emph{not} visible in the window. | |||
| 90 | @vindex calendar-holidays | 90 | @vindex calendar-holidays |
| 91 | @vindex holiday-oriental-holidays | 91 | @vindex holiday-oriental-holidays |
| 92 | @vindex holiday-solar-holidays | 92 | @vindex holiday-solar-holidays |
| 93 | Emacs knows about holidays defined by entries on one of several lists. | 93 | There are several variables listing the default holidays that Emacs |
| 94 | The lists of holidays that Emacs uses are for | 94 | knows about. These are: @code{holiday-general-holidays}, |
| 95 | general holidays (@code{holiday-general-holidays}), | 95 | @code{holiday-local-holidays}, @code{holiday-solar-holidays}, |
| 96 | local holidays (@code{holiday-local-holidays}), | 96 | @code{holiday-bahai-holidays}, @code{holiday-christian-holidays}, |
| 97 | sun- and moon-related holidays (@code{holiday-solar-holidays}), | 97 | @code{holiday-hebrew-holidays}, @code{holiday-islamic-holidays}, |
| 98 | Bahá'í holidays (@code{holiday-bahai-holidays}), | 98 | @code{holiday-oriental-holidays}, and @code{holiday-other-holidays}. |
| 99 | Christian holidays (@code{holiday-christian-holidays}), | 99 | The names should be self-explanatory; e.g.@: @code{holiday-solar-holidays} |
| 100 | Hebrew (Jewish) holidays (@code{holiday-hebrew-holidays}), | 100 | lists sun- and moon-related holidays. |
| 101 | Islamic (Muslim) holidays (@code{holiday-islamic-holidays}), | ||
| 102 | Oriental holidays (@code{holiday-oriental-holidays}), | ||
| 103 | and other holidays (@code{holiday-other-holidays}). | ||
| 104 | 101 | ||
| 105 | You can customize these lists of holidays to your own needs, deleting or | 102 | You can customize these lists of holidays to your own needs, deleting or |
| 106 | adding holidays as described below. Set any of them to @code{nil} to | 103 | adding holidays as described below. Set any of them to @code{nil} to |
| 107 | eliminate the associated holidays. | 104 | not show the associated holidays. |
| 108 | 105 | ||
| 109 | @vindex holiday-general-holidays | 106 | @vindex holiday-general-holidays |
| 110 | The general holidays are, by default, holidays common throughout the | ||
| 111 | United States. | ||
| 112 | |||
| 113 | @vindex holiday-local-holidays | 107 | @vindex holiday-local-holidays |
| 114 | There are no default local holidays, but your site may supply some. | 108 | @vindex holiday-other-holidays |
| 109 | The general holidays are, by default, holidays common throughout the | ||
| 110 | United States. In contrast, @code{holiday-local-holidays} and | ||
| 111 | @code{holiday-other-holidays} are both empty by default. These are | ||
| 112 | intended for system-wide settings and your individual use, | ||
| 113 | respectively. | ||
| 115 | 114 | ||
| 116 | @vindex holiday-bahai-holidays | 115 | @vindex holiday-bahai-holidays |
| 117 | @vindex holiday-christian-holidays | 116 | @vindex holiday-christian-holidays |
| @@ -129,18 +128,13 @@ all) of the variables @code{calendar-bahai-all-holidays-flag}, | |||
| 129 | @code{calendar-hebrew-all-holidays-flag}, or | 128 | @code{calendar-hebrew-all-holidays-flag}, or |
| 130 | @code{calendar-islamic-all-holidays-flag} to @code{t}. | 129 | @code{calendar-islamic-all-holidays-flag} to @code{t}. |
| 131 | 130 | ||
| 132 | @vindex holiday-other-holidays | ||
| 133 | You can set the variable @code{holiday-other-holidays} to any list of | ||
| 134 | holidays. This list, normally empty, is intended for individual use. | ||
| 135 | |||
| 136 | @cindex holiday forms | 131 | @cindex holiday forms |
| 137 | Each of the holiday variables is a list of @dfn{holiday forms}, each | 132 | Each of the holiday variables is a list of @dfn{holiday forms}, each |
| 138 | form describing a holiday (or sometimes a list of holidays). | 133 | form describing a holiday (or sometimes a list of holidays). Here is |
| 139 | 134 | a table of the possible kinds of holiday form. Day numbers and month | |
| 140 | Here is a table of the possible kinds of holiday form. Day numbers | 135 | numbers count starting from 1, but ``dayname'' numbers count Sunday as |
| 141 | and month numbers count starting from 1, but ``dayname'' numbers | 136 | 0. The argument @var{string} is always the description of the |
| 142 | count Sunday as 0. The element @var{string} is always the | 137 | holiday, as a string. |
| 143 | description of the holiday, as a string. | ||
| 144 | 138 | ||
| 145 | @table @code | 139 | @table @code |
| 146 | @item (holiday-fixed @var{month} @var{day} @var{string}) | 140 | @item (holiday-fixed @var{month} @var{day} @var{string}) |
| @@ -256,15 +250,15 @@ and write an Emacs Lisp function @code{eclipses} that returns a | |||
| 256 | visible in the calendar window, with descriptive strings, like this: | 250 | visible in the calendar window, with descriptive strings, like this: |
| 257 | 251 | ||
| 258 | @smallexample | 252 | @smallexample |
| 259 | (((6 27 1991) "Lunar Eclipse") ((7 11 1991) "Solar Eclipse") ... ) | 253 | (((6 4 2012) "Lunar Eclipse") ((11 13 2012) "Solar Eclipse") ... ) |
| 260 | @end smallexample | 254 | @end smallexample |
| 261 | 255 | ||
| 262 | @node Date Display Format | 256 | @node Date Display Format |
| 263 | @subsection Date Display Format | 257 | @subsection Date Display Format |
| 264 | @vindex calendar-date-display-form | 258 | @vindex calendar-date-display-form |
| 265 | 259 | ||
| 266 | You can customize the manner of displaying dates in the diary, in mode | 260 | You can customize the way dates are displayed in the diary, mode |
| 267 | lines, and in messages by setting @code{calendar-date-display-form}. | 261 | lines, and messages by setting @code{calendar-date-display-form}. |
| 268 | This variable holds a list of expressions that can involve the variables | 262 | This variable holds a list of expressions that can involve the variables |
| 269 | @code{month}, @code{day}, and @code{year}, which are all numbers in | 263 | @code{month}, @code{day}, and @code{year}, which are all numbers in |
| 270 | string form, and @code{monthname} and @code{dayname}, which are both | 264 | string form, and @code{monthname} and @code{dayname}, which are both |
| @@ -291,7 +285,7 @@ The default ISO date representation is: | |||
| 291 | @end smallexample | 285 | @end smallexample |
| 292 | 286 | ||
| 293 | @noindent | 287 | @noindent |
| 294 | This specifies a typical American format: | 288 | Another typical American format is: |
| 295 | 289 | ||
| 296 | @smallexample | 290 | @smallexample |
| 297 | (month "/" day "/" (substring year -2)) | 291 | (month "/" day "/" (substring year -2)) |
| @@ -358,7 +352,7 @@ be regular expressions (@pxref{Regular Expressions,,, elisp, the Emacs | |||
| 358 | Lisp Reference Manual}) or the symbols @code{month}, @code{day}, | 352 | Lisp Reference Manual}) or the symbols @code{month}, @code{day}, |
| 359 | @code{year}, @code{monthname}, and @code{dayname}. All these elements | 353 | @code{year}, @code{monthname}, and @code{dayname}. All these elements |
| 360 | serve as patterns that match certain kinds of text in the diary file. | 354 | serve as patterns that match certain kinds of text in the diary file. |
| 361 | In order for the date pattern, as a whole, to match, all of its elements | 355 | In order for the date pattern as a whole to match, all of its elements |
| 362 | must match consecutively. | 356 | must match consecutively. |
| 363 | 357 | ||
| 364 | A regular expression in a date pattern matches in its usual fashion, | 358 | A regular expression in a date pattern matches in its usual fashion, |
| @@ -387,8 +381,8 @@ provided by @code{diary-american-date-forms}: | |||
| 387 | @end example | 381 | @end example |
| 388 | 382 | ||
| 389 | @noindent | 383 | @noindent |
| 390 | Other default styles are provided by @code{diary-european-date-forms} | 384 | The variables @code{diary-european-date-forms} and |
| 391 | and @code{diary-iso-date-forms}. | 385 | @code{diary-iso-date-forms} provide other default styles. |
| 392 | 386 | ||
| 393 | The date patterns in the list must be @emph{mutually exclusive} and | 387 | The date patterns in the list must be @emph{mutually exclusive} and |
| 394 | must not match any portion of the diary entry itself, just the date and | 388 | must not match any portion of the diary entry itself, just the date and |
| @@ -627,7 +621,7 @@ of the diary entries, or add items. | |||
| 627 | variables @code{diary-comment-start} and @code{diary-comment-end} to | 621 | variables @code{diary-comment-start} and @code{diary-comment-end} to |
| 628 | strings that delimit comments. The fancy display does not print | 622 | strings that delimit comments. The fancy display does not print |
| 629 | comments. You might want to put meta-data for the use of other packages | 623 | comments. You might want to put meta-data for the use of other packages |
| 630 | (e.g. the appointment package, | 624 | (e.g.@: the appointment package, |
| 631 | @iftex | 625 | @iftex |
| 632 | @pxref{Appointments,,,emacs, the Emacs Manual}) | 626 | @pxref{Appointments,,,emacs, the Emacs Manual}) |
| 633 | @end iftex | 627 | @end iftex |
| @@ -711,7 +705,7 @@ that have occurred: | |||
| 711 | 705 | ||
| 712 | @findex diary-cyclic | 706 | @findex diary-cyclic |
| 713 | @smallexample | 707 | @smallexample |
| 714 | %%(diary-cyclic 50 1 1 1990) Renew medication (%d%s time) | 708 | %%(diary-cyclic 50 1 1 2012) Renew medication (%d%s time) |
| 715 | @end smallexample | 709 | @end smallexample |
| 716 | 710 | ||
| 717 | @noindent | 711 | @noindent |
| @@ -722,9 +716,9 @@ Renew medication (5th time) | |||
| 722 | @end smallexample | 716 | @end smallexample |
| 723 | 717 | ||
| 724 | @noindent | 718 | @noindent |
| 725 | in the fancy diary display on September 8, 1990. | 719 | in the fancy diary display on September 7, 2012. |
| 726 | 720 | ||
| 727 | There is an early reminder diary sexp that includes its entry in the | 721 | There is an ``early reminder'' diary sexp that includes its entry in the |
| 728 | diary not only on the date of occurrence, but also on earlier dates. | 722 | diary not only on the date of occurrence, but also on earlier dates. |
| 729 | For example, if you want a reminder a week before your anniversary, you | 723 | For example, if you want a reminder a week before your anniversary, you |
| 730 | can use | 724 | can use |