diff options
| author | Glenn Morris | 2012-02-16 20:28:53 -0800 |
|---|---|---|
| committer | Glenn Morris | 2012-02-16 20:28:53 -0800 |
| commit | 112d1241d818692bfb365171d83c818bbba503b4 (patch) | |
| tree | c0d008e7b29397d5c3a05a53bfd56aa1d9c41bd6 | |
| parent | 4230351b56aa91460e144ed0845692652c9b47ec (diff) | |
| download | emacs-112d1241d818692bfb365171d83c818bbba503b4.tar.gz emacs-112d1241d818692bfb365171d83c818bbba503b4.zip | |
Check calendar.texi
* doc/emacs/calendar.texi: Misc small changes, including updating the
dates of examples.
* admin/FOR-RELEASE: Related markup.
| -rw-r--r-- | admin/FOR-RELEASE | 2 | ||||
| -rw-r--r-- | doc/emacs/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/emacs/calendar.texi | 81 |
3 files changed, 48 insertions, 40 deletions
diff --git a/admin/FOR-RELEASE b/admin/FOR-RELEASE index 79f61647ff2..6e922b3d22d 100644 --- a/admin/FOR-RELEASE +++ b/admin/FOR-RELEASE | |||
| @@ -126,7 +126,7 @@ arevert-xtra.texi cyd | |||
| 126 | basic.texi cyd | 126 | basic.texi cyd |
| 127 | buffers.texi cyd | 127 | buffers.texi cyd |
| 128 | building.texi cyd | 128 | building.texi cyd |
| 129 | calendar.texi | 129 | calendar.texi rgm |
| 130 | cal-xtra.texi | 130 | cal-xtra.texi |
| 131 | cmdargs.texi cyd | 131 | cmdargs.texi cyd |
| 132 | commands.texi cyd | 132 | commands.texi cyd |
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index b7e7e30c8fc..e9092633e3c 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2012-02-17 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * calendar.texi: Misc small changes, including updating the dates | ||
| 4 | of examples. | ||
| 5 | |||
| 1 | 2012-02-16 Glenn Morris <rgm@gnu.org> | 6 | 2012-02-16 Glenn Morris <rgm@gnu.org> |
| 2 | 7 | ||
| 3 | * calendar.texi: Misc small changes. | 8 | * calendar.texi: Misc small changes. |
diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index 4687c044df2..546d184c857 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi | |||
| @@ -910,6 +910,7 @@ years for the date given by point. If you are not in the calendar, | |||
| 910 | this command first asks you for the date of death and the range of | 910 | this command first asks you for the date of death and the range of |
| 911 | years, and then displays the list of yahrzeit dates. | 911 | years, and then displays the list of yahrzeit dates. |
| 912 | 912 | ||
| 913 | @c FIXME move to emacs-xtra. | ||
| 913 | @node Mayan Calendar | 914 | @node Mayan Calendar |
| 914 | @subsection Converting from the Mayan Calendar | 915 | @subsection Converting from the Mayan Calendar |
| 915 | 916 | ||
| @@ -972,7 +973,7 @@ to go to the next occurrence of a tzolkin date. | |||
| 972 | @findex calendar-mayan-next-haab-date | 973 | @findex calendar-mayan-next-haab-date |
| 973 | @cindex Mayan haab calendar | 974 | @cindex Mayan haab calendar |
| 974 | The Mayan haab calendar is a cycle of 365 days arranged as 18 months | 975 | The Mayan haab calendar is a cycle of 365 days arranged as 18 months |
| 975 | of 20 days each, followed a 5-day monthless period. Like the tzolkin | 976 | of 20 days each, followed by a 5-day monthless period. Like the tzolkin |
| 976 | cycle, this cycle repeats endlessly, and there are commands to move | 977 | cycle, this cycle repeats endlessly, and there are commands to move |
| 977 | backward and forward to the previous or next point in the cycle. Type | 978 | backward and forward to the previous or next point in the cycle. Type |
| 978 | @kbd{g m p h} to go to the previous haab date; Emacs asks you for a haab | 979 | @kbd{g m p h} to go to the previous haab date; Emacs asks you for a haab |
| @@ -1012,7 +1013,7 @@ date. | |||
| 1012 | showing what that file looks like: | 1013 | showing what that file looks like: |
| 1013 | 1014 | ||
| 1014 | @example | 1015 | @example |
| 1015 | 12/22/1988 Twentieth wedding anniversary!! | 1016 | 12/22/2012 Twentieth wedding anniversary!! |
| 1016 | &1/1. Happy New Year! | 1017 | &1/1. Happy New Year! |
| 1017 | 10/22 Ruth's birthday. | 1018 | 10/22 Ruth's birthday. |
| 1018 | * 21, *: Payday | 1019 | * 21, *: Payday |
| @@ -1021,15 +1022,15 @@ Tuesday--weekly meeting with grad students at 10am | |||
| 1021 | 1/13/89 Friday the thirteenth!! | 1022 | 1/13/89 Friday the thirteenth!! |
| 1022 | &thu 4pm squash game with Lloyd. | 1023 | &thu 4pm squash game with Lloyd. |
| 1023 | mar 16 Dad's birthday | 1024 | mar 16 Dad's birthday |
| 1024 | April 15, 1989 Income tax due. | 1025 | April 15, 2013 Income tax due. |
| 1025 | &* 15 time cards due. | 1026 | &* 15 time cards due. |
| 1026 | @end example | 1027 | @end example |
| 1027 | 1028 | ||
| 1028 | @noindent | 1029 | @noindent |
| 1029 | This format is essentially the same as the one used by the system's | 1030 | This format is essentially the same as the one used by the separate |
| 1030 | @command{calendar} utility. This example uses extra spaces to align | 1031 | @command{calendar} utility that is present on some Unix systems. This |
| 1031 | the event descriptions of most of the entries. Such formatting is | 1032 | example uses extra spaces to align the event descriptions of most of |
| 1032 | purely a matter of taste. | 1033 | the entries. Such formatting is purely a matter of taste. |
| 1033 | 1034 | ||
| 1034 | Although you probably will start by creating a diary manually, Emacs | 1035 | Although you probably will start by creating a diary manually, Emacs |
| 1035 | provides a number of commands to let you view, add, and change diary | 1036 | provides a number of commands to let you view, add, and change diary |
| @@ -1108,8 +1109,8 @@ a different face. | |||
| 1108 | @xref{Calendar Customizing, diary-entry-marker}. | 1109 | @xref{Calendar Customizing, diary-entry-marker}. |
| 1109 | @end ifnottex | 1110 | @end ifnottex |
| 1110 | 1111 | ||
| 1111 | The command applies both to the currently visible months and to | 1112 | This command applies both to the months that are currently visible |
| 1112 | other months that subsequently become visible by scrolling. To turn | 1113 | and to those that subsequently become visible after scrolling. To turn |
| 1113 | marking off and erase the current marks, type @kbd{u}, which also | 1114 | marking off and erase the current marks, type @kbd{u}, which also |
| 1114 | turns off holiday marks (@pxref{Holidays}). If the variable | 1115 | turns off holiday marks (@pxref{Holidays}). If the variable |
| 1115 | @code{calendar-mark-diary-entries-flag} is non-@code{nil}, creating or | 1116 | @code{calendar-mark-diary-entries-flag} is non-@code{nil}, creating or |
| @@ -1133,13 +1134,13 @@ how many days to include. | |||
| 1133 | @end ifnottex | 1134 | @end ifnottex |
| 1134 | 1135 | ||
| 1135 | If you put @code{(diary)} in your @file{.emacs} file, this | 1136 | If you put @code{(diary)} in your @file{.emacs} file, this |
| 1136 | automatically displays a window with the day's diary entries, when you | 1137 | automatically displays a window with the day's diary entries when you |
| 1137 | enter Emacs. | 1138 | start Emacs. |
| 1138 | 1139 | ||
| 1139 | @findex diary-mail-entries | 1140 | @findex diary-mail-entries |
| 1140 | @vindex diary-mail-days | 1141 | @vindex diary-mail-days |
| 1141 | Many users like to receive notice of events in their diary as email. | 1142 | Some people like to receive email notifications of events in their |
| 1142 | To send such mail to yourself, use the command @kbd{M-x | 1143 | diary. To send such mail to yourself, use the command @kbd{M-x |
| 1143 | diary-mail-entries}. A prefix argument specifies how many days | 1144 | diary-mail-entries}. A prefix argument specifies how many days |
| 1144 | (starting with today) to check; otherwise, the variable | 1145 | (starting with today) to check; otherwise, the variable |
| 1145 | @code{diary-mail-days} says how many days. | 1146 | @code{diary-mail-days} says how many days. |
| @@ -1170,7 +1171,7 @@ consists only of the date or day name (with no following blanks or | |||
| 1170 | punctuation). For example: | 1171 | punctuation). For example: |
| 1171 | 1172 | ||
| 1172 | @example | 1173 | @example |
| 1173 | 02/11/1989 | 1174 | 02/11/2012 |
| 1174 | Bill B. visits Princeton today | 1175 | Bill B. visits Princeton today |
| 1175 | 2pm Cognitive Studies Committee meeting | 1176 | 2pm Cognitive Studies Committee meeting |
| 1176 | 2:30-5:30 Liz at Lawrenceville | 1177 | 2:30-5:30 Liz at Lawrenceville |
| @@ -1195,10 +1196,11 @@ for more than one day's entries. | |||
| 1195 | 1196 | ||
| 1196 | @vindex diary-nonmarking-symbol | 1197 | @vindex diary-nonmarking-symbol |
| 1197 | You can inhibit the marking of certain diary entries in the calendar | 1198 | You can inhibit the marking of certain diary entries in the calendar |
| 1198 | window; to do this, insert an ampersand @code{diary-nonmarking-symbol} | 1199 | window; to do this, insert the string that |
| 1199 | (default @samp{&}) at the beginning of the entry, before the date. This | 1200 | @code{diary-nonmarking-symbol} specifies (default @samp{&}) at the |
| 1200 | has no effect on display of the entry in the diary window; it affects | 1201 | beginning of the entry, before the date. This |
| 1201 | only marks on dates in the calendar window. Nonmarking entries are | 1202 | has no effect on display of the entry in the diary window; it only |
| 1203 | affects marks on dates in the calendar window. Nonmarking entries are | ||
| 1202 | especially useful for generic entries that would otherwise mark many | 1204 | especially useful for generic entries that would otherwise mark many |
| 1203 | different dates. | 1205 | different dates. |
| 1204 | 1206 | ||
| @@ -1211,14 +1213,14 @@ formatting a date. The examples all show dates in American order | |||
| 1211 | month, year) and ISO order (year, month, day) as options. | 1213 | month, year) and ISO order (year, month, day) as options. |
| 1212 | 1214 | ||
| 1213 | @example | 1215 | @example |
| 1214 | 4/20/93 Switch-over to new tabulation system | 1216 | 4/20/12 Switch-over to new tabulation system |
| 1215 | apr. 25 Start tabulating annual results | 1217 | apr. 25 Start tabulating annual results |
| 1216 | 4/30 Results for April are due | 1218 | 4/30 Results for April are due |
| 1217 | */25 Monthly cycle finishes | 1219 | */25 Monthly cycle finishes |
| 1218 | Friday Don't leave without backing up files | 1220 | Friday Don't leave without backing up files |
| 1219 | @end example | 1221 | @end example |
| 1220 | 1222 | ||
| 1221 | The first entry appears only once, on April 20, 1993. The second and | 1223 | The first entry appears only once, on April 20, 2012. The second and |
| 1222 | third appear every year on the specified dates, and the fourth uses a | 1224 | third appear every year on the specified dates, and the fourth uses a |
| 1223 | wildcard (asterisk) for the month, so it appears on the 25th of every | 1225 | wildcard (asterisk) for the month, so it appears on the 25th of every |
| 1224 | month. The final entry appears every week on Friday. | 1226 | month. The final entry appears every week on Friday. |
| @@ -1228,7 +1230,7 @@ month. The final entry appears every week on Friday. | |||
| 1228 | This must be followed by a nondigit. In the date itself, @var{month} | 1230 | This must be followed by a nondigit. In the date itself, @var{month} |
| 1229 | and @var{day} are numbers of one or two digits. The optional @var{year} | 1231 | and @var{day} are numbers of one or two digits. The optional @var{year} |
| 1230 | is also a number, and may be abbreviated to the last two digits; that | 1232 | is also a number, and may be abbreviated to the last two digits; that |
| 1231 | is, you can use @samp{11/12/1989} or @samp{11/12/89}. | 1233 | is, you can use @samp{11/12/2012} or @samp{11/12/12}. |
| 1232 | 1234 | ||
| 1233 | Dates can also have the form @samp{@var{monthname} @var{day}} or | 1235 | Dates can also have the form @samp{@var{monthname} @var{day}} or |
| 1234 | @samp{@var{monthname} @var{day}, @var{year}}, where the month's name can | 1236 | @samp{@var{monthname} @var{day}, @var{year}}, where the month's name can |
| @@ -1242,7 +1244,7 @@ letters of a name as its abbreviation. Case is not significant. | |||
| 1242 | A date may be @dfn{generic}; that is, partially unspecified. Then the | 1244 | A date may be @dfn{generic}; that is, partially unspecified. Then the |
| 1243 | entry applies to all dates that match the specification. If the date | 1245 | entry applies to all dates that match the specification. If the date |
| 1244 | does not contain a year, it is generic and applies to any year. | 1246 | does not contain a year, it is generic and applies to any year. |
| 1245 | Alternatively, @var{month}, @var{day}, or @var{year} can be a @samp{*}; | 1247 | Alternatively, @var{month}, @var{day}, or @var{year} can be @samp{*}; |
| 1246 | this matches any month, day, or year, respectively. Thus, a diary entry | 1248 | this matches any month, day, or year, respectively. Thus, a diary entry |
| 1247 | @samp{3/*/*} matches any day in March of any year; so does @samp{march | 1249 | @samp{3/*/*} matches any day in March of any year; so does @samp{march |
| 1248 | *}. | 1250 | *}. |
| @@ -1308,7 +1310,7 @@ command, and type the rest of the entry. Similarly, you can insert a | |||
| 1308 | yearly diary entry with the @kbd{i y} command. | 1310 | yearly diary entry with the @kbd{i y} command. |
| 1309 | 1311 | ||
| 1310 | All of the above commands make marking diary entries by default. To | 1312 | All of the above commands make marking diary entries by default. To |
| 1311 | make a nonmarking diary entry, give a numeric argument to the command. | 1313 | make a nonmarking diary entry, give a prefix argument to the command. |
| 1312 | For example, @kbd{C-u i w} makes a nonmarking weekly diary entry. | 1314 | For example, @kbd{C-u i w} makes a nonmarking weekly diary entry. |
| 1313 | 1315 | ||
| 1314 | When you modify the diary file, be sure to save the file before | 1316 | When you modify the diary file, be sure to save the file before |
| @@ -1365,15 +1367,15 @@ diary functions can use it to calculate the number of elapsed years. | |||
| 1365 | 1367 | ||
| 1366 | A @dfn{block} diary entry applies to a specified range of consecutive | 1368 | A @dfn{block} diary entry applies to a specified range of consecutive |
| 1367 | dates. Here is a block diary entry that applies to all dates from June | 1369 | dates. Here is a block diary entry that applies to all dates from June |
| 1368 | 24, 1990 through July 10, 1990: | 1370 | 24, 2012 through July 10, 2012: |
| 1369 | 1371 | ||
| 1370 | @findex diary-block | 1372 | @findex diary-block |
| 1371 | @example | 1373 | @example |
| 1372 | %%(diary-block 6 24 1990 7 10 1990) Vacation | 1374 | %%(diary-block 6 24 2012 7 10 2012) Vacation |
| 1373 | @end example | 1375 | @end example |
| 1374 | 1376 | ||
| 1375 | @noindent | 1377 | @noindent |
| 1376 | The @samp{6 24 1990} indicates the starting date and the @samp{7 10 1990} | 1378 | The @samp{6 24 2012} indicates the starting date and the @samp{7 10 2012} |
| 1377 | indicates the stopping date. (Again, if you are using the European or ISO | 1379 | indicates the stopping date. (Again, if you are using the European or ISO |
| 1378 | calendar style, the input order of month, day and year is different.) | 1380 | calendar style, the input order of month, day and year is different.) |
| 1379 | 1381 | ||
| @@ -1393,23 +1395,23 @@ which looks like this: | |||
| 1393 | 1395 | ||
| 1394 | @findex diary-cyclic | 1396 | @findex diary-cyclic |
| 1395 | @example | 1397 | @example |
| 1396 | %%(diary-cyclic 50 3 1 1990) Renew medication | 1398 | %%(diary-cyclic 50 3 1 2012) Renew medication |
| 1397 | @end example | 1399 | @end example |
| 1398 | 1400 | ||
| 1399 | @noindent | 1401 | @noindent |
| 1400 | This entry applies to March 1, 1990 and every 50th day following; | 1402 | This entry applies to March 1, 2012 and every 50th day following; |
| 1401 | @samp{3 1 1990} specifies the starting date. (If you are using the | 1403 | @samp{3 1 2012} specifies the starting date. (If you are using the |
| 1402 | European or ISO calendar style, the input order of month, day and year | 1404 | European or ISO calendar style, the input order of month, day and year |
| 1403 | is different.) | 1405 | is different.) |
| 1404 | 1406 | ||
| 1405 | All three of these commands make marking diary entries. To insert a | 1407 | All three of these commands make marking diary entries. To insert a |
| 1406 | nonmarking entry, give a numeric argument to the command. For example, | 1408 | nonmarking entry, give a prefix argument to the command. For example, |
| 1407 | @kbd{C-u i a} makes a nonmarking anniversary diary entry. | 1409 | @kbd{C-u i a} makes a nonmarking anniversary diary entry. |
| 1408 | 1410 | ||
| 1409 | Marking sexp diary entries in the calendar is @emph{extremely} | 1411 | Marking sexp diary entries in the calendar can be time-consuming, |
| 1410 | time-consuming, since every date visible in the calendar window must be | 1412 | since every date visible in the calendar window must be individually |
| 1411 | individually checked. So it's a good idea to make sexp diary entries | 1413 | checked. So it's a good idea to make sexp diary entries nonmarking |
| 1412 | nonmarking (with @samp{&}) when possible. | 1414 | (with @samp{&}) when possible. |
| 1413 | 1415 | ||
| 1414 | Another sophisticated kind of sexp entry, a @dfn{floating} diary entry, | 1416 | Another sophisticated kind of sexp entry, a @dfn{floating} diary entry, |
| 1415 | specifies a regularly occurring event by offsets specified in days, | 1417 | specifies a regularly occurring event by offsets specified in days, |
| @@ -1451,8 +1453,8 @@ can perform arbitrary computations to determine when they apply. | |||
| 1451 | @vindex appt-audible | 1453 | @vindex appt-audible |
| 1452 | @vindex appt-display-mode-line | 1454 | @vindex appt-display-mode-line |
| 1453 | If you have a diary entry for an appointment, and that diary entry | 1455 | If you have a diary entry for an appointment, and that diary entry |
| 1454 | begins with a recognizable time of day, Emacs can warn you several | 1456 | begins with a recognizable time of day, Emacs can warn you in advance |
| 1455 | minutes beforehand that that appointment is pending. Emacs alerts you | 1457 | that an appointment is pending. Emacs alerts you |
| 1456 | to the appointment by displaying a message in your chosen format, as | 1458 | to the appointment by displaying a message in your chosen format, as |
| 1457 | specified by the variable @code{appt-display-format}. If the value of | 1459 | specified by the variable @code{appt-display-format}. If the value of |
| 1458 | @code{appt-audible} is non-@code{nil}, the warning includes an audible | 1460 | @code{appt-audible} is non-@code{nil}, the warning includes an audible |
| @@ -1539,6 +1541,7 @@ diary-from-outlook} to import the entry. You can make this command | |||
| 1539 | recognize additional appointment message formats by customizing the | 1541 | recognize additional appointment message formats by customizing the |
| 1540 | variable @code{diary-outlook-formats}. | 1542 | variable @code{diary-outlook-formats}. |
| 1541 | 1543 | ||
| 1544 | @c FIXME the name of the RFC is hardly very relevant. | ||
| 1542 | @cindex iCalendar support | 1545 | @cindex iCalendar support |
| 1543 | The icalendar package allows you to transfer data between your Emacs | 1546 | The icalendar package allows you to transfer data between your Emacs |
| 1544 | diary file and iCalendar files, which are defined in ``RFC | 1547 | diary file and iCalendar files, which are defined in ``RFC |
| @@ -1553,7 +1556,7 @@ diary file and iCalendar files, which are defined in ``RFC | |||
| 1553 | 1556 | ||
| 1554 | @findex icalendar-import-buffer | 1557 | @findex icalendar-import-buffer |
| 1555 | The command @code{icalendar-import-buffer} extracts | 1558 | The command @code{icalendar-import-buffer} extracts |
| 1556 | iCalendar data from the current buffer and adds it to your (default) | 1559 | iCalendar data from the current buffer and adds it to your |
| 1557 | diary file. This function is also suitable for automatic extraction of | 1560 | diary file. This function is also suitable for automatic extraction of |
| 1558 | iCalendar data; for example with the Rmail mail client one could use: | 1561 | iCalendar data; for example with the Rmail mail client one could use: |
| 1559 | 1562 | ||
| @@ -1585,7 +1588,7 @@ to the main diary file, if these are different files. | |||
| 1585 | Use @code{icalendar-export-file} to interactively export an entire | 1588 | Use @code{icalendar-export-file} to interactively export an entire |
| 1586 | Emacs diary file to iCalendar format. To export only a part of a diary | 1589 | Emacs diary file to iCalendar format. To export only a part of a diary |
| 1587 | file, mark the relevant area, and call @code{icalendar-export-region}. | 1590 | file, mark the relevant area, and call @code{icalendar-export-region}. |
| 1588 | In both cases the result is appended to the target file. | 1591 | In both cases, Emacs appends the result to the target file. |
| 1589 | 1592 | ||
| 1590 | @node Daylight Saving | 1593 | @node Daylight Saving |
| 1591 | @section Daylight Saving Time | 1594 | @section Daylight Saving Time |
| @@ -1691,7 +1694,7 @@ workday in the mode line, either customize the | |||
| 1691 | @vindex timeclock-ask-before-exiting | 1694 | @vindex timeclock-ask-before-exiting |
| 1692 | Terminating the current Emacs session might or might not mean that | 1695 | Terminating the current Emacs session might or might not mean that |
| 1693 | you have stopped working on the project and, by default, Emacs asks | 1696 | you have stopped working on the project and, by default, Emacs asks |
| 1694 | you. You can, however, set customize the value of the variable | 1697 | you. You can, however, customize the value of the variable |
| 1695 | @code{timeclock-ask-before-exiting} to @code{nil} to avoid the question; | 1698 | @code{timeclock-ask-before-exiting} to @code{nil} to avoid the question; |
| 1696 | then, only an explicit @kbd{M-x timeclock-out} or @kbd{M-x | 1699 | then, only an explicit @kbd{M-x timeclock-out} or @kbd{M-x |
| 1697 | timeclock-change} will tell Emacs that the current interval is over. | 1700 | timeclock-change} will tell Emacs that the current interval is over. |