code.delx.au - gnu-emacs-elpa/blob - packages/gnorb/gnorb.info

   1 This is gnorb.info, produced by makeinfo version 5.2 from gnorb.texi.
   2
   3 INFO-DIR-SECTION Emacs
   4 START-INFO-DIR-ENTRY
   5 * Gnorb: (gnorb).       Glue code for Gnus, Org, and BBDB.
   6 END-INFO-DIR-ENTRY
   7
   8 \1f
   9 File: gnorb.info,  Node: Top,  Next: Introduction,  Up: (dir)
  10
  11 Gnorb Manual
  12 ************
  13
  14 * Menu:
  15
  16 * Introduction::
  17 * Installation::
  18 * Setup::
  19 * Email Tracking::
  20 * Restoring Window Layout::
  21 * Recent Mails From BBDB Contacts::
  22 * BBDB posting styles::
  23 * BBDB Org tagging::
  24 * Misc BBDB::
  25 * Misc Org::
  26 * Misc Gnus::
  27 * Suggested Keybindings::
  28 * Wishlist/TODO::
  29 * Index::
  30
  31 — The Detailed Node Listing —
  32
  33 Email Tracking
  34
  35 * Email-Related Commands::
  36 * Trigger Actions::
  37 * Viewing Tracked Messages in *Summary* Buffers::
  38 * Hinting in Gnus::
  39 * Message Attachments::
  40
  41 Misc BBDB
  42
  43 * Searching for messages from BBDB contacts::
  44 * Citing BBDB contacts::
  45 * User Options::
  46
  47 Misc Org
  48
  49 * Inserting BBDB links::
  50 * User Options: User Optionsx.
  51
  52 Misc Gnus
  53
  54 * Viewing Org headlines relevant to a message::
  55 * User Options: User Optionsxx.
  56
  57 \1f
  58 File: gnorb.info,  Node: Introduction,  Next: Installation,  Prev: Top,  Up: Top
  59
  60 1 Introduction
  61 **************
  62
  63 Gnorb provides glue code between the Gnus, Org, and BBDB packages.  It’s
  64 aimed at supporting email-based project management, and generally making
  65 it easier to keep track of email communication.
  66
  67    Much of the code consists of single-use convenience functions, but
  68 tracking email conversations with Org requires is more complicated, and
  69 requires a bit of setup.
  70
  71    Gnorb can be used in a modular fashion, by selectively loading the
  72 files “gnorb-org”, “gnorb-gnus” or “gnorb-bbdb” instead of plain old
  73 “gnorb”.  The package as a whole is rather Org-centric, though, and it
  74 won’t do much of interest without “gnorb-org”.
  75
  76    This means that Gnorb doesn’t have hard requirements to any of the
  77 three base libraries.  For the libraries you are using, however, you’ll
  78 get best results from using the most recent stable version (yes, that
  79 means BBDB 3).  Some of the features in Gnorb only work with development
  80 versions of these libraries (those cases are noted below).
  81
  82 \1f
  83 File: gnorb.info,  Node: Installation,  Next: Setup,  Prev: Introduction,  Up: Top
  84
  85 2 Installation
  86 **************
  87
  88 Gnorb is best installed via the Elpa package manager – look for it in
  89 ‘list-packages’.
  90
  91    You can also clone the source code from
  92 <https://github.com/girzel/gnorb>, and put the “gnorb” directory on your
  93 load-path.  The Github site is also a good place to report bugs and
  94 other issues.
  95
  96 \1f
  97 File: gnorb.info,  Node: Setup,  Next: Email Tracking,  Prev: Installation,  Up: Top
  98
  99 3 Setup
 100 *******
 101
 102 Loading “gnorb” will make the basic functions available.  Using Gnorb
 103 for email tracking takes a bit more setup, however:
 104
 105   1. Email tracking is done via the Gnus registry, so that must be
 106      activated with ‘gnus-registry-initialize’.
 107   2. It also requires the org-id package to be loaded, and
 108      ‘org-id-track-globally’ set to t (that’s the default value, so
 109      simply loading the package should be enough).
 110   3. Add a nngnorb entry to your ‘gnus-secondary-select-methods’
 111      variable.  It will look like (nngnorb “Server name”).  This does
 112      nothing but provide a place to hang nnir searches.
 113   4. Then put a call to ‘gnorb-tracking-initialize’ in your init files,
 114      at some point after the Gnus registry is initialized.
 115   5. If you’re not using a local archive method for saving your sent
 116      messages (ie you’re using IMAP), you’ll also need to tell Gnorb
 117      where to find your sent messages.  Set the variable
 118      ‘gnorb-gnus-sent-groups’ to a list of strings; each string should
 119      indicate a fully-qualified group name, eg “nnimap+SERVER:GROUP”.
 120
 121    Lastly, Gnorb doesn’t bind any keys by default; see the *note
 122 Suggested Keybindings: Suggested Keybindings. section below for
 123 possibilities.
 124
 125 \1f
 126 File: gnorb.info,  Node: Email Tracking,  Next: Restoring Window Layout,  Prev: Setup,  Up: Top
 127
 128 4 Email Tracking
 129 ****************
 130
 131 The most interesting thing Gnorb does is using Org headings to track
 132 email conversations.  This can mean anything from reminding yourself to
 133 write to your mother, to conducting delicate business negotiations over
 134 email, to running an email-based bug tracker.
 135
 136    Gnorb assists in this process by using the Gnus registry to track
 137 correspondences between emails and Org headings – specifically, message
 138 IDs are associated with Org heading ids.  As a conversation develops,
 139 messages are collected on a heading (and/or its children).  You can
 140 compose new messages directly from the Org heading, and Gnorb will
 141 automatically associate your sent message with the conversation.  You
 142 can open temporary Gnus *Summary* buffers holding all the messages
 143 associated with an Org subtree, and reply from there.  When you receive
 144 new messages relevant to a conversation, Gnorb will notice them and
 145 prompt you to associate them with the appropriate Org heading.
 146 Attachments on incoming messages can be automatically saved as
 147 attachments on Org headings, using org-attach.
 148
 149    In general, the goal is to keep track of whole conversations, reduce
 150 friction when moving between Gnus and Org, and keep you in the Org
 151 agenda rather than in Gnus.
 152 * Menu:
 153
 154 * Email-Related Commands::
 155 * Trigger Actions::
 156 * Viewing Tracked Messages in *Summary* Buffers::
 157 * Hinting in Gnus::
 158 * Message Attachments::
 159
 160 \1f
 161 File: gnorb.info,  Node: Email-Related Commands,  Next: Trigger Actions,  Up: Email Tracking
 162
 163 4.1 Email-Related Commands
 164 ==========================
 165
 166 Email tracking starts in one of three ways:
 167
 168   1. With an Org heading that represents an email TODO. Call
 169      ‘gnorb-org-handle-mail’ (see below) on the heading to compose a new
 170      message, and start the tracking process.
 171   2. By calling org-capture on a received message.  Any heading captured
 172      from a message will automatically be associated with that message.
 173   3. By calling ‘gnorb-gnus-outgoing-do-todo’ in a message composition
 174      buffer – see below.
 175
 176    There are three main email-related commands:
 177
 178   1. ‘gnorb-org-handle-mail’ is called on an Org heading to compose a
 179      new message.  By default, this will begin a reply to the most
 180      recent message in the conversation.  If there are no associated
 181      messages to reply to (or you call the function with a double prefix
 182      arg), Gnorb will look for mailto: or bbdb: links in the heading,
 183      and compose a new message to them.
 184
 185      The sent message will be associated with the Org heading, and
 186      you’ll be brought back to the heading and asked to trigger an
 187      action on it.
 188
 189      ‘gnorb-email-subtree’ is an alternative entry-point to
 190      ‘gnorb-org-handle-mail’.  It does the same thing as the latter, but
 191      first exports the body of the subtree as either text or a file,
 192      then inserts the text into the message body, or attaches the file
 193      to the message, depending on what you’ve chosen.
 194   2. ‘gnorb-gnus-incoming-do-todo’ is called on a message in a Gnus
 195      *Summary* buffer.  You’ll be prompted for an Org heading, taken to
 196      that heading, and asked to trigger an action on it.
 197   3. ‘gnorb-gnus-outgoing-do-todo’ is called in message mode, while
 198      composing a new message.
 199
 200      If called without a prefix arg, a new Org heading will be created
 201      after the message is sent, and the sent message associated with it.
 202      The new heading will be created as a capture heading, using the
 203      template specified by the ‘gnorb-gnus-new-todo-capture-key’ option.
 204
 205      If you call this function with a prefix arg, you’ll be prompted to
 206      choose an existing Org heading instead.  After the the message is
 207      sent, you’ll be taken to that heading and prompted to trigger an
 208      action on it.
 209
 210      It’s also possible to call this function *after* a message is sent,
 211      in case you forgot.  Gnorb saves information about the most
 212      recently sent message for this purpose.
 213
 214    Because these three commands all express a similar intent, but are
 215 called in different modes, it can make sense to give each of them the
 216 same keybinding in the keymaps for Org mode, Gnus summary mode, and
 217 Message mode, respectively.
 218
 219 \1f
 220 File: gnorb.info,  Node: Trigger Actions,  Next: Viewing Tracked Messages in *Summary* Buffers,  Prev: Email-Related Commands,  Up: Email Tracking
 221
 222 4.2 Trigger Actions
 223 ===================
 224
 225 After calling ‘gnorb-gnus-incoming-do-todo’ on a message, or after
 226 sending a message associated with an Org heading, you’ll be taken to the
 227 heading and asked to “trigger an action” on it.  At the moment there are
 228 four different possibilities: triggering a TODO state-change on the
 229 heading, taking a note on the heading (both these options will associate
 230 the message with the heading), associating the message but doing nothing
 231 else, and lastly, doing nothing at all.
 232
 233    More actions will be added in the future; it’s also possible to add
 234 your own action: see the docstring of ‘gnorb-org-trigger-actions’.
 235
 236 \1f
 237 File: gnorb.info,  Node: Viewing Tracked Messages in *Summary* Buffers,  Next: Hinting in Gnus,  Prev: Trigger Actions,  Up: Email Tracking
 238
 239 4.3 Viewing Tracked Messages in *Summary* Buffers
 240 =================================================
 241
 242 Call ‘gnorb-org-view’ on an Org heading to open an nnir *Summary* buffer
 243 showing all the messages associated with that heading (this requires
 244 that you’ve added an nngnorb server to your Gnus backends).  A minor
 245 mode will be in effect, ensuring that any replies you send to messages
 246 in this buffer will automatically be associated with the original Org
 247 heading.  You can also invoke ‘gnorb-summary-disassociate-message’ (“C-c
 248 d”) to disassociate the message with the Org heading.
 249
 250    As a bonus, it’s possible to go into Gnus’ *Server* buffer, find the
 251 line specifying your nngnorb server, and hit “G” (aka
 252 ‘gnus-group-make-nnir-group’).  At the query prompt, enter an Org-style
 253 tags-todo Agenda query string (eg “+work-computer”, or what have you).
 254 Gnorb will find all headings matching this query, scan their subtrees
 255 for gnus links, and then give you a Summary buffer containing all the
 256 linked messages.  This is dog-slow at the moment; it will get faster.
 257
 258 \1f
 259 File: gnorb.info,  Node: Hinting in Gnus,  Next: Message Attachments,  Prev: Viewing Tracked Messages in *Summary* Buffers,  Up: Email Tracking
 260
 261 4.4 Hinting in Gnus
 262 ===================
 263
 264 When you receive new mails that might be relevant to existing Org TODOs,
 265 Gnorb can alert you to that fact.  When
 266 ‘gnorb-gnus-hint-relevant-article’ is t (the default), Gnorb will
 267 display a message in the minibuffer when opening potentially relevant
 268 messages.  You can then use ‘gnorb-gnus-incoming-to-todo’ to trigger an
 269 action on the relevant TODO.
 270
 271    This hinting can happen in the Gnus summary buffer as well.  If you
 272 use the escape indicated by ‘gnorb-gnus-summary-mark-format-letter” as
 273 part of your ‘gnus-summary-line-format’, articles that are relevant to
 274 TODOs will be marked with a special character in the Summary buffer, as
 275 determined by ‘gnorb-gnus-summary-mark’.  By default, the format letter
 276 is “g” (meaning it is used as “%ug” in the format line), and the mark is
 277 “¡”.
 278
 279 \1f
 280 File: gnorb.info,  Node: Message Attachments,  Prev: Hinting in Gnus,  Up: Email Tracking
 281
 282 4.5 Message Attachments
 283 =======================
 284
 285 Gnorb simplifies the handling of attachments that you receive in emails.
 286 When you call ‘gnorb-gnus-incoming-do-todo’ on a message, you’ll be
 287 prompted to re-attach the email’s attachments onto the Org heading,
 288 using the org-attach library.
 289
 290    You can also do this as part of the capture process.  Set the new
 291 :gnus-attachments key to “t” in a capture template that you use on mail
 292 messages, and you’ll be queried to re-attach the message’s attachments
 293 onto the newly-captured heading.  Or set
 294 ‘gnorb-gnus-capture-always-attach’ to “t” to have Gnorb do this for all
 295 capture templates.
 296
 297    You can also do this using the regular system of MIME commands,
 298 without invoking the email tracking process.  See *note Suggested
 299 Keybindings: Suggested Keybindings, below.
 300
 301    The same process works in reverse: when you send a message from an
 302 Org heading using ‘gnorb-org-handle-mail’, Gnorb will ask if you want to
 303 attach the files in the heading’s org-attach directory to the outgoing
 304 message.
 305
 306 \1f
 307 File: gnorb.info,  Node: Restoring Window Layout,  Next: Recent Mails From BBDB Contacts,  Prev: Email Tracking,  Up: Top
 308
 309 5 Restoring Window Layout
 310 *************************
 311
 312 Many Gnorb functions alter the window layout and value of point.  In
 313 most of these cases, you can restore the previous layout using the
 314 interactive function ‘gnorb-restore-layout’.
 315
 316 \1f
 317 File: gnorb.info,  Node: Recent Mails From BBDB Contacts,  Next: BBDB posting styles,  Prev: Restoring Window Layout,  Up: Top
 318
 319 6 Recent Mails From BBDB Contacts
 320 *********************************
 321
 322 If you’re using a recent git version of BBDB (circa mid-May 2014 or
 323 later), you can give your BBDB contacts a special field which will
 324 collect links to recent emails from that contact.  The default name of
 325 the field is “messages”, but you can customize that name using the
 326 ‘gnorb-bbdb-messages-field’ option.
 327
 328    Gnorb will not collect links by default: you need to call
 329 ‘gnorb-bbdb-open-link’ on a contact once to start the process.
 330 Thereafter, opening mails from that contact will store a link to the
 331 message.
 332
 333    Once some links are stored, ‘gnorb-bbdb-open-link’ will open them:
 334 Use a prefix arg to the function call to select particular messages to
 335 open.  There are several options controlling how all this works; see the
 336 gnorb-bbdb user options section below for details.
 337
 338 \1f
 339 File: gnorb.info,  Node: BBDB posting styles,  Next: BBDB Org tagging,  Prev: Recent Mails From BBDB Contacts,  Up: Top
 340
 341 7 BBDB posting styles
 342 *********************
 343
 344 Gnorb comes with a BBDB posting-style system, inspired by (copied from)
 345 gnus-posting-styles.  You can specify how messages are composed to
 346 specific contacts, by matching on contact field values (the same way
 347 gnus-posting-styles matches on group names).  See the docstring of
 348 ‘gnorb-bbdb-posting-styles’ for details.
 349
 350    In order not to be too intrusive, Gnorb doesn’t alter the behavior of
 351 ‘bbdb-mail’, the usual mail-composition function.  Instead it provides
 352 an alternate ‘gnorb-bbdb-mail’, which does exactly the same thing, but
 353 first processes the new mail according to ‘gnorb-bbdb-posting-styles’.
 354 If you want to use this feature regularly, you can remap ‘bbdb-mail’ to
 355 ‘gnorb-bbdb-mail’ in the ‘bbdb-mode-map’.
 356
 357 \1f
 358 File: gnorb.info,  Node: BBDB Org tagging,  Next: Misc BBDB,  Prev: BBDB posting styles,  Up: Top
 359
 360 8 BBDB Org tagging
 361 ******************
 362
 363 BBDB contacts can be tagged with the same tags you use in your Org
 364 files.  This allows you to pop up a *BBDB* buffer alongside your Org
 365 Agenda when searching for certain tags.  This can happen automatically
 366 for all Org tags-todo searches, if you set the option
 367 ‘gnorb-org-agenda-popup-bbdb’ to t.  Or you can do it manually, by
 368 calling the command of the same name.  This command only shows TODOs by
 369 default: use a prefix argument to show all tagged headings.
 370
 371    Tags are stored in an xfield named org-tags, by default.  You can
 372 customize the name of this field using ‘gnorb-bbdb-org-tag-field’.
 373
 374 \1f
 375 File: gnorb.info,  Node: Misc BBDB,  Next: Misc Org,  Prev: BBDB Org tagging,  Up: Top
 376
 377 9 Misc BBDB
 378 ***********
 379
 380 * Menu:
 381
 382 * Searching for messages from BBDB contacts::
 383 * Citing BBDB contacts::
 384 * User Options::
 385
 386 \1f
 387 File: gnorb.info,  Node: Searching for messages from BBDB contacts,  Next: Citing BBDB contacts,  Up: Misc BBDB
 388
 389 9.1 Searching for messages from BBDB contacts
 390 =============================================
 391
 392 Call ‘gnorb-bbdb-mail-search’ to search for all mail messages from the
 393 record(s) displayed.  Currently supports the notmuch, mairix, and namazu
 394 search backends; set ‘gnorb-gnus-mail-search-backend’ to one of those
 395 symbol values.
 396
 397 \1f
 398 File: gnorb.info,  Node: Citing BBDB contacts,  Next: User Options,  Prev: Searching for messages from BBDB contacts,  Up: Misc BBDB
 399
 400 9.2 Citing BBDB contacts
 401 ========================
 402
 403 Calling ‘gnorb-bbdb-cite-contact’ will prompt for a BBDB record and
 404 insert a string of the type “Bob Smith <bob@smith.com>”.
 405
 406 \1f
 407 File: gnorb.info,  Node: User Options,  Prev: Citing BBDB contacts,  Up: Misc BBDB
 408
 409 9.3 User Options
 410 ================
 411
 412 ‘`gnorb-bbdb-org-tag-field’
 413      The name of the BBDB xfield, as a symbol, that holds Org-related
 414      tags.  Specified as a string with the “:” separator between tags,
 415      same as for Org headings.  Defaults to org-tag.
 416 ‘`gnorb-bbdb-messages-field'’
 417      The name of the BBDB xfield that holds links to recently-received
 418      messages from this contact.  Defaults to ‘messages.
 419 ‘`gnorb-bbdb-collect-N-messages'’
 420      Collect at most this many links to messages from this contact.
 421      Defaults to 5.
 422 ‘`gnorb-bbdb-define-recent'’
 423      What does “recently-received” mean?  Possible values are the
 424      symbols seen and received.  When set to seen, the most
 425      recently-opened messages are collected.  When set to received, the
 426      most recently-received (by Date header) messages are collected.
 427      Defaults to seen.
 428 ‘`gnorb-bbdb-message-link-format-multi'’
 429      How is a single message’s link formatted in the multi-line BBDB
 430      layout format?  Defaults to “%:count.  %D: %:subject” (see the
 431      docstring for details).
 432 ‘` gnorb-bbdb-message-link-format-one'’
 433      How is a single message’s link formatted in the one-line BBDB
 434      layout format?  Defaults to nil (see the docstring for details).
 435 ‘`gnorb-bbdb-posting-styles'’
 436      Styles to use for influencing the format of mails composed to the
 437      BBDB record(s) under point (see the docstring for details).
 438
 439 \1f
 440 File: gnorb.info,  Node: Misc Org,  Next: Misc Gnus,  Prev: Misc BBDB,  Up: Top
 441
 442 10 Misc Org
 443 ***********
 444
 445 * Menu:
 446
 447 * Inserting BBDB links::
 448 * User Options: User Optionsx.
 449
 450 \1f
 451 File: gnorb.info,  Node: Inserting BBDB links,  Next: User Optionsx,  Up: Misc Org
 452
 453 10.1 Inserting BBDB links
 454 =========================
 455
 456 Calling ‘gnorb-org-contact-link’ will prompt for a BBDB record and
 457 insert an Org link to that record at point.
 458
 459 \1f
 460 File: gnorb.info,  Node: User Optionsx,  Prev: Inserting BBDB links,  Up: Misc Org
 461
 462 10.2 User Options
 463 =================
 464
 465 ‘`gnorb-org-after-message-setup-hook'’
 466      Hook run in a message buffer after setting up the message, from
 467      ‘gnorb-org-handle-mail’ or ‘gnorb-org-email-subtree’.
 468 ‘`gnorb-org-trigger-actions'’
 469      List of potential actions that can be taken on headings after a
 470      message is sent.  See docstring for details.
 471 ‘`gnorb-org-mail-scan-scope'’
 472      The number of paragraphs to scan for mail-related links.  This
 473      comes into play when calling ‘gnorb-org-handle-mail’ on a heading
 474      with no associated messages, or when ‘gnorb-org-handle-mail’ is
 475      called with a prefix arg.
 476 ‘`gnorb-org-find-candidates-match'’
 477      When searching all Org files for headings to collect messages from,
 478      this option can limit which headings are searched.  It is used as
 479      the second argument to a call to ‘org-map-entries’, and has the
 480      same syntax as that used in an agenda tags view.
 481 ‘`gnorb-org-email-subtree-text-parameters'’
 482      A plist of export parameters corresponding to the EXT-PLIST
 483      argument to the export functions, for use when exporting to text.
 484 ‘`gnorb-org-email-subtree-file-parameters'’
 485      A plist of export parameters corresponding to the EXT-PLIST
 486      argument to the export functions, for use when exporting to a file.
 487 ‘`gnorb-org-email-subtree-text-options'’
 488      A list of ts and nils corresponding to Org’s export options, to be
 489      used when exporting to text.  The options, in order, are async,
 490      subtreep, visible-only, and body-only.
 491 ‘`gnorb-org-email-subtree-file-options'’
 492      A list of ts and nils corresponding to Org’s export options, to be
 493      used when exporting to a file.  The options, in order, are async,
 494      subtreep, visible-only, and body-only.
 495 ‘`gnorb-org-export-extensions'’
 496      Correspondence between export backends and their respective (usual)
 497      file extensions.
 498 ‘`gnorb-org-capture-collect-link-p'’
 499      When this is set to t, the capture process will always store a link
 500      to the Gnus message or BBDB record under point, even when the link
 501      isn’t part of the capture template.  It can then be added to the
 502      captured heading with org-insert-link, as usual.
 503 ‘`gnorb-org-agenda-popup-bbdb'’
 504      Set to “t” to automatically pop up the BBDB buffer displaying
 505      records corresponding to the Org Agenda tags search underway.  If
 506      this is nil you can always do it manually with the command of the
 507      same name.
 508 ‘`gnorb-org-bbdb-popup-layout'’
 509      Controls the layout of the Agenda-related BBDB popup, takes the
 510      same values as bbdb-pop-up-layout.
 511
 512 \1f
 513 File: gnorb.info,  Node: Misc Gnus,  Next: Suggested Keybindings,  Prev: Misc Org,  Up: Top
 514
 515 11 Misc Gnus
 516 ************
 517
 518 * Menu:
 519
 520 * Viewing Org headlines relevant to a message::
 521 * User Options: User Optionsxx.
 522
 523 \1f
 524 File: gnorb.info,  Node: Viewing Org headlines relevant to a message,  Next: User Optionsxx,  Up: Misc Gnus
 525
 526 11.1 Viewing Org headlines relevant to a message
 527 ================================================
 528
 529 Call ‘gnorb-gnus-view’ on a message that is associated with an Org
 530 heading to jump to that heading.
 531
 532 \1f
 533 File: gnorb.info,  Node: User Optionsxx,  Prev: Viewing Org headlines relevant to a message,  Up: Misc Gnus
 534
 535 11.2 User Options
 536 =================
 537
 538 ‘`gnorb-gnus-mail-search-backend'’
 539      Specifies the search backend that you use for searching mails.
 540      Currently supports notmuch, mairix, and namazu: set this option to
 541      one of those symbols.
 542 ‘`gnorb-gnus-capture-always-attach'’
 543      Treat all capture templates as if they had the :gnus-attachments
 544      key set to “t”.  This only has any effect if you’re capturing from
 545      a Gnus summary or article buffer.
 546 ‘`gnorb-trigger-todo-default'’
 547      Set to either ‘note or ‘todo to tell ‘gnorb-gnus-incoming-do-todo’
 548      what to do by default.  You can reach the non-default behavior by
 549      calling that function with a prefix argument.  Alternately, set to
 550      ‘prompt to always prompt for the appropriate action.
 551 ‘`gnorb-gnus-trigger-refile-targets'’
 552      If you use ‘gnorb-gnus-incoming-do-todo’ on an incoming message,
 553      Gnorb will try to locate a TODO heading that’s relevant to that
 554      message.  If it can’t, it will prompt you for one, using the refile
 555      interface.  This option will be used as the value of
 556      ‘org-refile-targets’ during that process: see the docstring of
 557      ‘org-refile-targets’ for the appropriate syntax.
 558 ‘`gnorb-gnus-new-todo-capture-key'’
 559      Set this to a single-character string pointing at an Org capture
 560      template to use when creating TODOs from outgoing messages.  The
 561      template is a regular capture template, with a few exceptions.  If
 562      Gnus helps you archive outgoing messages (ie you have
 563      ‘gnus-message-archive-group’ set to something, and your outgoing
 564      messages have a “Fcc” header), a link to that message will be made,
 565      and you’ll be able to use all the escapes related to gnus messages.
 566      If you don’t archive outgoing messages, you’ll still be able to use
 567      the %:subject, %:to, %:toname, %:toaddress, and %:date escapes in
 568      the capture template.
 569 ‘`gnorb-gnus-hint-relevant-article'’
 570      Set to “t” (the default) to have Gnorb give you a hint in the
 571      minibuffer when opening messages that might be relevant to existing
 572      Org TODOs.
 573 ‘`gnorb-gnus-summary-mark-format-letter'’
 574      The formatting letter to use as part of your
 575      ‘gnus-summary-line-format’, to indicate messages which might be
 576      relevant to Org TODOs.  Defaults to “g”, meaning it should be used
 577      as “%ug” in the format line.
 578 ‘`gnorb-gnus-summary-mark'’
 579      The mark used to indicate relevant messages in the Summary buffer,
 580      when ‘gnorb-gnus-summary-mark-format-letter’ is present in the
 581      format line.  Defaults to “¡”.
 582
 583 \1f
 584 File: gnorb.info,  Node: Suggested Keybindings,  Next: Wishlist/TODO,  Prev: Misc Gnus,  Up: Top
 585
 586 12 Suggested Keybindings
 587 ************************
 588
 589      (eval-after-load "gnorb-bbdb"
 590        '(progn
 591           (define-key bbdb-mode-map (kbd "O") 'gnorb-bbdb-tag-agenda)
 592           (define-key bbdb-mode-map (kbd "S") 'gnorb-bbdb-mail-search)
 593           (define-key bbdb-mode-map [remap bbdb-mail] 'gnorb-bbdb-mail)
 594           (define-key bbdb-mode-map (kbd "l") 'gnorb-bbdb-open-link)
 595           (global-set-key (kbd "C-c C") 'gnorb-bbdb-cite-contact)))
 596
 597      (eval-after-load "gnorb-org"
 598        '(progn
 599           (org-defkey org-mode-map (kbd "C-c C") 'gnorb-org-contact-link)
 600           (org-defkey org-mode-map (kbd "C-c t") 'gnorb-org-handle-mail)
 601           (org-defkey org-mode-map (kbd "C-c e") 'gnorb-org-view)
 602           (org-defkey org-mode-map (kbd "C-c E") 'gnorb-org-email-subtree)
 603           (org-defkey org-mode-map (kbd "C-c V") 'gnorb-org-popup-bbdb)
 604           (setq gnorb-org-agenda-popup-bbdb t)
 605           (eval-after-load "org-agenda"
 606             '(progn (org-defkey org-agenda-mode-map (kbd "H") 'gnorb-org-handle-mail)
 607                     (org-defkey org-agenda-mode-map (kbd "V") 'gnorb-org-popup-bbdb)))))
 608
 609      (eval-after-load "gnorb-gnus"
 610        '(progn
 611           (define-key gnus-summary-mime-map "a" 'gnorb-gnus-article-org-attach)
 612           (define-key gnus-summary-mode-map (kbd "C-c t") 'gnorb-gnus-incoming-do-todo)
 613           (push '("attach to org heading" . gnorb-gnus-mime-org-attach)
 614                 gnus-mime-action-alist)
 615           ;; The only way to add mime button command keys is by redefining
 616           ;; gnus-mime-button-map, possibly not ideal. Ideal would be a
 617           ;; setter function in gnus itself.
 618           (push '(gnorb-gnus-mime-org-attach "a" "Attach to Org heading")
 619                 gnus-mime-button-commands)
 620           (setq gnus-mime-button-map
 621                 (let ((map (make-sparse-keymap)))
 622                   (define-key map gnus-mouse-2 'gnus-article-push-button)
 623                   (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
 624                   (dolist (c gnus-mime-button-commands)
 625                     (define-key map (cadr c) (car c)))
 626                   map))))
 627
 628      (eval-after-load "message"
 629        '(progn
 630           (define-key message-mode-map (kbd "C-c t") 'gnorb-gnus-outgoing-do-todo)))
 631
 632 \1f
 633 File: gnorb.info,  Node: Wishlist/TODO,  Next: Index,  Prev: Suggested Keybindings,  Up: Top
 634
 635 13 Wishlist/TODO
 636 ****************
 637
 638    • Provide a command that, when in the Org Agenda, does an email
 639      search for messages received in the visible date span, or day under
 640      point, etc.  Make it work in the calendar, as well?
 641    • Add trigger actions that create new sibling or child headings on
 642      the original Org heading.
 643    • Allow tagging of Gnus messages, by giving the message’s registry
 644      entry an ‘org-tags key.
 645    • Provide persistent nngnorb search groups.
 646    • Allow automatic org-tagging of BBDB contacts: when messages from a
 647      contact are associated with an Org heading, make it possible for
 648      the contact to inherit that heading’s tags automatically.
 649    • Provide completion when setting Org tags on a BBDB contact.
 650    • Provide a ‘gnorb-bbdb-view’ command that opens a *Summary* buffer
 651      containing all the tracked messages from the contact(s) under
 652      point.
 653    • Provide a ‘gnorb-view’ command that takes a tags-todo search phrase
 654      (or a single Org heading ID), finds all relevant messages, Org
 655      headings, and BBDB records, and sets up a four-pane view: Org
 656      Agenda, **Article* SummaryBBDB* buffer, Gnus *buffer, and an *
 657      buffer.
 658
 659 \1f
 660 File: gnorb.info,  Node: Index,  Prev: Wishlist/TODO,  Up: Top
 661
 662 14 Index
 663 ********
 664
 665
 666 \1f
 667 Tag Table:
 668 Node: Top\7f194
 669 Node: Introduction\7f1017
 670 Node: Installation\7f2126
 671 Node: Setup\7f2540
 672 Node: Email Tracking\7f3907
 673 Node: Email-Related Commands\7f5418
 674 Node: Trigger Actions\7f8239
 675 Node: Viewing Tracked Messages in *Summary* Buffers\7f9053
 676 Node: Hinting in Gnus\7f10287
 677 Node: Message Attachments\7f11295
 678 Node: Restoring Window Layout\7f12453
 679 Node: Recent Mails From BBDB Contacts\7f12817
 680 Node: BBDB posting styles\7f13813
 681 Node: BBDB Org tagging\7f14729
 682 Node: Misc BBDB\7f15475
 683 Node: Searching for messages from BBDB contacts\7f15688
 684 Node: Citing BBDB contacts\7f16134
 685 Node: User Options\7f16455
 686 Node: Misc Org\7f17994
 687 Node: Inserting BBDB links\7f18169
 688 Node: User Optionsx\7f18424
 689 Node: Misc Gnus\7f21161
 690 Node: Viewing Org headlines relevant to a message\7f21374
 691 Node: User Optionsxx\7f21689
 692 Node: Suggested Keybindings\7f24453
 693 Node: Wishlist/TODO\7f26824
 694 Node: Index\7f28139
 695 \1f
 696 End Tag Table
 697
 698 \1f
 699 Local Variables:
 700 coding: utf-8
 701 End: