]> code.delx.au - gnu-emacs/blobdiff - doc/misc/todo-mode.texi
Fix references in EIEIO documentation.
[gnu-emacs] / doc / misc / todo-mode.texi
index a14802e918138ecad0e3eb432c27278b3883421f..5a903f7dee474b6efc2e651a29633a360031d9f7 100644 (file)
@@ -5,10 +5,11 @@
 @syncodeindex fn cp
 @syncodeindex vr cp
 @syncodeindex ky cp
+@documentencoding UTF-8
 @c %**end of header
 
 @copying
-Copyright @copyright{} 2013 Free Software Foundation, Inc.
+Copyright @copyright{} 2013-2014 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -23,9 +24,9 @@ modify this GNU manual.''
 @end quotation
 @end copying
 
-@dircategory Emacs
+@dircategory Emacs misc features
 @direntry
-* Todo Mode: (todo-mode).             Make and maintain todo lists.
+* Todo Mode: (todo-mode).       Make and maintain todo lists.
 @end direntry
 
 @titlepage
@@ -138,7 +139,7 @@ are subsidiary to and accessible from Todo mode.
 
 This version of Todo mode greatly expands on, and in significant ways
 differs from, the original version; for details and consequences of the
-most important differences, @xref{Legacy Todo Mode Files}.
+most important differences, @ref{Legacy Todo Mode Files}.
 
 @menu
 * Levels of Organization::
@@ -192,8 +193,8 @@ file in the Emacs diary file (@pxref{Fancy Diary Display,,, emacs}), the
 Fancy Diary display will show those todo items that are not marked with
 @code{todo-nondiary-marker}.  This effectively augments the Emacs diary
 with categorized diary entries.  For the various options available for
-making a todo item a diary entry, @ref{Inserting New Items} and
-@xref{Editing Item Headers and Text}.
+making a todo item a diary entry, see @ref{Inserting New Items} and
+@ref{Editing Item Headers and Text}.
 
 To ensure the proper display of todo items in the Fancy Diary display,
 they must have the format of diary entries, i.e., they have to begin
@@ -244,9 +245,9 @@ default todo file.
 
 If you want to enter Todo mode and go directly to a specific category
 instead the first or current category in the current or default todo
-file, use the command @code{todo-jump-to-category}; @ref{Navigation} for
+file, use the command @code{todo-jump-to-category}; @ref{Navigation}, for
 details.  You can also enter Todo mode by invoking a todo item insertion
-command; @ref{Inserting New Items} for details.
+command; @ref{Inserting New Items}, for details.
 
 The most convenient way to use these commands to enter Todo mode is to
 define global key bindings for them in your init file.  Good choices are
@@ -421,7 +422,7 @@ name and creates the file in @code{todo-directory}, adding the
 @samp{.todo} extension (so you should not include the extension in the
 name you enter).  The command also prompts for the file's first category and, if
 option @code{todo-add-item-if-new-category} is enabled (the default),
-for that category's first item.  
+for that category's first item.
 
 @item F r
 Rename the current todo file (@code{todo-rename-file}).  If called with
@@ -433,7 +434,7 @@ visiting any of these files, the command also rename them accordingly.
 
 @item F k
 Delete the current todo file (@code{todo-delete-file}).@footnote{The key
-binding of this command is mnenomic for ``kill'' to parallel the binding
+binding of this command is mnemonic for ``kill'' to parallel the binding
 @kbd{k} for item deletion, since @kbd{d} is bound to another item
 editing command (@pxref{Done Items}).}  If the todo file has an archive
 (@pxref{Todo Archive Mode}), prompt whether to delete that as well.
@@ -442,7 +443,7 @@ This command also kill the buffers visiting the deleted files.
 @item F e
 This command (@code{todo-edit-file}) changes the buffer's major mode to
 Todo Edit mode.  In this mode the entire file is visible, the buffer is
-writeable and you can use the self-insertion keys and standard Emacs
+writable and you can use the self-insertion keys and standard Emacs
 editing commands to make changes.  To return to Todo mode, type @kbd{C-x
 C-q} (@code{todo-edit-quit}).
 
@@ -461,7 +462,7 @@ Using @kbd{C-x C-q} to quit Todo Edit mode provides a measure of safety,
 since it runs a file format check, signaling an error if the format has
 become invalid.  However, this check cannot tell if the number of items
 changed, which could result in the file containing inconsistent
-information (see the cautionary note in @ref{Reordering Categories} for
+information (see the cautionary note in @ref{Reordering Categories}, for
 more details).  For this reason @kbd{F e} should be used with caution.
 @end table
 
@@ -496,7 +497,7 @@ and adds the category.
 
 @item C k
 Delete the current category (@code{todo-delete-category}).@footnote{This
-binding is mnenomic for ``kill'' to parallel the binding @kbd{k} for
+binding is mnemonic for ``kill'' to parallel the binding @kbd{k} for
 item deletion, since @kbd{d} is bound to another item editing command
 (@pxref{Done Items}).}  To delete a category that contains items, you
 have to confirm your intent; if the category is empty, deletion is
@@ -595,7 +596,7 @@ concerning the item header, and one each concerning its priority and its
 text.  Each unique combination of these parameters produces a different
 insertion command.  The command @kbd{i i} realizes one of these
 combinations.  For the commands that realize the remaining combinations
-it is convenient to associate each parameter with a mnenomically chosen
+it is convenient to associate each parameter with a mnemonically chosen
 key.  Then by typing certain sequences of these keys, you complete the
 insertion command invocation that realizes the specified combination.
 As with @kbd{i i}, the effect of many of these commands also depends on
@@ -610,7 +611,7 @@ occur in a category listing):
 @enumerate
 
 @item
-@kbd{y} for diary (non)inclusion; 
+@kbd{y} for diary (non)inclusion;
 @item
 @kbd{k} for adding or omitting `diary-nonmarking-symbol';
 @item
@@ -882,7 +883,7 @@ You delete an item, thereby permanently removing it:
 
 @item k
 Delete the todo item at point (@code{todo-delete-item}; the binding is
-mnenomic for ``kill'', since @kbd{d} is used for marking items as done
+mnemonic for ``kill'', since @kbd{d} is used for marking items as done
 (@pxref{Done Items}); but note that @kbd{k} does not put the item into
 the kill ring).  This command requires confirmation that you want to
 delete the item, since you cannot undo the deletion in Todo mode.  (You
@@ -1139,7 +1140,7 @@ Mark the item at point if it is unmarked, and remove the mark it is
 already marked (@code{todo-toggle-mark-item}).  The mark is a string
 specified by the option @code{todo-item-mark} (by default @samp{*})
 appended in front of the item header (more precisely, in front of the
-item's priority number or prefix; @pxref{Todo Display Features} for
+item's priority number or prefix; see @ref{Todo Display Features}, for
 details of the latter).  After marking the current item, the command
 advances point to the next item.  It also accepts a numeric prefix
 argument, which allows toggling the mark of multiple consecutive items.
@@ -1170,7 +1171,7 @@ listed consecutively en bloc.
 
 You can mark both todo and done items, but note that only @kbd{m} can apply
 to both; other commands only affect either marked todo or marked done
-items, so if both types of items are marked, invoking these commmands
+items, so if both types of items are marked, invoking these commands
 has no effect and informs you of your erroneous attempt.
 
 @node Todo Categories Mode, Searching for Items, Marked Items, Top
@@ -1214,7 +1215,7 @@ to visit another todo file).  To do this customize the option
 @node Table of Item Counts, Reordering Categories, , Todo Categories Mode
 @section Table of Item Counts
 
-Above each column of the table is a labelled button you can press by
+Above each column of the table is a labeled button you can press by
 clicking with the mouse or by typing @key{RET} on it.  Pressing an item
 count button sorts the table alternately in ascending or descending
 order according to the type of count.  Pressing the category button
@@ -1332,7 +1333,7 @@ way to do this in Todo mode is by sequentially searching in the file:
 @table @kbd
 
 @item S
-This command (@code{todo-search}; the key is capital `S') prompts for a
+This command (@code{todo-search}; the key is capital @kbd{S}) prompts for a
 regular expression, searches from the beginning of the current todo file
 and displays the category containing the first match it finds, with the
 match highlighted.  If there are further matches, a message saying how
@@ -1355,7 +1356,7 @@ These commands are also available in Todo Archive mode.
 A more powerful alternative to sequential searching is item filtering,
 by which items from different categories that match specified criteria
 are gathered and displayed in a new buffer as a kind of virtual
-category in a distinct mode, Todo Filtered Items mode.  
+category in a distinct mode, Todo Filtered Items mode.
 
 @menu
 * Filtering Items::
@@ -1375,7 +1376,7 @@ filter come in pairs, one for filtering just the current todo file and
 one for filtering a user-specified list of todo files.  Thus, there
 are six item filtering commands:@footnote{The use of @kbd{F} in the key
 sequences of these commands naturally recalls ``filter'', but is also
-consistent with the Todo mode mnenomic key binding convention, since the
+consistent with the Todo mode mnemonic key binding convention, since the
 commands involve one or more whole files.}
 
 @itemize @bullet
@@ -1533,7 +1534,7 @@ completion (@code{todo-find-filtered-items-file}).
 @end table
 
 @itemize @bullet
-@item 
+@item
 As with tables of categories, by customizing @code{todo-show-first} you
 can have the first invocation of @code{todo-show} for a given todo file
 display the corresponding saved file of filtered items.  If there is
@@ -1548,7 +1549,7 @@ Filtered Items mode.  It deletes the current filtered items file.
 @node Todo Display Features, Printing Todo Buffers, Todo Filtered Items Mode, Top
 @chapter Todo Display Features
 
-You can change the appearance of Todo mode buffers in a variety of ways.  
+You can change the appearance of Todo mode buffers in a variety of ways.
 
 @menu
 * Faces::
@@ -1567,7 +1568,7 @@ the date and time of a Todo diary item (i.e., an item lacking
 @code{todo-nondiary-marker}) is earlier than the current date and time,
 they are displayed in a different face.  In this way, you can readily
 recognize diary items that have ``expired'' and act accordingly (e.g.,
-by tagging them as done or by updating the deadlines).  
+by tagging them as done or by updating the deadlines).
 
 Another example of an informational face is the face used to distinguish
 top priority items.  A third case is the face used in Todo Categories
@@ -1612,7 +1613,7 @@ buffers of filtered items that have not yet been written to a file.)
 
 In the todo items section of each Todo mode category, the item prefix
 (whether a priority number or a fixed string) of the top priority items
-(determined as specified in @ref{Filtering Items}) is displayed in a
+(determined as specified in @pxref{Filtering Items}) is displayed in a
 different face from the prefix of the other items, so you see at a
 glance how many items in the category are top priorities.