Mercurial > emacs
comparison lisp/calendar/calendar.el @ 93278:58366e03a762
(diary-file): Doc fix.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Thu, 27 Mar 2008 07:27:48 +0000 |
parents | 940127da5863 |
children | 1515466cea2b |
comparison
equal
deleted
inserted
replaced
93277:50111e15bae9 | 93278:58366e03a762 |
---|---|
328 ;;;###autoload | 328 ;;;###autoload |
329 (defcustom diary-file "~/diary" | 329 (defcustom diary-file "~/diary" |
330 "Name of the file in which one's personal diary of dates is kept. | 330 "Name of the file in which one's personal diary of dates is kept. |
331 | 331 |
332 The file's entries are lines beginning with any of the forms | 332 The file's entries are lines beginning with any of the forms |
333 specified by the variable `american-date-diary-pattern', by default: | 333 specified by the variable `diary-date-forms', which by default |
334 uses the forms of `american-date-diary-pattern': | |
334 | 335 |
335 MONTH/DAY | 336 MONTH/DAY |
336 MONTH/DAY/YEAR | 337 MONTH/DAY/YEAR |
337 MONTHNAME DAY | 338 MONTHNAME DAY |
338 MONTHNAME DAY, YEAR | 339 MONTHNAME DAY, YEAR |
341 with the remainder of the line being the diary entry string for | 342 with the remainder of the line being the diary entry string for |
342 that date. MONTH and DAY are one or two digit numbers, YEAR is a | 343 that date. MONTH and DAY are one or two digit numbers, YEAR is a |
343 number and may be written in full or abbreviated to the final two | 344 number and may be written in full or abbreviated to the final two |
344 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME | 345 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME |
345 and DAYNAME can be spelled in full (as specified by the variables | 346 and DAYNAME can be spelled in full (as specified by the variables |
346 `calendar-month-name-array' and `calendar-day-name-array'), | 347 `calendar-month-name-array' and `calendar-day-name-array'), or |
347 abbreviated (as specified by `calendar-month-abbrev-array' and | 348 abbreviated (as specified by `calendar-month-abbrev-array' and |
348 `calendar-day-abbrev-array') with or without a period, | 349 `calendar-day-abbrev-array') with or without a period. Case is |
349 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be | 350 ignored. Any of DAY, MONTH, or MONTHNAME, YEAR can be `*' which |
350 `*' which matches any day, month, or year, respectively. If the | 351 matches any day, month, or year, respectively. If the date does |
351 date does not contain a year, it is generic and applies to any | 352 not contain a year, it is generic and applies to any year. A |
352 year. A DAYNAME entry applies to the appropriate day of the week | 353 DAYNAME entry applies to the appropriate day of the week in every week. |
353 in every week. | |
354 | 354 |
355 The European style (in which the day precedes the month) can be | 355 The European style (in which the day precedes the month) can be |
356 used instead, if you execute `european-calendar' when in the | 356 used instead, if you execute `european-calendar' when in the |
357 calendar, or set `european-calendar-style' to t in your .emacs | 357 calendar, or set `european-calendar-style' to t in your .emacs |
358 file. The European forms (see `european-date-diary-pattern') are | 358 file. The European forms (see `european-date-diary-pattern') are |
364 DAYNAME | 364 DAYNAME |
365 | 365 |
366 To revert to the default American style from the European style, execute | 366 To revert to the default American style from the European style, execute |
367 `american-calendar' in the calendar. | 367 `american-calendar' in the calendar. |
368 | 368 |
369 A diary entry can be preceded by the character | 369 A diary entry can be preceded by the character `diary-nonmarking-symbol' |
370 `diary-nonmarking-symbol' (ordinarily `&') to make that entry | 370 \(ordinarily `&') to make that entry nonmarking--that is, it will not be |
371 nonmarking--that is, it will not be marked on dates in the calendar | 371 marked on dates in the calendar window but will appear in a diary window. |
372 window but will appear in a diary window. | |
373 | 372 |
374 Multiline diary entries are made by indenting lines after the first with | 373 Multiline diary entries are made by indenting lines after the first with |
375 either a TAB or one or more spaces. | 374 either a TAB or one or more spaces. |
376 | 375 |
377 Lines not in one the above formats are ignored. Here are some sample diary | 376 Lines not in one the above formats are ignored. Here are some sample diary |
409 Diary entries can be based on Lisp sexps. For example, the diary entry | 408 Diary entries can be based on Lisp sexps. For example, the diary entry |
410 | 409 |
411 %%(diary-block 11 1 1990 11 10 1990) Vacation | 410 %%(diary-block 11 1 1990 11 10 1990) Vacation |
412 | 411 |
413 causes the diary entry \"Vacation\" to appear from November 1 through | 412 causes the diary entry \"Vacation\" to appear from November 1 through |
414 November 10, 1990. Other functions available are `diary-float', | 413 November 10, 1990. See the documentation for the function |
415 `diary-anniversary', `diary-cyclic', `diary-day-of-year', | 414 `list-sexp-diary-entries' for more details. |
416 `diary-iso-date', `diary-french-date', `diary-hebrew-date', | |
417 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date', | |
418 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date', | |
419 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset', | |
420 `diary-phases-of-moon', `diary-parasha', `diary-omer', | |
421 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the | |
422 documentation for the function `list-sexp-diary-entries' for more | |
423 details. | |
424 | 415 |
425 Diary entries based on the Hebrew, the Islamic and/or the Baha'i | 416 Diary entries based on the Hebrew, the Islamic and/or the Baha'i |
426 calendar are also possible, but because these are somewhat slow, they | 417 calendar are also possible, but because these are somewhat slow, they |
427 are ignored unless you set the `nongregorian-diary-listing-hook' and | 418 are ignored unless you set the `nongregorian-diary-listing-hook' and |
428 the `nongregorian-diary-marking-hook' appropriately. See the | 419 the `nongregorian-diary-marking-hook' appropriately. See the |