README.org

   1
   2
   3 * Installation
   4   - put this path into your load-path
   5   - insert "(require 'org-fstree)" into ~/.emacs
   6
   7
   8 * Establishing links
   9 A link between a file and a headline is established
  10 by simply adding a link to the file to the headline
  11
  12 Examples:
  13
  14 ** Put your note here [[file:yourfile][And a link to one of your files here]]       :SOMETAG:
  15 ** A file you probably have [[file:~/.emacs]]                           :GNU:
  16
  17
  18 * Generating a static tree
  19
  20 ** Render as plain text
  21 Somewhere in your org file add the following line and press C-c C-c
  22 while on it:
  23 #+BEGIN_FSTREE: ~/ :non-recursive t
  24
  25 Removing the ':non-recursive' option will show a complete static
  26 representation of your home directory, which can take some time
  27 (abort with C-g).
  28
  29
  30 ** Using column view
  31   :PROPERTIES:
  32   :COLUMNS:  %40ITEM %Link1 %Link2
  33   :END:
  34
  35 Somewhere in your org file set the properties of some headline as done
  36 above, add the following line, press C-c C-c while on it and switch to
  37 column-view (C-c C-x C-c).
  38 #+BEGIN_FSTREE: ~/ :non-recursive t :links-as-properties
  39
  40 To add the complete subtree recursively remove the :non-recursive option.
  41 This will quickly become slow; you can stop generation with C-g.
  42
  43
  44
  45 ** Options
  46    - :non-recursive t , to suppress recursion into directories
  47    - :exclude-regexp-name <list of regexp strings> , exclude file/directory names matching either
  48      of the given regexp expressions
  49        Examples:
  50          :exclude-regexp-name (".*\\.pdf$" ".*\\.zip$"), excludes files/directories ending with either ".pdf" or ".zip"
  51          :exclude-regexp-name ("^\\.git$") , excludes files/directories named ".git"
  52    - :exclude-regexp-fullpath <list of regexp strings>, same as :exclude-regexp-name but matches absolute path to file/directory
  53    - :relative-links t , generates relative instead of absolute links
  54    - :show-only-matches t , only files that are being linked to show up
  55    - :links-as-properties t, sets the links as properties Link1, Link2,... for use in column view [Does not work with dynamic-update!]
  56
  57
  58 * Generating a dynamic tree
  59   :PROPERTIES:
  60   :COLUMNS:  %40ITEM %Link1 %Link2
  61   :END:
  62
  63 In a dynamic tree initially only the representation of the given
  64 directory's content is generated and the content of a subdirectory is
  65 dynamically generated or deleted on visibility change.
  66 This makes the complete filesystem browsable inside the org file.
  67
  68 Press C-c C-c on the following line. (BUG: Switching to column-view breaks dynamic update, but shows the links )
  69 #+BEGIN_FSTREE: ~/ :dynamic-update t