NEWS for new version of todo-mode.el

NEWS for new version of todo-mode.el

[Stephen Berman]

Before installing the NEWS item for the new version of todo-mode.el, I
have some questions regarding the obsoleting of the old version.  It
seems appropriate to make a reference to this in the entry for the new
version; I've put it at the end:

  ** Todo mode has been rewritten and enhanced.
  New features include:
  - support for multiple todo files and archive files of done items;
  - renaming, reordering, moving, merging, and deleting categories;
  - sortable tabular summaries of categories and the types of items they contain;
  - building and saving cross-categorial lists of items filtered by specific
    criteria;
  - more fine-grained interaction with the Emacs diary, by being able to decide
    for each todo item whether it appears in the Fancy Diary display;
  - highly flexible new item insertion and item editing;
  - moving items between categories, storing done items in their category or in
    archive files, undoing or unarchiving done items;
  - reprioritizing items by inputting a numerical priority in addition to
    incrementally raising or lowering them;
  - extensive customizability of operation and display, including numerous faces.
  To support some of these features, a new file format is used, which is
  incompatible with the old format; however, you can convert old todo and done
  item files on initializing the first new todo file, or at any later time with
  the provided conversion command.  The old version of todo-mode.el has been
  declared obsolete but not yet removed from Emacs.

Is this sufficient, or should there also be an entry under the heading
"Obsolete packages", also mentioning its renaming to otodo-mode.el?

And under the heading "More packages look for ~/.emacs.d/<foo>
additionally to ~/.<foo>" are these items:
  ~/.emacs.d/todo-do	replaces  ~/.todo-do
  ~/.emacs.d/todo-done	replaces  ~/.todo-done
  ~/.emacs.d/todo-top	replaces  ~/.todo-top
Since these are only used by the now obsolete otodo-mode.el, should they
be removed here?

(I also need to add the header line "Obsolete-since: 24.4" to
otodo-mode.el; I'll do that when I make the NEWS commit.)

Steve Berman

Re: NEWS for new version of todo-mode.el

[Glenn Morris]

Stephen Berman wrote:

> should there also be an entry under the heading "Obsolete packages",
> also mentioning its renaming to otodo-mode.el?

Might as well give it a very brief mention, yes.

> And under the heading "More packages look for ~/.emacs.d/<foo>
> additionally to ~/.<foo>" are these items:
>   ~/.emacs.d/todo-do	replaces  ~/.todo-do
>   ~/.emacs.d/todo-done	replaces  ~/.todo-done
>   ~/.emacs.d/todo-top	replaces  ~/.todo-top
> Since these are only used by the now obsolete otodo-mode.el, should they
> be removed here?

I think they could stay, but move them to the end of the list and add a
sentence beforehand that explains they refer to the obsolete package.