diff options
| -rw-r--r-- | doc/emacs/calendar.texi | 170 | ||||
| -rw-r--r-- | doc/emacs/emacs.texi | 2 |
2 files changed, 86 insertions, 86 deletions
diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index 92f5c91941..6a387e6409 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi @@ -929,13 +929,97 @@ provides a number of commands to let you view, add, and change diary entries. @menu -* Displaying the Diary:: Viewing diary entries and associated calendar dates. * Format of Diary File:: Entering events in your diary. +* Displaying the Diary:: Viewing diary entries and associated calendar dates. * Date Formats:: Various ways you can specify dates. * Adding to Diary:: Commands to create diary entries. * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. @end menu +@node Format of Diary File +@subsection The Diary File +@cindex diary file + +@vindex diary-file + Your @dfn{diary file} is a file that records events associated with +particular dates. The name of the diary file is specified by the +variable @code{diary-file}. The default is @file{~/.emacs.d/diary}, +though for compatibility with older versions Emacs will use +@file{~/diary} if it exists. +@ignore +@c I don't think this is relevant any more. The utility doesn't seem +@c to be part of the default install on GNU/Linux machines these days. +@c When I tried it with my basic diary file, it just died with an error. +The @code{calendar} utility program supports a subset of the format +allowed by the Emacs diary facilities, so you can use that utility to +view the diary file, with reasonable results aside from the entries it +cannot understand. +@end ignore + + Each entry in the diary file describes one event and consists of one +or more lines. An entry always begins with a date specification at the +left margin. The rest of the entry is simply text to describe the +event. If the entry has more than one line, then the lines after the +first must begin with whitespace to indicate they continue a previous +entry. Lines that do not begin with valid dates and do not continue a +preceding entry are ignored. Here's an example: + +@example +12/22/2015 Twentieth wedding anniversary! +&1/1. Happy New Year! +10/22 Ruth's birthday. +* 21, *: Payday +Tuesday--weekly meeting with grad students at 10am + Supowit, Shen, Bitner, and Kapoor to attend. +1/13/89 Friday the thirteenth!! +&thu 4pm squash game with Lloyd. +mar 16 Dad's birthday +April 15, 2016 Income tax due. +&* 15 time cards due. +@end example + +@noindent +This example uses extra spaces to align the event descriptions of most +of the entries. Such formatting is purely a matter of taste. + + You can also use a format where the first line of a diary entry +consists only of the date or day name (with no following blanks or +punctuation). For example: + +@example +02/11/2012 + Bill B. visits Princeton today + 2pm Cognitive Studies Committee meeting + 2:30-5:30 Liz at Lawrenceville + 4:00pm Dentist appt + 7:30pm Dinner at George's + 8:00-10:00pm concert +@end example + +@noindent +This entry will have a different appearance if you use the simple diary +display +@iftex +(@pxref{Diary Display,,, emacs-xtra, Specialized Emacs Features}). +@end iftex +@ifnottex +(@pxref{Diary Display}). +@end ifnottex +The simple diary display omits the date line at the beginning; only the +continuation lines appear. This style of entry looks neater when you +display just a single day's entries, but can cause confusion if you ask +for more than one day's entries. + +@vindex diary-nonmarking-symbol + You can inhibit the marking of certain diary entries in the calendar +window; to do this, insert the string that +@code{diary-nonmarking-symbol} specifies (default @samp{&}) at the +beginning of the entry, before the date. This +has no effect on display of the entry in the diary window; it only +affects marks on dates in the calendar window. Nonmarking entries are +especially useful for generic entries that would otherwise mark many +different dates. + @node Displaying the Diary @subsection Displaying the Diary @@ -1037,90 +1121,6 @@ diary-mail-entries}. A prefix argument specifies how many days (starting with today) to check; otherwise, the variable @code{diary-mail-days} says how many days. -@node Format of Diary File -@subsection The Diary File -@cindex diary file - -@vindex diary-file - Your @dfn{diary file} is a file that records events associated with -particular dates. The name of the diary file is specified by the -variable @code{diary-file}. The default is @file{~/.emacs.d/diary}, -though for compatibility with older versions Emacs will use -@file{~/diary} if it exists. -@ignore -@c I don't think this is relevant any more. The utility doesn't seem -@c to be part of the default install on GNU/Linux machines these days. -@c When I tried it with my basic diary file, it just died with an error. -The @code{calendar} utility program supports a subset of the format -allowed by the Emacs diary facilities, so you can use that utility to -view the diary file, with reasonable results aside from the entries it -cannot understand. -@end ignore - - Each entry in the diary file describes one event and consists of one -or more lines. An entry always begins with a date specification at the -left margin. The rest of the entry is simply text to describe the -event. If the entry has more than one line, then the lines after the -first must begin with whitespace to indicate they continue a previous -entry. Lines that do not begin with valid dates and do not continue a -preceding entry are ignored. Here's an example: - -@example -12/22/2015 Twentieth wedding anniversary! -&1/1. Happy New Year! -10/22 Ruth's birthday. -* 21, *: Payday -Tuesday--weekly meeting with grad students at 10am - Supowit, Shen, Bitner, and Kapoor to attend. -1/13/89 Friday the thirteenth!! -&thu 4pm squash game with Lloyd. -mar 16 Dad's birthday -April 15, 2016 Income tax due. -&* 15 time cards due. -@end example - -@noindent -This example uses extra spaces to align the event descriptions of most -of the entries. Such formatting is purely a matter of taste. - - You can also use a format where the first line of a diary entry -consists only of the date or day name (with no following blanks or -punctuation). For example: - -@example -02/11/2012 - Bill B. visits Princeton today - 2pm Cognitive Studies Committee meeting - 2:30-5:30 Liz at Lawrenceville - 4:00pm Dentist appt - 7:30pm Dinner at George's - 8:00-10:00pm concert -@end example - -@noindent -This entry will have a different appearance if you use the simple diary -display -@iftex -(@pxref{Diary Display,,, emacs-xtra, Specialized Emacs Features}). -@end iftex -@ifnottex -(@pxref{Diary Display}). -@end ifnottex -The simple diary display omits the date line at the beginning; only the -continuation lines appear. This style of entry looks neater when you -display just a single day's entries, but can cause confusion if you ask -for more than one day's entries. - -@vindex diary-nonmarking-symbol - You can inhibit the marking of certain diary entries in the calendar -window; to do this, insert the string that -@code{diary-nonmarking-symbol} specifies (default @samp{&}) at the -beginning of the entry, before the date. This -has no effect on display of the entry in the diary window; it only -affects marks on dates in the calendar window. Nonmarking entries are -especially useful for generic entries that would otherwise mark many -different dates. - @node Date Formats @subsection Date Formats diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 713bf8b9f8..5f53f9bf1d 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -961,8 +961,8 @@ Conversion To and From Other Calendars The Diary -* Displaying the Diary:: Viewing diary entries and associated calendar dates. * Format of Diary File:: Entering events in your diary. +* Displaying the Diary:: Viewing diary entries and associated calendar dates. * Date Formats:: Various ways you can specify dates. * Adding to Diary:: Commands to create diary entries. * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. |