diff options
| author | Glenn Morris | 2015-06-15 23:53:24 -0700 |
|---|---|---|
| committer | Glenn Morris | 2015-06-15 23:53:24 -0700 |
| commit | b73912bd2ecb1ca1250286b0bf7ce9672c53323f (patch) | |
| tree | 0d088f60de39710db34ba2f6fd389cc1ba6f9b2d | |
| parent | bb53338aaf81bf9f41c4d80d265ddcbd4529b5de (diff) | |
| download | emacs-b73912bd2ecb1ca1250286b0bf7ce9672c53323f.tar.gz emacs-b73912bd2ecb1ca1250286b0bf7ce9672c53323f.zip | |
* doc/emacs/calendar.texi (Format of Diary File, Displaying the Diary):
Swap the order of these nodes.
* doc/emacs/emacs.texi: Update detailed menu for the above change.
| -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 92f5c919414..6a387e6409a 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 | |||
| 929 | entries. | 929 | entries. |
| 930 | 930 | ||
| 931 | @menu | 931 | @menu |
| 932 | * Displaying the Diary:: Viewing diary entries and associated calendar dates. | ||
| 933 | * Format of Diary File:: Entering events in your diary. | 932 | * Format of Diary File:: Entering events in your diary. |
| 933 | * Displaying the Diary:: Viewing diary entries and associated calendar dates. | ||
| 934 | * Date Formats:: Various ways you can specify dates. | 934 | * Date Formats:: Various ways you can specify dates. |
| 935 | * Adding to Diary:: Commands to create diary entries. | 935 | * Adding to Diary:: Commands to create diary entries. |
| 936 | * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. | 936 | * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. |
| 937 | @end menu | 937 | @end menu |
| 938 | 938 | ||
| 939 | @node Format of Diary File | ||
| 940 | @subsection The Diary File | ||
| 941 | @cindex diary file | ||
| 942 | |||
| 943 | @vindex diary-file | ||
| 944 | Your @dfn{diary file} is a file that records events associated with | ||
| 945 | particular dates. The name of the diary file is specified by the | ||
| 946 | variable @code{diary-file}. The default is @file{~/.emacs.d/diary}, | ||
| 947 | though for compatibility with older versions Emacs will use | ||
| 948 | @file{~/diary} if it exists. | ||
| 949 | @ignore | ||
| 950 | @c I don't think this is relevant any more. The utility doesn't seem | ||
| 951 | @c to be part of the default install on GNU/Linux machines these days. | ||
| 952 | @c When I tried it with my basic diary file, it just died with an error. | ||
| 953 | The @code{calendar} utility program supports a subset of the format | ||
| 954 | allowed by the Emacs diary facilities, so you can use that utility to | ||
| 955 | view the diary file, with reasonable results aside from the entries it | ||
| 956 | cannot understand. | ||
| 957 | @end ignore | ||
| 958 | |||
| 959 | Each entry in the diary file describes one event and consists of one | ||
| 960 | or more lines. An entry always begins with a date specification at the | ||
| 961 | left margin. The rest of the entry is simply text to describe the | ||
| 962 | event. If the entry has more than one line, then the lines after the | ||
| 963 | first must begin with whitespace to indicate they continue a previous | ||
| 964 | entry. Lines that do not begin with valid dates and do not continue a | ||
| 965 | preceding entry are ignored. Here's an example: | ||
| 966 | |||
| 967 | @example | ||
| 968 | 12/22/2015 Twentieth wedding anniversary! | ||
| 969 | &1/1. Happy New Year! | ||
| 970 | 10/22 Ruth's birthday. | ||
| 971 | * 21, *: Payday | ||
| 972 | Tuesday--weekly meeting with grad students at 10am | ||
| 973 | Supowit, Shen, Bitner, and Kapoor to attend. | ||
| 974 | 1/13/89 Friday the thirteenth!! | ||
| 975 | &thu 4pm squash game with Lloyd. | ||
| 976 | mar 16 Dad's birthday | ||
| 977 | April 15, 2016 Income tax due. | ||
| 978 | &* 15 time cards due. | ||
| 979 | @end example | ||
| 980 | |||
| 981 | @noindent | ||
| 982 | This example uses extra spaces to align the event descriptions of most | ||
| 983 | of the entries. Such formatting is purely a matter of taste. | ||
| 984 | |||
| 985 | You can also use a format where the first line of a diary entry | ||
| 986 | consists only of the date or day name (with no following blanks or | ||
| 987 | punctuation). For example: | ||
| 988 | |||
| 989 | @example | ||
| 990 | 02/11/2012 | ||
| 991 | Bill B. visits Princeton today | ||
| 992 | 2pm Cognitive Studies Committee meeting | ||
| 993 | 2:30-5:30 Liz at Lawrenceville | ||
| 994 | 4:00pm Dentist appt | ||
| 995 | 7:30pm Dinner at George's | ||
| 996 | 8:00-10:00pm concert | ||
| 997 | @end example | ||
| 998 | |||
| 999 | @noindent | ||
| 1000 | This entry will have a different appearance if you use the simple diary | ||
| 1001 | display | ||
| 1002 | @iftex | ||
| 1003 | (@pxref{Diary Display,,, emacs-xtra, Specialized Emacs Features}). | ||
| 1004 | @end iftex | ||
| 1005 | @ifnottex | ||
| 1006 | (@pxref{Diary Display}). | ||
| 1007 | @end ifnottex | ||
| 1008 | The simple diary display omits the date line at the beginning; only the | ||
| 1009 | continuation lines appear. This style of entry looks neater when you | ||
| 1010 | display just a single day's entries, but can cause confusion if you ask | ||
| 1011 | for more than one day's entries. | ||
| 1012 | |||
| 1013 | @vindex diary-nonmarking-symbol | ||
| 1014 | You can inhibit the marking of certain diary entries in the calendar | ||
| 1015 | window; to do this, insert the string that | ||
| 1016 | @code{diary-nonmarking-symbol} specifies (default @samp{&}) at the | ||
| 1017 | beginning of the entry, before the date. This | ||
| 1018 | has no effect on display of the entry in the diary window; it only | ||
| 1019 | affects marks on dates in the calendar window. Nonmarking entries are | ||
| 1020 | especially useful for generic entries that would otherwise mark many | ||
| 1021 | different dates. | ||
| 1022 | |||
| 939 | @node Displaying the Diary | 1023 | @node Displaying the Diary |
| 940 | @subsection Displaying the Diary | 1024 | @subsection Displaying the Diary |
| 941 | 1025 | ||
| @@ -1037,90 +1121,6 @@ diary-mail-entries}. A prefix argument specifies how many days | |||
| 1037 | (starting with today) to check; otherwise, the variable | 1121 | (starting with today) to check; otherwise, the variable |
| 1038 | @code{diary-mail-days} says how many days. | 1122 | @code{diary-mail-days} says how many days. |
| 1039 | 1123 | ||
| 1040 | @node Format of Diary File | ||
| 1041 | @subsection The Diary File | ||
| 1042 | @cindex diary file | ||
| 1043 | |||
| 1044 | @vindex diary-file | ||
| 1045 | Your @dfn{diary file} is a file that records events associated with | ||
| 1046 | particular dates. The name of the diary file is specified by the | ||
| 1047 | variable @code{diary-file}. The default is @file{~/.emacs.d/diary}, | ||
| 1048 | though for compatibility with older versions Emacs will use | ||
| 1049 | @file{~/diary} if it exists. | ||
| 1050 | @ignore | ||
| 1051 | @c I don't think this is relevant any more. The utility doesn't seem | ||
| 1052 | @c to be part of the default install on GNU/Linux machines these days. | ||
| 1053 | @c When I tried it with my basic diary file, it just died with an error. | ||
| 1054 | The @code{calendar} utility program supports a subset of the format | ||
| 1055 | allowed by the Emacs diary facilities, so you can use that utility to | ||
| 1056 | view the diary file, with reasonable results aside from the entries it | ||
| 1057 | cannot understand. | ||
| 1058 | @end ignore | ||
| 1059 | |||
| 1060 | Each entry in the diary file describes one event and consists of one | ||
| 1061 | or more lines. An entry always begins with a date specification at the | ||
| 1062 | left margin. The rest of the entry is simply text to describe the | ||
| 1063 | event. If the entry has more than one line, then the lines after the | ||
| 1064 | first must begin with whitespace to indicate they continue a previous | ||
| 1065 | entry. Lines that do not begin with valid dates and do not continue a | ||
| 1066 | preceding entry are ignored. Here's an example: | ||
| 1067 | |||
| 1068 | @example | ||
| 1069 | 12/22/2015 Twentieth wedding anniversary! | ||
| 1070 | &1/1. Happy New Year! | ||
| 1071 | 10/22 Ruth's birthday. | ||
| 1072 | * 21, *: Payday | ||
| 1073 | Tuesday--weekly meeting with grad students at 10am | ||
| 1074 | Supowit, Shen, Bitner, and Kapoor to attend. | ||
| 1075 | 1/13/89 Friday the thirteenth!! | ||
| 1076 | &thu 4pm squash game with Lloyd. | ||
| 1077 | mar 16 Dad's birthday | ||
| 1078 | April 15, 2016 Income tax due. | ||
| 1079 | &* 15 time cards due. | ||
| 1080 | @end example | ||
| 1081 | |||
| 1082 | @noindent | ||
| 1083 | This example uses extra spaces to align the event descriptions of most | ||
| 1084 | of the entries. Such formatting is purely a matter of taste. | ||
| 1085 | |||
| 1086 | You can also use a format where the first line of a diary entry | ||
| 1087 | consists only of the date or day name (with no following blanks or | ||
| 1088 | punctuation). For example: | ||
| 1089 | |||
| 1090 | @example | ||
| 1091 | 02/11/2012 | ||
| 1092 | Bill B. visits Princeton today | ||
| 1093 | 2pm Cognitive Studies Committee meeting | ||
| 1094 | 2:30-5:30 Liz at Lawrenceville | ||
| 1095 | 4:00pm Dentist appt | ||
| 1096 | 7:30pm Dinner at George's | ||
| 1097 | 8:00-10:00pm concert | ||
| 1098 | @end example | ||
| 1099 | |||
| 1100 | @noindent | ||
| 1101 | This entry will have a different appearance if you use the simple diary | ||
| 1102 | display | ||
| 1103 | @iftex | ||
| 1104 | (@pxref{Diary Display,,, emacs-xtra, Specialized Emacs Features}). | ||
| 1105 | @end iftex | ||
| 1106 | @ifnottex | ||
| 1107 | (@pxref{Diary Display}). | ||
| 1108 | @end ifnottex | ||
| 1109 | The simple diary display omits the date line at the beginning; only the | ||
| 1110 | continuation lines appear. This style of entry looks neater when you | ||
| 1111 | display just a single day's entries, but can cause confusion if you ask | ||
| 1112 | for more than one day's entries. | ||
| 1113 | |||
| 1114 | @vindex diary-nonmarking-symbol | ||
| 1115 | You can inhibit the marking of certain diary entries in the calendar | ||
| 1116 | window; to do this, insert the string that | ||
| 1117 | @code{diary-nonmarking-symbol} specifies (default @samp{&}) at the | ||
| 1118 | beginning of the entry, before the date. This | ||
| 1119 | has no effect on display of the entry in the diary window; it only | ||
| 1120 | affects marks on dates in the calendar window. Nonmarking entries are | ||
| 1121 | especially useful for generic entries that would otherwise mark many | ||
| 1122 | different dates. | ||
| 1123 | |||
| 1124 | @node Date Formats | 1124 | @node Date Formats |
| 1125 | @subsection Date Formats | 1125 | @subsection Date Formats |
| 1126 | 1126 | ||
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 713bf8b9f89..5f53f9bf1dd 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi | |||
| @@ -961,8 +961,8 @@ Conversion To and From Other Calendars | |||
| 961 | 961 | ||
| 962 | The Diary | 962 | The Diary |
| 963 | 963 | ||
| 964 | * Displaying the Diary:: Viewing diary entries and associated calendar dates. | ||
| 965 | * Format of Diary File:: Entering events in your diary. | 964 | * Format of Diary File:: Entering events in your diary. |
| 965 | * Displaying the Diary:: Viewing diary entries and associated calendar dates. | ||
| 966 | * Date Formats:: Various ways you can specify dates. | 966 | * Date Formats:: Various ways you can specify dates. |
| 967 | * Adding to Diary:: Commands to create diary entries. | 967 | * Adding to Diary:: Commands to create diary entries. |
| 968 | * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. | 968 | * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. |