org-contrib/org-velocity.org

   1 #+TITLE:   org-velocity.el --- something like Notational Velocity for Org
   2 #+AUTHOR:    Paul M. Rodriguez
   3
   4 * General
   5
   6 =org-velocity= implements an interface for Org inspired by the
   7 minimalist notetaking program Notational Velocity.  The idea is to
   8 allow you to amass and access brief notes on many subjects
   9 with minimal fuss.
  10
  11 * How to use it
  12
  13 Org-velocity can be used in two ways: to store and access notes from
  14 anywhere in a universal bucket file; or to navigate any Org file.
  15
  16 ** The interface
  17
  18 The central command, =org-velocity-read=, prompts for search terms.
  19 The result is a list of all entries where those search terms appear,
  20 either in the heading or in the text.
  21
  22 If there is only one result, =org-velocity= offers to visit that entry
  23 in an indirect buffer.
  24
  25 If there are no results, =org-velocity= offers to create a new entry
  26 using =org-rememember= and supplies the search terms to the Remember
  27 buffer as its heading.
  28
  29 If there is more than one result, =org-velocity= displays a buffer
  30 with the headings of all matching entries.  An entry is selected
  31 either by clicking on it or typing the hint character beside it.  Once
  32 selected the entry is visited in an indirect buffer.
  33
  34 *** Navigating Org files
  35
  36 The easiest way to try =org-velocity= is in an existing Org file.
  37 First [[* Loading it][load it]], then run:
  38
  39 : M-x org-velocity-read
  40
  41 *** Using a bucket file
  42
  43 You can set a bucket file with:
  44
  45 : M-x customize-variable RET org-velocity-bucket RET
  46
  47 Org-velocity will then use the bucket file as its target whenever it
  48 is called outside of Org.
  49
  50 ** Configuration
  51
  52 To configure =org-velocity=, do:
  53
  54 : M-x customize-group RET org-velocity RET
  55
  56 You may also want to bind =org-velocity-read= to a key.  Add a line
  57 like this to your =.emacs=:
  58
  59 : (global-set-key (kbd "C-c v") 'org-velocity-read)
  60
  61 ** Loading it (No surprises here)
  62
  63 The easiest way is by
  64
  65         M-x customize-apropos org-modules
  66
  67 Check the line for velocity.  This will cause it to be loaded every
  68 time you start org-mode.
  69
  70 You'll still have to load it manually the first time.
  71
  72 Of course, you can also just try it out by loading it manually.
  73
  74 If you prefer to manually customize your emacs then make sure that the
  75 path to org's contrib directory is in your load-path and add the
  76 following to your =.emacs=.
  77
  78 : (require 'org-velocity)
  79
  80 * Credits
  81
  82   Paul M. Rodriguez wrote =org-velocity= incorporating suggestions
  83   from Carsten Dominik and Bastien Guerry.