]> code.delx.au - gnu-emacs-elpa/blobdiff - packages/gnorb/gnorb.texi
Merging Gnorb commits up to 1.0.1
[gnu-emacs-elpa] / packages / gnorb / gnorb.texi
index 643552fbb62ba81eb85370893266f923d4e56652..f1fccc5cb2760a6d3f5f560eec56be0cd79cbd9e 100644 (file)
@@ -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
@@ -216,10 +216,14 @@ after the message is sent, and the sent message associated with it.
 The new heading will be created as a capture heading, using the
 template specified by the `gnorb-gnus-new-todo-capture-key' option.
 
-If you call this function with a prefix arg, you'll be prompted to
-choose an existing Org heading instead. After the the message is
-sent, you'll be taken to that heading and prompted to trigger an
-action on it.
+If you call this function with a single prefix arg, you'll be
+prompted to choose an existing Org heading instead. After the the
+message is sent, you'll be taken to that heading and prompted to
+trigger an action on it.
+
+If you've called this function, and then realize you've associated
+the message with the wrong TODO, call it again with a double prefix
+to clear all associations.
 
 It's also possible to call this function *after* a message is sent,
 in case you forgot. Gnorb saves information about the most recently
@@ -242,8 +246,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 +312,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 +672,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)
 @bye
\ No newline at end of file