]> code.delx.au - gnu-emacs-elpa/blobdiff - packages/gnorb/gnorb.info
Merging Gnorb commits up to 1.0.1
[gnu-emacs-elpa] / packages / gnorb / gnorb.info
index 64304bdcefdb40f892f695f39dbedbf181ac0c00..08085e10a1b001cb12046d91b24e8344ad4f913a 100644 (file)
@@ -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::
 
 \1f
 File: gnorb.info,  Node: Email-Related Commands,  Next: Trigger Actions,  Up: Email Tracking
@@ -202,10 +202,14 @@ Email tracking starts in one of three ways:
      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
@@ -230,8 +234,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’.
 
 \1f
 File: gnorb.info,  Node: Viewing Tracked Messages in *Summary* Buffers,  Next: Hinting in Gnus,  Prev: Trigger Actions,  Up: Email Tracking
@@ -277,7 +282,7 @@ is “g” (meaning it is used as “%ug” in the format line), and the mark is
 “¡”.
 
 \1f
-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
 =======================
@@ -303,6 +308,60 @@ Org 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.
 
+\1f
+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.
+
 \1f
 File: gnorb.info,  Node: Restoring Window Layout,  Next: Recent Mails From BBDB Contacts,  Prev: Email Tracking,  Up: Top
 
@@ -581,7 +640,7 @@ File: gnorb.info,  Node: User Optionsxx,  Prev: Viewing Org headlines relevant t
      format line.  Defaults to “¡”.
 
 \1f
-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 +688,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)))
 
-\1f
-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.
-
-\1f
-File: gnorb.info,  Node: Index,  Prev: Wishlist/TODO,  Up: Top
-
-14 Index
-********
-
 
 \1f
 Tag Table:
 Node: Top\7f194
-Node: Introduction\7f1017
-Node: Installation\7f2126
-Node: Setup\7f2540
-Node: Email Tracking\7f3907
-Node: Email-Related Commands\7f5418
-Node: Trigger Actions\7f8239
-Node: Viewing Tracked Messages in *Summary* Buffers\7f9053
-Node: Hinting in Gnus\7f10287
-Node: Message Attachments\7f11295
-Node: Restoring Window Layout\7f12453
-Node: Recent Mails From BBDB Contacts\7f12817
-Node: BBDB posting styles\7f13813
-Node: BBDB Org tagging\7f14729
-Node: Misc BBDB\7f15475
-Node: Searching for messages from BBDB contacts\7f15688
-Node: Citing BBDB contacts\7f16134
-Node: User Options\7f16455
-Node: Misc Org\7f17994
-Node: Inserting BBDB links\7f18169
-Node: User Optionsx\7f18424
-Node: Misc Gnus\7f21161
-Node: Viewing Org headlines relevant to a message\7f21374
-Node: User Optionsxx\7f21689
-Node: Suggested Keybindings\7f24453
-Node: Wishlist/TODO\7f26824
-Node: Index\7f28139
+Node: Introduction\7f1009
+Node: Installation\7f2118
+Node: Setup\7f2532
+Node: Email Tracking\7f3899
+Node: Email-Related Commands\7f5430
+Node: Trigger Actions\7f8440
+Node: Viewing Tracked Messages in *Summary* Buffers\7f9289
+Node: Hinting in Gnus\7f10523
+Node: Message Attachments\7f11531
+Node: Likely Workflow\7f12713
+Node: Restoring Window Layout\7f15518
+Node: Recent Mails From BBDB Contacts\7f15882
+Node: BBDB posting styles\7f16878
+Node: BBDB Org tagging\7f17794
+Node: Misc BBDB\7f18540
+Node: Searching for messages from BBDB contacts\7f18753
+Node: Citing BBDB contacts\7f19199
+Node: User Options\7f19520
+Node: Misc Org\7f21059
+Node: Inserting BBDB links\7f21234
+Node: User Optionsx\7f21489
+Node: Misc Gnus\7f24226
+Node: Viewing Org headlines relevant to a message\7f24439
+Node: User Optionsxx\7f24754
+Node: Suggested Keybindings\7f27518
 \1f
 End Tag Table