Rename a new cal-tex function, document it

[gnu-emacs] / doc / emacs / calendar.texi

diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi
index c2851d4abd3eb6edf099f4782723dd4eb7aaaf08..d46e26cddcf908189bf02906b13b5e6fd4977c96 100644 (file)
--- a/doc/emacs/calendar.texi
+++ b/doc/emacs/calendar.texi
@@ -26,8 +26,8 @@ the calendar, type @kbd{q}.
 
 @iftex
   This chapter describes the basic calendar features.
 
 @iftex
   This chapter describes the basic calendar features.

-@inforef{Advanced Calendar/Diary Usage,, emacs-xtra}, for information
-about more specialized features.
+For more advanced topics,
+@pxref{Advanced Calendar/Diary Usage,,, emacs-xtra, Specialized Emacs Features}.

 @end iftex
 
 @menu
 @end iftex
 
 @menu


@@ -245,10 +245,10 @@ Scroll calendar one month forward (@code{calendar-scroll-left}).
 Scroll calendar one month backward (@code{calendar-scroll-right}).
 @item C-v
 @itemx @key{next}
 Scroll calendar one month backward (@code{calendar-scroll-right}).
 @item C-v
 @itemx @key{next}

-Scroll three months forward (@code{calendar-scroll-left-three-months}).
+Scroll forward by three months (@code{calendar-scroll-left-three-months}).

 @item M-v
 @itemx @key{prior}
 @item M-v
 @itemx @key{prior}

-Scroll three months backward (@code{calendar-scroll-right-three-months}).
+Scroll backward by three months (@code{calendar-scroll-right-three-months}).

 @end table
 
 @kindex > @r{(Calendar mode)}
 @end table
 
 @kindex > @r{(Calendar mode)}


@@ -345,7 +345,7 @@ calendar deletes or iconifies that frame depending on the value of
 @node Writing Calendar Files
 @section Writing Calendar Files
 
 @node Writing Calendar Files
 @section Writing Calendar Files
 

-  You can write calendars and diary entries to HTML and La@TeX{} files.
+  You can write calendars and diary entries to HTML and @LaTeX{} files.

 
 @cindex calendar and HTML
   The Calendar HTML commands produce files of HTML code that contain
 
 @cindex calendar and HTML
   The Calendar HTML commands produce files of HTML code that contain


@@ -380,8 +380,8 @@ non-@code{nil}, then the monthly calendars show the day-of-the-year
 number. The variable @code{cal-html-year-index-cols} specifies the
 number of columns in the yearly index page.
 
 number. The variable @code{cal-html-year-index-cols} specifies the
 number of columns in the yearly index page.
 

-@cindex calendar and La@TeX{}
-  The Calendar La@TeX{} commands produce a buffer of La@TeX{} code that
+@cindex calendar and @LaTeX{}
+  The Calendar @LaTeX{} commands produce a buffer of @LaTeX{} code that

 prints as a calendar.  Depending on the command you use, the printed
 calendar covers the day, week, month or year that point is in.
 
 prints as a calendar.  Depending on the command you use, the printed
 calendar covers the day, week, month or year that point is in.
 


@@ -396,17 +396,20 @@ Generate a sideways-printing one-month calendar
 Generate a one-day calendar
 (@code{cal-tex-cursor-day}).
 @item t w 1
 Generate a one-day calendar
 (@code{cal-tex-cursor-day}).
 @item t w 1

-Generate a one-page calendar for one week
+Generate a one-page calendar for one week, with hours

 (@code{cal-tex-cursor-week}).
 @item t w 2
 (@code{cal-tex-cursor-week}).
 @item t w 2

-Generate a two-page calendar for one week
+Generate a two-page calendar for one week, with hours

 (@code{cal-tex-cursor-week2}).
 @item t w 3
 (@code{cal-tex-cursor-week2}).
 @item t w 3

-Generate an ISO-style calendar for one week
+Generate an ISO-style calendar for one week, without hours

 (@code{cal-tex-cursor-week-iso}).
 @item t w 4
 (@code{cal-tex-cursor-week-iso}).
 @item t w 4

-Generate a calendar for one Monday-starting week
+Generate a calendar for one Monday-starting week, with hours

 (@code{cal-tex-cursor-week-monday}).
 (@code{cal-tex-cursor-week-monday}).

+@item t w W
+Generate a two-page calendar for one week, without hours
+(@code{cal-tex-cursor-week2-summary}).

 @item t f w
 Generate a Filofax-style two-weeks-at-a-glance calendar
 (@code{cal-tex-cursor-filofax-2week}).
 @item t f w
 Generate a Filofax-style two-weeks-at-a-glance calendar
 (@code{cal-tex-cursor-filofax-2week}).


@@ -441,7 +444,7 @@ the individual cal-tex functions to see which calendars support which
 features.
 
   You can use the variable @code{cal-tex-preamble-extra} to insert extra
 features.
 
   You can use the variable @code{cal-tex-preamble-extra} to insert extra

-La@TeX{} commands in the preamble of the generated document if you need
+@LaTeX{} commands in the preamble of the generated document if you need

 to.
 
 @node Holidays
 to.
 
 @node Holidays


@@ -489,7 +492,7 @@ window.
 calendar, use the @kbd{x} command.  This displays the dates that are
 holidays in a different face.
 @iftex
 calendar, use the @kbd{x} command.  This displays the dates that are
 holidays in a different face.
 @iftex

-@inforef{Calendar Customizing, calendar-holiday-marker, emacs-xtra}.
+@xref{Calendar Customizing,,, emacs-xtra, Specialized Emacs Features}.

 @end iftex
 @ifnottex
 @xref{Calendar Customizing, calendar-holiday-marker}.
 @end iftex
 @ifnottex
 @xref{Calendar Customizing, calendar-holiday-marker}.


@@ -624,7 +627,7 @@ for all users in a @file{default.el} file.  @xref{Init File}.
   These calendar commands display the dates and times of the phases of
 the moon (new moon, first quarter, full moon, last quarter).  This
 feature is useful for debugging problems that ``depend on the phase of
   These calendar commands display the dates and times of the phases of
 the moon (new moon, first quarter, full moon, last quarter).  This
 feature is useful for debugging problems that ``depend on the phase of

-the moon.''
+the moon''.

 
 @table @kbd
 @item M
 
 @table @kbd
 @item M


@@ -822,7 +825,7 @@ Display Mayan date for selected day (@code{calendar-mayan-print-date}).
 
   Otherwise, move point to the date you want to convert, then type the
 appropriate command starting with @kbd{p} from the table above.  The
 
   Otherwise, move point to the date you want to convert, then type the
 appropriate command starting with @kbd{p} from the table above.  The

-prefix @kbd{p} is a mnemonic for ``print,'' since Emacs ``prints'' the
+prefix @kbd{p} is a mnemonic for ``print'', since Emacs ``prints'' the

 equivalent date in the echo area. @kbd{p o} displays the
 date in all forms known to Emacs.  You can also use @kbd{Mouse-3} and
 then choose @kbd{Other calendars} from the menu that appears.  This
 equivalent date in the echo area. @kbd{p o} displays the
 date in all forms known to Emacs.  You can also use @kbd{Mouse-3} and
 then choose @kbd{Other calendars} from the menu that appears.  This


@@ -901,7 +904,7 @@ Islamic, or French names.
 @findex calendar-hebrew-list-yahrzeits
 @cindex yahrzeits
   One common issue concerning the Hebrew calendar is the computation
 @findex calendar-hebrew-list-yahrzeits
 @cindex yahrzeits
   One common issue concerning the Hebrew calendar is the computation

-of the anniversary of a date of death, called a ``yahrzeit.''  The Emacs
+of the anniversary of a date of death, called a ``yahrzeit''.  The Emacs

 calendar includes a facility for such calculations.  If you are in the
 calendar, the command @kbd{M-x calendar-hebrew-list-yahrzeits} asks you for
 a range of years and then displays a list of the yahrzeit dates for those
 calendar includes a facility for such calculations.  If you are in the
 calendar, the command @kbd{M-x calendar-hebrew-list-yahrzeits} asks you for
 a range of years and then displays a list of the yahrzeit dates for those


@@ -1102,7 +1105,7 @@ current date is visible).
 the @kbd{m} command.  This marks the dates that have diary entries in
 a different face.
 @iftex
 the @kbd{m} command.  This marks the dates that have diary entries in
 a different face.
 @iftex

-@inforef{Calendar Customizing, diary-entry-marker, emacs-xtra}.
+@xref{Calendar Customizing,,, emacs-xtra, Specialized Emacs Features}.

 @end iftex
 @ifnottex
 @xref{Calendar Customizing, diary-entry-marker}.
 @end iftex
 @ifnottex
 @xref{Calendar Customizing, diary-entry-marker}.


@@ -1126,7 +1129,7 @@ date, independently of the calendar display, and optionally for the next
 few days as well; the variable @code{diary-number-of-entries} specifies
 how many days to include.
 @iftex
 few days as well; the variable @code{diary-number-of-entries} specifies
 how many days to include.
 @iftex

-@inforef{Diary Customizing,, emacs-xtra}.
+@xref{Diary Customizing,,, emacs-xtra, Specialized Emacs Features}.

 @end iftex
 @ifnottex
 @xref{Diary Customizing, diary-number-of-entries}.
 @end iftex
 @ifnottex
 @xref{Diary Customizing, diary-number-of-entries}.


@@ -1270,7 +1273,7 @@ entries.  The basic commands are listed here; more sophisticated
 commands are in the next section (@pxref{Special Diary Entries}).
 Entries can also be based on non-Gregorian calendars.
 @iftex
 commands are in the next section (@pxref{Special Diary Entries}).
 Entries can also be based on non-Gregorian calendars.
 @iftex

-@inforef{Non-Gregorian Diary,, emacs-xtra}.
+@xref{Non-Gregorian Diary,,, emacs-xtra, Specialized Emacs Features}.

 @end iftex
 @ifnottex
 @xref{Non-Gregorian Diary}.
 @end iftex
 @ifnottex
 @xref{Non-Gregorian Diary}.


@@ -1426,8 +1429,8 @@ that applies to the fourth Thursday in November:
 @noindent
 The 11 specifies November (the eleventh month), the 4 specifies Thursday
 (the fourth day of the week, where Sunday is numbered zero), and the
 @noindent
 The 11 specifies November (the eleventh month), the 4 specifies Thursday
 (the fourth day of the week, where Sunday is numbered zero), and the

-second 4 specifies the fourth Thursday (1 would mean ``first,'' 2 would
-mean ``second,'' @minus{}2 would mean ``second-to-last,'' and so on).
+second 4 specifies the fourth Thursday (1 would mean ``first'', 2 would
+mean ``second'', @minus{}2 would mean ``second-to-last'', and so on).

 The month can be a single month or a list of months.  Thus you could change
 the 11 above to @samp{'(1 2 3)} and have the entry apply to the last
 Thursday of January, February, and March.  If the month is @code{t}, the
 The month can be a single month or a list of months.  Thus you could change
 the 11 above to @samp{'(1 2 3)} and have the entry apply to the last
 Thursday of January, February, and March.  If the month is @code{t}, the


@@ -1438,7 +1441,7 @@ specifying the name of a face or a single-character string to use when
 marking the entry in the calendar.  Most generally, sexp diary entries
 can perform arbitrary computations to determine when they apply.
 @iftex
 marking the entry in the calendar.  Most generally, sexp diary entries
 can perform arbitrary computations to determine when they apply.
 @iftex

-@inforef{Sexp Diary Entries,, emacs-xtra}.
+@xref{Sexp Diary Entries,,, emacs-xtra, Specialized Emacs Features}.

 @end iftex
 @ifnottex
 @xref{Sexp Diary Entries}.
 @end iftex
 @ifnottex
 @xref{Sexp Diary Entries}.


@@ -1512,7 +1515,7 @@ display the day's diary buffer, unless you set
 @code{appt-display-diary} to @code{nil}.  The appointments list is
 also updated whenever the diary file (or a file it includes; see
 @iftex
 @code{appt-display-diary} to @code{nil}.  The appointments list is
 also updated whenever the diary file (or a file it includes; see
 @iftex

-@inforef{Fancy Diary Display,, emacs-xtra})
+@ref{Fancy Diary Display,,, emacs-xtra, Specialized Emacs Features})

 @end iftex
 @ifnottex
 @ref{Fancy Diary Display})
 @end iftex
 @ifnottex
 @ref{Fancy Diary Display})


@@ -1576,7 +1579,7 @@ and adds the results to an Emacs diary file.  For example:
 You can use an @code{#include} directive to add the import file contents
 to the main diary file, if these are different files.
 @iftex
 You can use an @code{#include} directive to add the import file contents
 to the main diary file, if these are different files.
 @iftex

-@inforef{Fancy Diary Display,, emacs-xtra}.
+@xref{Fancy Diary Display,,, emacs-xtra, Specialized Emacs Features}.

 @end iftex
 @ifnottex
 @xref{Fancy Diary Display}.
 @end iftex
 @ifnottex
 @xref{Fancy Diary Display}.


@@ -1681,7 +1684,7 @@ timeclock-change}.
   Once you've collected data from a number of time intervals, you can use
 @kbd{M-x timeclock-workday-remaining} to see how much time is left to
 work today (assuming a typical average of 8 hours a day), and @kbd{M-x
   Once you've collected data from a number of time intervals, you can use
 @kbd{M-x timeclock-workday-remaining} to see how much time is left to
 work today (assuming a typical average of 8 hours a day), and @kbd{M-x

-timeclock-when-to-leave} which will calculate when you're ``done.''
+timeclock-when-to-leave} which will calculate when you're ``done''.

 
 @vindex timeclock-modeline-display
 @findex timeclock-modeline-display
 
 @vindex timeclock-modeline-display
 @findex timeclock-modeline-display