diff options
| author | Stephen Berman | 2014-05-23 18:54:35 +0200 |
|---|---|---|
| committer | Stephen Berman | 2014-05-23 18:54:35 +0200 |
| commit | 903204bb53d1c05a9726316134e145d8bd34664e (patch) | |
| tree | 32f17f5475e9ab9e96746c458e9b5f103290b3d3 /doc | |
| parent | 15ad4013c44d19125fde6bbb704797d4a7a185b3 (diff) | |
| download | emacs-903204bb53d1c05a9726316134e145d8bd34664e.tar.gz emacs-903204bb53d1c05a9726316134e145d8bd34664e.zip | |
todo-mode.el: Remove dependence on auto-mode-alist.
* calendar/todo-mode.el: Remove dependence on auto-mode-alist,
to avoid errors when trying to create or visit a file foo.todo
located outside to todo-directory, and to allow having such files
without them being tied to Todo mode.
(todo-show, todo-move-category, todo-merge-category, todo-find-archive)
(todo-archive-done-item, todo-find-filtered-items-file)
(todo-filter-items, todo-find-item, todo-diary-goto-entry)
(todo-category-completions, todo-read-category): When visiting a
Todo file, make sure we're in the right mode and the buffer local
variables are set.
(todo-make-categories-list, todo-reset-nondiary-marker)
(todo-reset-done-string, todo-reset-comment-string): After
processing all Todo files, kill the buffers of those files that
weren't being visited before the processing.
(todo-display-as-todo-file, todo-add-to-buffer-list)
(todo-visit-files-commands): Comment out.
(todo-modes-set-3, todo-mode): Comment out additions to find-file-hook.
(auto-mode-alist): Remove add-to-list calls making Todo file
extensions unrestrictedly tied to Todo modes.
* doc/misc/todo-mode.texi: Update in light of changes due to bug#17482.
Replace numerous mistaken uses of literal quotes with proper
Texinfo markup.
(Todo Mode Entry Points): Comment out reference to using find-file
or Dired to visit Todo files, since this has been disabled (bug#17482).
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/misc/todo-mode.texi | 89 |
2 files changed, 53 insertions, 44 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index ded23868c79..63e2cf728ff 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,11 @@ | |||
| 1 | 2014-05-23 Stephen Berman <stephen.berman@gmx.net> | ||
| 2 | |||
| 3 | * todo-mode.texi: Update in light of changes due to bug#17482. | ||
| 4 | Replace numerous mistaken uses of literal quotes with proper | ||
| 5 | Texinfo markup. | ||
| 6 | (Todo Mode Entry Points): Comment out reference to using find-file | ||
| 7 | or Dired to visit Todo files, since this has been disabled (bug#17482). | ||
| 8 | |||
| 1 | 2014-05-06 Michael Albinus <michael.albinus@gmx.de> | 9 | 2014-05-06 Michael Albinus <michael.albinus@gmx.de> |
| 2 | 10 | ||
| 3 | * tramp.texi (Frequently Asked Questions): Mention HISTFILE | 11 | * tramp.texi (Frequently Asked Questions): Mention HISTFILE |
diff --git a/doc/misc/todo-mode.texi b/doc/misc/todo-mode.texi index ad97e608156..44ea7fbf06e 100644 --- a/doc/misc/todo-mode.texi +++ b/doc/misc/todo-mode.texi | |||
| @@ -258,15 +258,15 @@ are @kbd{C-c t} for @code{todo-show}, @kbd{C-c j} for | |||
| 258 | @code{todo-insert-item}, since these commands are bound to @kbd{t}, | 258 | @code{todo-insert-item}, since these commands are bound to @kbd{t}, |
| 259 | @kbd{j} and @kbd{i}, respectively, in Todo mode. | 259 | @kbd{j} and @kbd{i}, respectively, in Todo mode. |
| 260 | 260 | ||
| 261 | You can also visit a Todo file via @code{find-file} or Dired, like any | 261 | @c You can also visit a Todo file via @code{find-file} or Dired, like any |
| 262 | other file, and since Emacs recognizes it, the buffer will automatically | 262 | @c other file, and since Emacs recognizes it, the buffer will automatically |
| 263 | be in the appropriate Todo mode. Moreover, as long as the command you | 263 | @c be in the appropriate Todo mode. Moreover, as long as the command you |
| 264 | use to visit the file is listed in the option | 264 | @c use to visit the file is listed in the option |
| 265 | @code{todo-visit-files-commands} (which by default contains | 265 | @c @code{todo-visit-files-commands} (which by default contains |
| 266 | @code{find-file} and @code{dired-find-file}), it will also correctly | 266 | @c @code{find-file} and @code{dired-find-file}), it will also correctly |
| 267 | display the file's first category on first visiting the file (otherwise | 267 | @c display the file's first category on first visiting the file (otherwise |
| 268 | you have to use one of the commands for navigating between categories in | 268 | @c you have to use one of the commands for navigating between categories in |
| 269 | order to get a proper display). | 269 | @c order to get a proper display). |
| 270 | 270 | ||
| 271 | You can leave Todo mode by typing @kbd{q} (@code{todo-quit}), which | 271 | You can leave Todo mode by typing @kbd{q} (@code{todo-quit}), which |
| 272 | buries the current todo file buffer. Doing this also saves any changes | 272 | buries the current todo file buffer. Doing this also saves any changes |
| @@ -295,7 +295,7 @@ for the shift key for capitalization and the raw prefix argument | |||
| 295 | number key. | 295 | number key. |
| 296 | 296 | ||
| 297 | The predefined key bindings in Todo are more or less mnemonic. As a | 297 | The predefined key bindings in Todo are more or less mnemonic. As a |
| 298 | rule, key sequences beginning with @kbd{C} (capital `C', not the | 298 | rule, key sequences beginning with @kbd{C} (capital @samp{C}, not the |
| 299 | control key) are bound to commands applying to categories, sequences | 299 | control key) are bound to commands applying to categories, sequences |
| 300 | beginning with @kbd{F} apply to (non-archive) file-level commands, and | 300 | beginning with @kbd{F} apply to (non-archive) file-level commands, and |
| 301 | those beginning with @kbd{A} apply to archives (a special type of Todo | 301 | those beginning with @kbd{A} apply to archives (a special type of Todo |
| @@ -669,9 +669,9 @@ down, i.e., lowering their priority, by one. | |||
| 669 | @samp{region} (@kbd{r}): Use the text of the selected region as the | 669 | @samp{region} (@kbd{r}): Use the text of the selected region as the |
| 670 | text of the new item, and insert this in accordance with the item | 670 | text of the new item, and insert this in accordance with the item |
| 671 | insertion options and other parameters passed. If the option | 671 | insertion options and other parameters passed. If the option |
| 672 | `todo-use-only-highlighted-region' is non-nil, then use the region | 672 | @code{todo-use-only-highlighted-region} is non-nil, then use the |
| 673 | only when it is highlighted; otherwise, use the region regardless of | 673 | region only when it is highlighted; otherwise, use the region |
| 674 | highlighting. | 674 | regardless of highlighting. |
| 675 | @end enumerate | 675 | @end enumerate |
| 676 | 676 | ||
| 677 | Note that the parameters are divided into five numbered groups; within | 677 | Note that the parameters are divided into five numbered groups; within |
| @@ -715,9 +715,9 @@ Press a key (so far `i y'): y=>diary:GO! @{ c=>calendar d=>date n=>dayname @} t | |||
| 715 | @noindent Notice that the pair @samp{k=>nonmarking} is now absent, since it | 715 | @noindent Notice that the pair @samp{k=>nonmarking} is now absent, since it |
| 716 | belongs to the same group as the selected pair @samp{y=>diary}, hence | 716 | belongs to the same group as the selected pair @samp{y=>diary}, hence |
| 717 | is no longer available for this sequence. Since @kbd{y} is a | 717 | is no longer available for this sequence. Since @kbd{y} is a |
| 718 | continuation key, it is still available, but now the string ":GO!" is | 718 | continuation key, it is still available, but now the string |
| 719 | appended to the pair to remind you that pressing this key again will | 719 | @samp{:GO!} is appended to the pair to remind you that pressing this |
| 720 | complete the sequence. | 720 | key again will complete the sequence. |
| 721 | 721 | ||
| 722 | 722 | ||
| 723 | 723 | ||
| @@ -821,10 +821,10 @@ otherwise it enters the empty string (i.e., no time string). | |||
| 821 | 821 | ||
| 822 | @noindent | 822 | @noindent |
| 823 | Editing the text of a lengthy item in the minibuffer can be | 823 | Editing the text of a lengthy item in the minibuffer can be |
| 824 | inconvenient; therefore, if you type `e e' or `e h' on an item whose | 824 | inconvenient; therefore, if you type @kbd{e e} or @kbd{e h} on an item |
| 825 | text contains more than one logical line, the effect is the same as if | 825 | whose text contains more than one logical line, the effect is the same |
| 826 | you had typed `e m', that is, you switch a special buffer in Todo Edit | 826 | as if you had typed @kbd{e m}, that is, you switch a special buffer in |
| 827 | mode. | 827 | Todo Edit mode. |
| 828 | 828 | ||
| 829 | When you pass any of the parameters of the preceding group, except for | 829 | When you pass any of the parameters of the preceding group, except for |
| 830 | the @samp{date} parameter, this completes the item editing invocation | 830 | the @samp{date} parameter, this completes the item editing invocation |
| @@ -916,10 +916,10 @@ invocation: | |||
| 916 | Press a key (so far `e d'): f=>full c=>calendar a=>today n=>dayname y=>year m=>month d=>daynum | 916 | Press a key (so far `e d'): f=>full c=>calendar a=>today n=>dayname y=>year m=>month d=>daynum |
| 917 | @end example | 917 | @end example |
| 918 | 918 | ||
| 919 | In addition to the item-level invocations `e y', to change the current | 919 | In addition to the item-level invocations @kbd{e y}, to change the |
| 920 | item's diary inclusion status, and `e k', to change the current item's | 920 | current item's diary inclusion status, and @kbd{e k}, to change the |
| 921 | calendar marking status, Todo mode also has two related category-level | 921 | current item's calendar marking status, Todo mode also has two related |
| 922 | commands: | 922 | category-level commands: |
| 923 | 923 | ||
| 924 | @table @kbd | 924 | @table @kbd |
| 925 | 925 | ||
| @@ -932,7 +932,7 @@ category. | |||
| 932 | @end table | 932 | @end table |
| 933 | 933 | ||
| 934 | @noindent | 934 | @noindent |
| 935 | Like `e k', `C e k' automatically removes @code{todo-nondiary-marker} | 935 | Like @kbd{e k}, @kbd{C e k} automatically removes @code{todo-nondiary-marker} |
| 936 | from all items it is present on, since only diary items can bear | 936 | from all items it is present on, since only diary items can bear |
| 937 | @code{diary-nonmarking-symbol}. | 937 | @code{diary-nonmarking-symbol}. |
| 938 | 938 | ||
| @@ -944,7 +944,7 @@ to be toggles, but to have the same effect on all items in the | |||
| 944 | category, and take a prefix argument to reverse the effect. (If you | 944 | category, and take a prefix argument to reverse the effect. (If you |
| 945 | really want to toggle the diary-inclusion and calendar-marking status | 945 | really want to toggle the diary-inclusion and calendar-marking status |
| 946 | of all items in the category, you can do this by marking all the items | 946 | of all items in the category, you can do this by marking all the items |
| 947 | and then invoking `e y' or `e k', @pxref{Marked Items}). | 947 | and then invoking @kbd{e y} or @kbd{e k}, @pxref{Marked Items}). |
| 948 | 948 | ||
| 949 | @node Relocating and Removing Items, , Editing Item Headers and Text, Item Editing | 949 | @node Relocating and Removing Items, , Editing Item Headers and Text, Item Editing |
| 950 | @subsection Relocating and Removing Items | 950 | @subsection Relocating and Removing Items |
| @@ -1050,14 +1050,15 @@ Archive Mode}). | |||
| 1050 | 1050 | ||
| 1051 | @anchor{todo-item-done} | 1051 | @anchor{todo-item-done} |
| 1052 | @item d | 1052 | @item d |
| 1053 | This command (@code{todo-item-done}) removes the todo item at point from | 1053 | This command (@code{todo-item-done}) removes the todo item at point |
| 1054 | the todo list, appends to the original header a header consisting of | 1054 | from the todo list, appends to the original header a header consisting |
| 1055 | @code{todo-done-string} (by default ``DONE '') and the current date, and | 1055 | of @code{todo-done-string} (by default @samp{DONE }) and the current |
| 1056 | if @code{todo-always-add-time-string} is enabled, also the current time, | 1056 | date, and if @code{todo-always-add-time-string} is enabled, also the |
| 1057 | and adds the resulting done item to the top of the done items section of | 1057 | current time, and adds the resulting done item to the top of the done |
| 1058 | the category. Invoked with a prefix argument, it also prompts you to | 1058 | items section of the category. Invoked with a prefix argument, it |
| 1059 | enter a comment, which is appended to the end of the done item, prefixed | 1059 | also prompts you to enter a comment, which is appended to the end of |
| 1060 | with @code{todo-comment-string} (by default ``COMMENT: ''). | 1060 | the done item, prefixed with @code{todo-comment-string} (by default |
| 1061 | @samp{COMMENT: }). | ||
| 1061 | @end table | 1062 | @end table |
| 1062 | 1063 | ||
| 1063 | A category's done items section is located below the last todo (i.e., | 1064 | A category's done items section is located below the last todo (i.e., |
| @@ -1255,7 +1256,7 @@ category in the archive, the archive file is also automatically deleted. | |||
| 1255 | 1256 | ||
| 1256 | Since it is natural to visit an archive from the corresponding todo | 1257 | Since it is natural to visit an archive from the corresponding todo |
| 1257 | file, it would be convenient to easily return to the todo file when you | 1258 | file, it would be convenient to easily return to the todo file when you |
| 1258 | have finished browsing the archive. If you type `q' to quit Todo | 1259 | have finished browsing the archive. If you type @kbd{q} to quit Todo |
| 1259 | Archive mode, this switches to the corresponding todo file and shows the | 1260 | Archive mode, this switches to the corresponding todo file and shows the |
| 1260 | todo category corresponding to the archive category you were just | 1261 | todo category corresponding to the archive category you were just |
| 1261 | visiting. | 1262 | visiting. |
| @@ -1396,13 +1397,13 @@ to sort by archived item counts. | |||
| 1396 | 1397 | ||
| 1397 | Each row of the table is also buttonized; pressing one of these exits | 1398 | Each row of the table is also buttonized; pressing one of these exits |
| 1398 | the buffer (killing it), returns to the buffer of the file from which | 1399 | the buffer (killing it), returns to the buffer of the file from which |
| 1399 | you had invoked `F c', and displays the category that was named in the | 1400 | you had invoked @kbd{F c}, and displays the category that was named in |
| 1400 | row button you pressed (i.e., pressing this button jumps to that | 1401 | the row button you pressed (i.e., pressing this button jumps to that |
| 1401 | category). However, if the category named in the row is in a todo file | 1402 | category). However, if the category named in the row is in a todo |
| 1402 | and all of its items have been archived, and you have enabled the option | 1403 | file and all of its items have been archived, and you have enabled the |
| 1403 | @code{todo-skip-archived-categories}, then pressing the button jumps to | 1404 | option @code{todo-skip-archived-categories}, then pressing the button |
| 1404 | the archive category instead of the empty todo category. You can | 1405 | jumps to the archive category instead of the empty todo category. You |
| 1405 | recognize such categories by their items counts in the table---all | 1406 | can recognize such categories by their items counts in the table---all |
| 1406 | columns but the archived one have counts of zero---and in addition, | 1407 | columns but the archived one have counts of zero---and in addition, |
| 1407 | their lines in the table are also distinguished from the others by a | 1408 | their lines in the table are also distinguished from the others by a |
| 1408 | different face (@pxref{Faces}). | 1409 | different face (@pxref{Faces}). |
| @@ -1586,7 +1587,7 @@ todo file, and the latter sets the number of top priorities for the | |||
| 1586 | current category. To exclude a category or file from filtering by @kbd{F t t} | 1587 | current category. To exclude a category or file from filtering by @kbd{F t t} |
| 1587 | and @kbd{F t m}, set the number to @samp{0}. | 1588 | and @kbd{F t m}, set the number to @samp{0}. |
| 1588 | @item | 1589 | @item |
| 1589 | You can invoke `F t t' and `F t m' with a numeric prefix argument, | 1590 | You can invoke @kbd{F t t} and @kbd{F t m} with a numeric prefix argument, |
| 1590 | which specifies the number of top priorities in each category just for | 1591 | which specifies the number of top priorities in each category just for |
| 1591 | this invocation, overriding both @code{todo-top-priorities-overrides} and | 1592 | this invocation, overriding both @code{todo-top-priorities-overrides} and |
| 1592 | @code{todo-top-priorities}. | 1593 | @code{todo-top-priorities}. |
| @@ -1681,7 +1682,7 @@ use the values of @code{todo-top-priorities-overrides} or | |||
| 1681 | Aside from explicitly invoking an item filtering command to display a | 1682 | Aside from explicitly invoking an item filtering command to display a |
| 1682 | saved list of items filtered by a given method from given todo files, | 1683 | saved list of items filtered by a given method from given todo files, |
| 1683 | there are two other ways to visit a saved file of filtered items. You | 1684 | there are two other ways to visit a saved file of filtered items. You |
| 1684 | can invoke a command similar to `find-file': | 1685 | can invoke a command similar to @code{find-file}: |
| 1685 | 1686 | ||
| 1686 | @table @kbd | 1687 | @table @kbd |
| 1687 | @item F f | 1688 | @item F f |