[elpa] externals/gnorb 2834602 247/449: Move roadmap/todo list from manual to README

[Stefan Monnier]

branch: externals/gnorb
commit 2834602ac5baaa03b83a2d649f1c3e2a54d6205b
Author: Eric Abrahamsen <eric@ericabrahamsen.net>
Commit: Eric Abrahamsen <eric@ericabrahamsen.net>

    Move roadmap/todo list from manual to README
    
    * README.org: Add roadmap
    * gnorb.info
    * gnorb.org: Remove roadmap
    * gnorb.texi
---
 README.org |  48 ++++++++++++++++++++
 gnorb.info | 151 +++++++++++++++++++++++++++++++++++--------------------------
 gnorb.org  |  20 --------
 gnorb.texi | 100 +++++++++++++++++++++++-----------------
 4 files changed, 193 insertions(+), 126 deletions(-)

diff --git a/README.org b/README.org
index cbb13af..895dbe6 100644
--- a/README.org
+++ b/README.org
@@ -29,3 +29,51 @@ If you want to use Gnorb for tracking emails with TODOs, 
you'll need
 to add a nngnorb server to your `gnus-secondary-select-methods'
 variable, then call `gnorb-tracking-initialize' in your init files.
 Again, see the manual for details.
+** Roadmap
+*** More fully utilize nngnorb
+Instead of just being place to put nnir searches, the nngnorb server
+should have groups in its own right. Users will still be able to make
+ephemeral search groups if they like, but they'll also have the option
+of creating regular Gnus groups that track certain Org subtrees. These
+groups will be persistent, and they will auto-update, so it's possible
+to handle more TODO stuff from the Gnus group buffer. Copying a
+message into the group will set up tracking for the message; deleting
+it from the group will remove tracking.
+*** Comprehensive views of related information
+For instance, A `gnorb-view' command that takes a tags-todo search
+phrase (or a single Org heading ID), finds all relevant messages, Org
+headings, and BBDB records, and sets up a four-pane view: Org Agenda,
+BBDB buffer, Gnus Summary buffer, and Gnus Article buffer.
+
+Or something like that -- more pondering is necessary.
+*** Consider consolidating posting styles, personas, etc
+There are many solutions out there for setting up "personas" in Gnus
+or elsewhere: wrappers for mail composition and reply that create
+certain identities by setting variables and mail headers.
+
+Do we need another one? Gnorb seems so well placed for this sort of
+thing: we've already got bbdb-posting-styles, and allowing further
+configuration based on, say, the Org tags of the subtree we're
+composing messages from... Or maybe it's just a case of NIH.
+** To do list
+*** TODO Agenda date-span message search
+Provide an Org Agenda command that does an email search for messages
+received in the visible date span, or day under point, etc. Make it
+work in the calendar, as well?
+*** TODO Capture to child/subtree trigger actions
+Add trigger actions that create new sibling or child headings on the
+original Org heading.
+*** TODO Gnus message tagging
+Allow tagging of Gnus messages, by giving the message's registry entry
+an 'org-tags key.
+*** TODO Email subtree export to doc and rtf
+When using `gnorb-email-subtree', provide built-in options for
+exporting to doc and rtf attachments; these are such commonly-needed
+formats. Do the odt conversion automatically.
+*** TODO Automatic org-tagging for BBDB contacts
+When messages from a contact are associated with an Org heading, make
+it possible for the contact to inherit that heading's tags
+automatically.
+*** TODO gnorb-bbdb-view
+Provide a `gnorb-bbdb-view' command that opens a Summary buffer
+containing all the tracked messages from the contact(s) under point.
diff --git a/gnorb.info b/gnorb.info
index 64304bd..cf287b0 100644
--- a/gnorb.info
+++ b/gnorb.info
@@ -25,8 +25,6 @@ Gnorb Manual
 * Misc Org::
 * Misc Gnus::
 * Suggested Keybindings::
-* Wishlist/TODO::
-* Index::
 
 — The Detailed Node Listing —
 
@@ -37,6 +35,7 @@ Email Tracking
 * Viewing Tracked Messages in *Summary* Buffers::
 * Hinting in Gnus::
 * Message Attachments::
+* Likely Workflow::
 
 Misc BBDB
 
@@ -156,6 +155,7 @@ agenda rather than in Gnus.
 * Viewing Tracked Messages in *Summary* Buffers::
 * Hinting in Gnus::
 * Message Attachments::
+* Likely Workflow::
 
 
 File: gnorb.info,  Node: Email-Related Commands,  Next: Trigger Actions,  Up: 
Email Tracking
@@ -230,8 +230,9 @@ heading, taking a note on the heading (both these options 
will associate
 the message with the heading), associating the message but doing nothing
 else, and lastly, doing nothing at all.
 
-   More actions will be added in the future; it’s also possible to add
-your own action: see the docstring of ‘gnorb-org-trigger-actions’.
+   More actions will be added in the future; it’s also possible to
+rearrange or delete existing actions, and add your own: see the
+docstring of ‘gnorb-org-trigger-actions’.
 
 
 File: gnorb.info,  Node: Viewing Tracked Messages in *Summary* Buffers,  Next: 
Hinting in Gnus,  Prev: Trigger Actions,  Up: Email Tracking
@@ -277,7 +278,7 @@ is “g” (meaning it is used as “%ug” in the format line), 
and the mark is
 “¡”.
 
 
-File: gnorb.info,  Node: Message Attachments,  Prev: Hinting in Gnus,  Up: 
Email Tracking
+File: gnorb.info,  Node: Message Attachments,  Next: Likely Workflow,  Prev: 
Hinting in Gnus,  Up: Email Tracking
 
 4.5 Message Attachments
 =======================
@@ -304,6 +305,60 @@ attach the files in the heading’s org-attach directory to 
the outgoing
 message.
 
 
+File: gnorb.info,  Node: Likely Workflow,  Prev: Message Attachments,  Up: 
Email Tracking
+
+4.6 Likely Workflow
+===================
+
+You receive an email from Jimmy, who wants to rent a room in your house.
+“I’ll respond to this later,” you think.
+
+   You capture an Org TODO from the email, call it “Jimmy renting a
+room”, and give it a REPLY keyword.  Gnorb quietly records the
+correspondence between the email and the TODO, using the Gnus registry.
+
+   The next day, looking at your Agenda, you see the TODO and decide to
+respond to the email.  You call ‘gnorb-org-handle-mail’ on the heading,
+and Gnorb opens Jimmy’s email and starts a reply to it.
+
+   You tell Jimmy the room’s available in March, and send the message.
+Gnorb takes you back to the heading, and asks you to trigger an action
+on it.  You choose “todo state”, and change the heading keyword to WAIT.
+
+   Two days later, Jimmy replies to your message, saying that March is
+perfect.  When you open his response, Gnorb politely reminds you that
+the message is relevant to an existing TODO. You call
+‘gnorb-gnus-incoming-do-todo’ on the message, and are again taken to the
+TODO and asked to trigger an action.  Again you choose “todo state”, and
+change the heading keyword back to REPLY.
+
+   You get another email, from Samantha, warning you not to rent the
+room to Jimmy.  She even attaches a picture of a room in her house, as
+it looked after Jimmy had stayed there for six months.  It’s bad.  You
+call ‘gnorb-gnus-incoming-do-todo’ on her message, and pick the “Jimmy
+renting a room” heading.  This time, you choose “take note” as the
+trigger action, and make a brief note about how bad that room looked.
+Gnorb asks if you’d like to attach the picture to the Org heading.  You
+decide you will.
+
+   Now it’s time to write to Jimmy and say something noncommittal.
+Calling ‘gnorb-org-handle-mail’ on the heading would respond to
+Samantha’s email, the most recent of the associated messages, which
+isn’t what you want.  Instead you call ‘gnorb-org-view’ on the heading,
+which opens up a Gnus *Summary* buffer containing all four messages:
+Jimmy’s first, your response, his response to that, and Samantha’s
+message.  You pick Jimmy’s second email, and reply to it normally.
+Gnorb asks if you’d like to send the picture of the room as an
+attachment.  You would not.  When you send the reply Gnorb tracks that
+as well, and does the “trigger an action” trick again.
+
+   In this way Gnorb helps you manage an entire conversation, possibly
+with multiple threads and multiple participants.  Mostly all you need to
+do is call ‘gnorb-gnus-incoming-do-todo’ on newly-received messages, and
+‘gnorb-org-handle-mail’ on the heading when it’s time to compose a new
+reply.
+
+
 File: gnorb.info,  Node: Restoring Window Layout,  Next: Recent Mails From 
BBDB Contacts,  Prev: Email Tracking,  Up: Top
 
 5 Restoring Window Layout
@@ -581,7 +636,7 @@ File: gnorb.info,  Node: User Optionsxx,  Prev: Viewing Org 
headlines relevant t
      format line.  Defaults to “¡”.
 
 
-File: gnorb.info,  Node: Suggested Keybindings,  Next: Wishlist/TODO,  Prev: 
Misc Gnus,  Up: Top
+File: gnorb.info,  Node: Suggested Keybindings,  Prev: Misc Gnus,  Up: Top
 
 12 Suggested Keybindings
 ************************
@@ -629,69 +684,35 @@ File: gnorb.info,  Node: Suggested Keybindings,  Next: 
Wishlist/TODO,  Prev: Mis
        '(progn
           (define-key message-mode-map (kbd "C-c t") 
'gnorb-gnus-outgoing-do-todo)))
 
-
-File: gnorb.info,  Node: Wishlist/TODO,  Next: Index,  Prev: Suggested 
Keybindings,  Up: Top
-
-13 Wishlist/TODO
-****************
-
-   • Provide a command that, when in the Org Agenda, does an email
-     search for messages received in the visible date span, or day under
-     point, etc.  Make it work in the calendar, as well?
-   • Add trigger actions that create new sibling or child headings on
-     the original Org heading.
-   • Allow tagging of Gnus messages, by giving the message’s registry
-     entry an ‘org-tags key.
-   • Provide persistent nngnorb search groups.
-   • Allow automatic org-tagging of BBDB contacts: when messages from a
-     contact are associated with an Org heading, make it possible for
-     the contact to inherit that heading’s tags automatically.
-   • Provide completion when setting Org tags on a BBDB contact.
-   • Provide a ‘gnorb-bbdb-view’ command that opens a *Summary* buffer
-     containing all the tracked messages from the contact(s) under
-     point.
-   • Provide a ‘gnorb-view’ command that takes a tags-todo search phrase
-     (or a single Org heading ID), finds all relevant messages, Org
-     headings, and BBDB records, and sets up a four-pane view: Org
-     Agenda, **Article* SummaryBBDB* buffer, Gnus *buffer, and an *
-     buffer.
-
-
-File: gnorb.info,  Node: Index,  Prev: Wishlist/TODO,  Up: Top
-
-14 Index
-********
-
 
 
 Tag Table:
 Node: Top194
-Node: Introduction1017
-Node: Installation2126
-Node: Setup2540
-Node: Email Tracking3907
-Node: Email-Related Commands5418
-Node: Trigger Actions8239
-Node: Viewing Tracked Messages in *Summary* Buffers9053
-Node: Hinting in Gnus10287
-Node: Message Attachments11295
-Node: Restoring Window Layout12453
-Node: Recent Mails From BBDB Contacts12817
-Node: BBDB posting styles13813
-Node: BBDB Org tagging14729
-Node: Misc BBDB15475
-Node: Searching for messages from BBDB contacts15688
-Node: Citing BBDB contacts16134
-Node: User Options16455
-Node: Misc Org17994
-Node: Inserting BBDB links18169
-Node: User Optionsx18424
-Node: Misc Gnus21161
-Node: Viewing Org headlines relevant to a message21374
-Node: User Optionsxx21689
-Node: Suggested Keybindings24453
-Node: Wishlist/TODO26824
-Node: Index28139
+Node: Introduction1009
+Node: Installation2118
+Node: Setup2532
+Node: Email Tracking3899
+Node: Email-Related Commands5430
+Node: Trigger Actions8251
+Node: Viewing Tracked Messages in *Summary* Buffers9100
+Node: Hinting in Gnus10334
+Node: Message Attachments11342
+Node: Likely Workflow12524
+Node: Restoring Window Layout15329
+Node: Recent Mails From BBDB Contacts15693
+Node: BBDB posting styles16689
+Node: BBDB Org tagging17605
+Node: Misc BBDB18351
+Node: Searching for messages from BBDB contacts18564
+Node: Citing BBDB contacts19010
+Node: User Options19331
+Node: Misc Org20870
+Node: Inserting BBDB links21045
+Node: User Optionsx21300
+Node: Misc Gnus24037
+Node: Viewing Org headlines relevant to a message24250
+Node: User Optionsxx24565
+Node: Suggested Keybindings27329
 
 End Tag Table
 
diff --git a/gnorb.org b/gnorb.org
index b03098b..0a685b7 100644
--- a/gnorb.org
+++ b/gnorb.org
@@ -485,23 +485,3 @@ heading to jump to that heading.
     '(progn
        (define-key message-mode-map (kbd "C-c t") 
'gnorb-gnus-outgoing-do-todo)))
 #+END_SRC
-* Wishlist/TODO
-- Provide a command that, when in the Org Agenda, does an email search
-  for messages received in the visible date span, or day under point,
-  etc. Make it work in the calendar, as well?
-- Add trigger actions that create new sibling or child headings on the
-  original Org heading.
-- Allow tagging of Gnus messages, by giving the message's registry
-  entry an 'org-tags key.
-- Provide persistent nngnorb search groups.
-- Allow automatic org-tagging of BBDB contacts: when messages from a
-  contact are associated with an Org heading, make it possible for the
-  contact to inherit that heading's tags automatically.
-- Provide completion when setting Org tags on a BBDB contact.
-- Provide a `gnorb-bbdb-view' command that opens a *Summary* buffer
-  containing all the tracked messages from the contact(s) under point.
-- Provide a `gnorb-view' command that takes a tags-todo search phrase
-  (or a single Org heading ID), finds all relevant messages, Org
-  headings, and BBDB records, and sets up a four-pane view: Org
-  Agenda, *BBDB* buffer, Gnus *Summary* buffer, and an *Article*
-  buffer.
diff --git a/gnorb.texi b/gnorb.texi
index 643552f..2ea3ea2 100644
--- a/gnorb.texi
+++ b/gnorb.texi
@@ -36,8 +36,6 @@
 * Misc Org::
 * Misc Gnus::
 * Suggested Keybindings::
-* Wishlist/TODO::
-* Index::
 
 @detailmenu
 --- The Detailed Node Listing ---
@@ -49,6 +47,7 @@ Email Tracking
 * Viewing Tracked Messages in *Summary* Buffers::
 * Hinting in Gnus::
 * Message Attachments::
+* Likely Workflow::
 
 Misc BBDB
 
@@ -163,6 +162,7 @@ agenda rather than in Gnus.
 * Viewing Tracked Messages in *Summary* Buffers::
 * Hinting in Gnus::
 * Message Attachments::
+* Likely Workflow::
 @end menu
 
 @node Email-Related Commands
@@ -242,8 +242,9 @@ on the heading, taking a note on the heading (both these 
options will
 associate the message with the heading), associating the message but
 doing nothing else, and lastly, doing nothing at all.
 
-More actions will be added in the future; it's also possible to add
-your own action: see the docstring of `gnorb-org-trigger-actions'.
+More actions will be added in the future; it's also possible to
+rearrange or delete existing actions, and add your own: see the
+docstring of `gnorb-org-trigger-actions'.
 
 @node Viewing Tracked Messages in *Summary* Buffers
 @section Viewing Tracked Messages in *Summary* Buffers
@@ -307,6 +308,59 @@ heading using `gnorb-org-handle-mail', Gnorb will ask if 
you want to
 attach the files in the heading's org-attach directory to the outgoing
 message.
 
+@node Likely Workflow
+@section Likely Workflow
+
+You receive an email from Jimmy, who wants to rent a room in your
+house. ``I'll respond to this later,'' you think.
+
+You capture an Org TODO from the email, call it ``Jimmy renting a
+room'', and give it a REPLY keyword. Gnorb quietly records the
+correspondence between the email and the TODO, using the Gnus
+registry.
+
+The next day, looking at your Agenda, you see the TODO and decide to
+respond to the email. You call `gnorb-org-handle-mail' on the heading,
+and Gnorb opens Jimmy's email and starts a reply to it.
+
+You tell Jimmy the room's available in March, and send the message.
+Gnorb takes you back to the heading, and asks you to trigger an action
+on it. You choose ``todo state'', and change the heading keyword to
+WAIT.
+
+Two days later, Jimmy replies to your message, saying that March is
+perfect. When you open his response, Gnorb politely reminds you that
+the message is relevant to an existing TODO. You call
+`gnorb-gnus-incoming-do-todo' on the message, and are again taken to
+the TODO and asked to trigger an action. Again you choose ``todo
+state'', and change the heading keyword back to REPLY.
+
+You get another email, from Samantha, warning you not to rent the room
+to Jimmy. She even attaches a picture of a room in her house, as it
+looked after Jimmy had stayed there for six months. It's bad. You call
+`gnorb-gnus-incoming-do-todo' on her message, and pick the ``Jimmy
+renting a room'' heading. This time, you choose ``take note'' as the
+trigger action, and make a brief note about how bad that room looked.
+Gnorb asks if you'd like to attach the picture to the Org heading. You
+decide you will.
+
+Now it's time to write to Jimmy and say something noncommittal.
+Calling `gnorb-org-handle-mail' on the heading would respond to
+Samantha's email, the most recent of the associated messages, which
+isn't what you want. Instead you call `gnorb-org-view' on the heading,
+which opens up a Gnus *Summary* buffer containing all four messages:
+Jimmy's first, your response, his response to that, and Samantha's
+message. You pick Jimmy's second email, and reply to it normally.
+Gnorb asks if you'd like to send the picture of the room as an
+attachment. You would not. When you send the reply Gnorb tracks that
+as well, and does the ``trigger an action'' trick again.
+
+In this way Gnorb helps you manage an entire conversation, possibly
+with multiple threads and multiple participants. Mostly all you need
+to do is call `gnorb-gnus-incoming-do-todo' on newly-received
+messages, and `gnorb-org-handle-mail' on the heading when it's time to
+compose a new reply.
+
 @node Restoring Window Layout
 @chapter Restoring Window Layout
 
@@ -614,41 +668,5 @@ line. Defaults to ``¡''.
      (define-key message-mode-map (kbd "C-c t") 'gnorb-gnus-outgoing-do-todo)))
 @end lisp
 
-@node Wishlist/TODO
-@chapter Wishlist/TODO
-
-@itemize
-@item
-Provide a command that, when in the Org Agenda, does an email search
-for messages received in the visible date span, or day under point,
-etc. Make it work in the calendar, as well?
-@item
-Add trigger actions that create new sibling or child headings on the
-original Org heading.
-@item
-Allow tagging of Gnus messages, by giving the message's registry
-entry an `org-tags key.
-@item
-Provide persistent nngnorb search groups.
-@item
-Allow automatic org-tagging of BBDB contacts: when messages from a
-contact are associated with an Org heading, make it possible for the
-contact to inherit that heading's tags automatically.
-@item
-Provide completion when setting Org tags on a BBDB contact.
-@item
-Provide a `gnorb-bbdb-view' command that opens a *Summary* buffer
-containing all the tracked messages from the contact(s) under point.
-@item
-Provide a `gnorb-view' command that takes a tags-todo search phrase
-(or a single Org heading ID), finds all relevant messages, Org
-headings, and BBDB records, and sets up a four-pane view: Org
-Agenda, **Article* SummaryBBDB* buffer, Gnus *buffer, and an *
-buffer.
-@end itemize
-
-@node Index
-@chapter Index
-
-@c Emacs 25.0.50.8 (Org mode 8.3beta)
+@c Emacs 25.0.50.10 (Org mode 8.3beta)
 @bye
\ No newline at end of file