org-contrib/org-wikinodes.org

   1 #+TITLE:     org-wikinodes.el -- CamelCase wiki-like links to Org-mode nodes
   2 #+OPTIONS:   ^:{} author:nil
   3 #+STARTUP: odd
   4
   5 * Introduction
   6
   7 /org-wikinodes.el/ implements CamelCase wiki-like links in Org mode.
   8 However, while most wiki implementations use files as the basic data
   9 unit, it is more natural for Org to use outline nodes.
  10
  11 /org-wikinodes.el/ turns CamelCase words into links to CamelCase
  12 headlines and creates missing headlines if necessary.
  13
  14 * Installation
  15
  16 Like with most contribued modules, just customize the variable
  17 =org-modules= and select the line for /org-wikinodes/.
  18
  19 If you want to use this module only in some files/directories but not
  20 in others, set your general preference in the variable
  21 =org-wikinodes-active= and then use Emacs [[http://www.gnu.org/software/emacs/manual/html_node/emacs/File-Variables.html][file variables]] or
  22 [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html][directory-local variables]] to change things where necessary.
  23
  24 * How to use this module
  25
  26 When this package is activated, any headlines that consist of only a
  27 single CamelCase word, optionally with a TODO keyword, a priority
  28 cookie and tags, are treated as a wiki node.
  29
  30 #+begin_src org
  31   ,* TODO [#C] ThisIsAWikiNodeInOrgMode    :test:
  32 #+end_src
  33
  34 Writing the CamelCase word plainly in the text will create a link to
  35 that node.
  36
  37 Following the link will jump to it, and you can return to the previous
  38 position with =C-c &=.  If the target does not exist, it can be
  39 created.  By default the user will be asked if the target should be
  40 created, but the exact behavior can be modified using the user option
  41 =org-wikinodes-create-targets=.
  42
  43 * Wiki links across files
  44
  45 By default a match for a link is only attempted in the current file.
  46 However, you can make Org consider headlines in all org files in the
  47 same directory by setting
  48
  49 : (setq org-wikinodes-scope 'directory)
  50
  51 In this case, to speed things up, a cache is created that remembers in
  52 which file a particular node can be found.  The cache is updated
  53 directly if you create nodes automatically by following CamelCase
  54 links to non-existing headlines.  However, if you create a new node by
  55 hand (just typing it), then you need to clear the cache before the
  56 node can be found from a link in a different file.  To clear the
  57 cache, press =C-c C-c= in any headline that is just a CamelCase word.
  58
  59 * Export and publishing
  60
  61 /org-wikinodes.el/ fully supports export and publishing.  Links will
  62 be functional in the published version of the files.
  63
  64 * CamelCase words are hard to read
  65
  66 Yes, this is true.  If you find this problematic, try =glasses-mode=
  67 which makes =CamelCase= words more readable by displaying them like
  68 =Camel_Case=.
  69
  70 * Author
  71
  72 /org-wikinodes.el/ was written by Carsten Dominik.