org-contrib/org-velocity.org

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