switch to version 3.0.1

Path.New was expecting an absolute path. Now we convert paths to
absolute inside Path.New

doc/NERD_tree.txt

@@ -21,19 +21,21 @@ CONTENTS                                                   *NERDTree-contents*
 
     1.Intro...................................|NERDTree|
     2.Functionality provided..................|NERDTreeFunctionality|
-        2.1 Global commands...................|NERDTreeGlobalCommands|
-        2.2 Bookmark commands.................|NERDTreeBookmarkCommands|
-        2.3 NERD tree mappings................|NERDTreeMappings|
-        2.4 The filesystem menu...............|NERDTreeFilesysMenu|
+        2.1.Global commands...................|NERDTreeGlobalCommands|
+        2.2.Bookmarks.........................|NERDTreeBookmarks|
+            2.2.1.The bookmark table..........|NERDTreeBookmarkTable|
+            2.2.2.Bookmark commands...........|NERDTreeBookmarkCommands|
+            2.2.3.Invalid bookmarks...........|NERDTreeInvalidBookmarks|
+        2.3.NERD tree mappings................|NERDTreeMappings|
+        2.4.The filesystem menu...............|NERDTreeFilesysMenu|
     3.Options.................................|NERDTreeOptions|
-        3.1 Option summary....................|NERDTreeOptionSummary|
-        3.2 Option details....................|NERDTreeOptionDetails|
-    4.Public functions........................|NERDTreePublicFunctions|
-    5.TODO list...............................|NERDTreeTodo|
-    6.The Author..............................|NERDTreeAuthor|
-    7.Changelog...............................|NERDTreeChangelog|
-    8.Credits.................................|NERDTreeCredits|
-    9.License.................................|NERDTreeLicense|
+        3.1.Option summary....................|NERDTreeOptionSummary|
+        3.2.Option details....................|NERDTreeOptionDetails|
+    4.Hacking the NERD tree...................|NERDTreeHacking|
+    5.About...................................|NERDTreeAbout|
+    6.Changelog...............................|NERDTreeChangelog|
+    7.Credits.................................|NERDTreeCredits|
+    8.License.................................|NERDTreeLicense|
 
 ==============================================================================
 1. Intro                                                            *NERDTree*
@@ -62,7 +64,7 @@ The following features and functionality are provided by the NERD tree:
         * ...
     * Directories and files can be bookmarked.
     * Most NERD tree navigation can also be done with the mouse
-    * Dynamic customisation of tree content
+    * Filtering of tree content (can be toggled at runtime)
         * custom file filters to prevent e.g. vim backup files being displayed
         * optional displaying of hidden files (. files)
         * files can be "turned off" so that only directories are displayed
@@ -78,9 +80,13 @@ The following features and functionality are provided by the NERD tree:
           session, the directory nodes will be opened/closed as you left them
     * The script remembers the cursor position and window position in the NERD
       tree so you can toggle it off (or just close the tree window) and then
-      reopen it (with NERDTreeToggle) the NERD tree window will appear EXACTLY
+      reopen it (with NERDTreeToggle) the NERD tree window will appear exactly
       as you left it
-    * You can have a separate NERD tree for each tab
+    * You can have a separate NERD tree for each tab, share trees across tabs,
+      or a mix of both.
+    * By default the script overrides the default file browser (netw), so if
+      you :edit a directory a (slighly modified) NERD tree will appear in the
+      current window
 
 ==============================================================================
 2. Functionality provided                              *NERDTreeFunctionality*
@@ -106,22 +112,39 @@ The following features and functionality are provided by the NERD tree:
     again.  If no NERD tree exists for this tab then this command acts the
     same as the |:NERDTree| command.
 
-:NERDTreeClose
+:NERDTreeMirror                                              *:NERDTreeMirror*
+    Shares an existing NERD tree, from another tab, in the current tab.
+    Changes made to one tree are reflected in both as they are actually the
+    same buffer.
+
+    If only one other NERD tree exists, that tree is automatically mirrored. If
+    more than one exists, the script will ask which tree to mirror.
+
+:NERDTreeClose                                                *:NERDTreeClose*
     Close the NERD tree in this tab.
 
 ------------------------------------------------------------------------------
-2.2. Bookmark Commands                              *NERDTreeBookmarkCommands*
+2.2. Bookmarks                                             *NERDTreeBookmarks*
 
 Bookmarks in the NERD tree are a way to tag files or directories of interest.
 For example, you could use bookmarks to tag all of your project directories.
-See also |:NERDTree| and |:NERDTreeFromBookmark|.
+
+------------------------------------------------------------------------------
+2.2.1. The Bookmark Table                              *NERDTreeBookmarkTable*
+
+If the bookmark table is active (see |NERDTree-B| and
+|'NERDTreeShowBookmarks'|), it will be rendered above the tree. You can double
+click bookmarks or use the |NERDTree-o| mapping to activate them. See also,
+|NERDTree-t| and |NERDTree-T|
+
+------------------------------------------------------------------------------
+2.2.2. Bookmark commands                            *NERDTreeBookmarkCommands*
 
 Note that the following commands are only available in the NERD tree buffer.
 
 :Bookmark <name>
     Bookmark the current node as <name>. If there is already a <name>
-    bookmark, it is overwritten. <name> must consist of alphanumeric
-    characters and underscores.
+    bookmark, it is overwritten. <name> must not contain spaces.
 
 :BookmarkToRoot <bookmark>
     Make the directory corresponding to <bookmark> the new root. If a treenode
@@ -147,28 +170,51 @@ Note that the following commands are only available in the NERD tree buffer.
 :ClearAllBookmarks
     Remove all bookmarks.
 
+:ReadBookmarks
+    Re-read the bookmarks in the |'NERDTreeBookmarksFile'|.
+
+See also |:NERDTree| and |:NERDTreeFromBookmark|.
+
+------------------------------------------------------------------------------
+2.2.3. Invalid Bookmarks                            *NERDTreeInvalidBookmarks*
+
+If invalid bookmarks are detected, the script will issue an error message and
+the invalid bookmarks will become unavailable for use.
+
+These bookmarks will still be stored in the bookmarks file (see
+|'NERDTreeBookmarksFile'|), down the bottom. There will always be a blank line
+after the valid bookmarks but before the invalid ones.
+
+Each line in the bookmarks file represents one bookmark. The proper format is:
+<bookmark name><space><full path to the bookmark location>
+
+After you have corrected any invalid bookmarks, either restart vim, or go
+:ReadBookmarks from the NERD tree window.
+
 ------------------------------------------------------------------------------
 2.3. NERD tree Mappings                                     *NERDTreeMappings*
 
 Default  Description~                                             help-tag~
 Key~
 
-o.......Open selected file, or expand selected dir...............|NERDTree-o|
+o.......Open files, directories and bookmarks....................|NERDTree-o|
 go......Open selected file, but leave cursor in the NERDTree.....|NERDTree-go|
-t.......Open selected node in a new tab..........................|NERDTree-t|
+t.......Open selected node/bookmark in a new tab.................|NERDTree-t|
 T.......Same as 't' but keep the focus on the current tab........|NERDTree-T|
-<tab>...Open selected file in a split window.....................|NERDTree-tab|
-g<tab>..Same as <tab>, but leave the cursor on the NERDTree......|NERDTree-gtab|
+i.......Open selected file in a split window.....................|NERDTree-i|
+gi......Same as i, but leave the cursor on the NERDTree..........|NERDTree-i|
 !.......Execute the current file.................................|NERDTree-!|
 O.......Recursively open the selected directory..................|NERDTree-O|
 x.......Close the current nodes parent...........................|NERDTree-x|
 X.......Recursively close all children of the current node.......|NERDTree-X|
-e.......Open a netrw for the current dir.........................|NERDTree-e|
+e.......Edit the current dif.....................................|NERDTree-e|
 
 double-click.......same as the |NERDTree-o| map.
-middle-click.......same as |NERDTree-tab| for files, same as
+middle-click.......same as |NERDTree-i| for files, same as
                    |NERDTree-e| for dirs.
 
+D.......Delete the current bookmark .............................|NERDTree-D|
+
 P.......Jump to the root node....................................|NERDTree-P|
 p.......Jump to current nodes parent.............................|NERDTree-p|
 K.......Jump up inside directories at the current tree depth.....|NERDTree-K|
@@ -184,9 +230,10 @@ R.......Recursively refresh the current root.....................|NERDTree-R|
 m.......Display the filesystem menu..............................|NERDTree-m|
 cd......Change the CWD to the dir of the selected node...........|NERDTree-cd|
 
-H.......Toggle whether hidden files displayed....................|NERDTree-H|
+I.......Toggle whether hidden files displayed....................|NERDTree-I|
 f.......Toggle whether the file filters are used.................|NERDTree-f|
 F.......Toggle whether files are displayed.......................|NERDTree-F|
+B.......Toggle whether the bookmark table is displayed...........|NERDTree-B|
 
 q.......Close the NERDTree window................................|NERDTree-q|
 ?.......Toggle the display of the quick help.....................|NERDTree-?|
@@ -197,8 +244,16 @@ Default key: o
 Map option: NERDTreeMapActivateNode
 Applies to: files and directories.
 
-If a file node is selected, it is opened in the previous window. If a
-directory is selected it is opened or closed depending on its current state.
+If a file node is selected, it is opened in the previous window.
+
+If a directory is selected it is opened or closed depending on its current
+state.
+
+If a bookmark that links to a directory is selected then that directory
+becomes the new root.
+
+If a bookmark that links to a file is selected then that file is opened in the
+previous window.
 
 ------------------------------------------------------------------------------
                                                                  *NERDTree-go*
@@ -218,8 +273,12 @@ Default key: t
 Map option: NERDTreeMapOpenInTab
 Applies to: files and directories.
 
-Opens the selected file in a new tab. If a directory is selected, a netrw is
-opened in a new tab.
+Opens the selected file in a new tab. If a directory is selected, a fresh
+NERD Tree for that directory is opened in a new tab.
+
+If a bookmark which points to a directory is selected, open a NERD tree for
+that directory in a new tab. If the bookmark points to a file, open that file
+in a new tab.
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-T*
@@ -230,8 +289,8 @@ Applies to: files and directories.
 The same as |NERDTree-t| except that the focus is kept in the current tab.
 
 ------------------------------------------------------------------------------
-                                                                *NERDTree-tab*
-Default key: <tab>
+                                                                  *NERDTree-i*
+Default key: i
 Map option: NERDTreeMapOpenSplit
 Applies to: files.
 
@@ -239,15 +298,15 @@ Opens the selected file in a new split window and puts the cursor in the new
 window.
 
 ------------------------------------------------------------------------------
-                                                               *NERDTree-gtab*
-Default key: g<tab>
+                                                                 *NERDTree-gi*
+Default key: gi
 Map option: None
 Applies to: files.
 
-The same as |NERDTree-tab| except that the cursor is not moved.
+The same as |NERDTree-i| except that the cursor is not moved.
 
 The key combo for this mapping is always "g" + NERDTreeMapOpenSplit (see
-|NERDTree-tab|).
+|NERDTree-i|).
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-!*
@@ -266,8 +325,8 @@ Applies to: directories.
 Recursively opens the selelected directory.
 
 All files and directories are cached, but if a directory would not be
-displayed due to file filters (see |NERDTreeIgnore| |NERDTree-f|) or the
-hidden file filter (see |NERDTreeShowHidden|) then its contents are not
+displayed due to file filters (see |'NERDTreeIgnore'| |NERDTree-f|) or the
+hidden file filter (see |'NERDTreeShowHidden'|) then its contents are not
 cached. This is handy, especially if you have .svn directories.
 
 ------------------------------------------------------------------------------
@@ -294,7 +353,17 @@ Default key: e
 Map option: NERDTreeMapOpenExpl
 Applies to: files and directories.
 
-Opens a netrw on the selected directory, or the selected file's directory.
+|:edit|s the selected directory, or the selected file's directory. This could
+result in a NERD tree or a netrw being opened, depending on
+|'NERDTreeHijackNetrw'|.
+
+------------------------------------------------------------------------------
+                                                                  *NERDTree-D*
+Default key: D
+Map option: NERDTreeMapDeleteBookmark
+Applies to: lines in the bookmarks table
+
+Deletes the currently selected bookmark.
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-P*
@@ -407,13 +476,12 @@ Applies to: files and directories.
 Display the filesystem menu. See |NERDTreeFilesysMenu| for details.
 
 ------------------------------------------------------------------------------
-                                                                  *NERDTree-H*
-Default key: H
+                                                                  *NERDTree-I*
+Default key: I
 Map option: NERDTreeMapToggleHidden
 Applies to: no restrictions.
 
-Toggles whether hidden files are displayed. Hidden files are any
-file/directory that starts with a "."
+Toggles whether hidden files (i.e. "dot files") are displayed.
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-f*
@@ -421,7 +489,7 @@ Default key: f
 Map option: NERDTreeMapToggleFilters
 Applies to: no restrictions.
 
-Toggles whether file filters are used. See |NERDTreeIgnore| for details.
+Toggles whether file filters are used. See |'NERDTreeIgnore'| for details.
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-F*
@@ -431,6 +499,14 @@ Applies to: no restrictions.
 
 Toggles whether file nodes are displayed.
 
+------------------------------------------------------------------------------
+                                                                  *NERDTree-B*
+Default key: B
+Map option: NERDTreeMapToggleBookmarks
+Applies to: no restrictions.
+
+Toggles whether the bookmarks table is displayed.
+
 ------------------------------------------------------------------------------
                                                                   *NERDTree-q*
 Default key: q
@@ -497,53 +573,56 @@ then id be grateful if you'd email me.
 The script provides the following options that can customise the behaviour the
 NERD tree. These options should be set in your vimrc.
 
-|loaded_nerd_tree|              Turns off the script.
+|'loaded_nerd_tree'|            Turns off the script.
 
-|NERDChristmasTree|             Tells the NERD tree to make itself colourful
+|'NERDChristmasTree'|           Tells the NERD tree to make itself colourful
                                 and pretty.
 
-|NERDTreeAutoCenter|            Controls whether the NERD tree window centers
+|'NERDTreeAutoCenter'|          Controls whether the NERD tree window centers
                                 when the cursor moves within a specified
                                 distance to the top/bottom of the window.
-|NERDTreeAutoCenterThreshold|   Controls the sensitivity of autocentering.
+|'NERDTreeAutoCenterThreshold'| Controls the sensitivity of autocentering.
 
-|NERDTreeCaseSensitiveSort|     Tells the NERD tree whether to be case
+|'NERDTreeCaseSensitiveSort'|   Tells the NERD tree whether to be case
                                 sensitive or not when sorting nodes.
 
-|NERDTreeChDirMode|             Tells the NERD tree if/when it should change
+|'NERDTreeChDirMode'|           Tells the NERD tree if/when it should change
                                 vim's current working directory.
 
-|NERDTreeHighlightCursorline|   Tell the NERD tree whether to highlight the
+|'NERDTreeHighlightCursorline'| Tell the NERD tree whether to highlight the
                                 current cursor line.
 
-|NERDTreeIgnore|                Tells the NERD tree which files to ignore.
+|'NERDTreeHijackNetrw'|         Tell the NERD tree whether to replace the netrw
+                                autocommands for exploring local directories.
 
-|NERDTreeBookmarksFile|         Where the bookmarks are stored.
+|'NERDTreeIgnore'|              Tells the NERD tree which files to ignore.
 
-|NERDTreeMouseMode|             Tells the NERD tree how to handle mouse
+|'NERDTreeBookmarksFile'|       Where the bookmarks are stored.
+
+|'NERDTreeMouseMode'|           Tells the NERD tree how to handle mouse
                                 clicks.
 
-|NERDTreeShowFiles|             Tells the NERD tree whether to display files
+|'NERDTreeQuitOnOpen'|          Closes the tree window after opening a file.
+
+|'NERDTreeShowBookmarks'|       Tells the NERD tree whether to display the
+                                bookmarks table on startup.
+
+|'NERDTreeShowFiles'|           Tells the NERD tree whether to display files
                                 in the tree on startup.
 
-|NERDTreeShowHidden|            Tells the NERD tree whether to display hidden
+|'NERDTreeShowHidden'|          Tells the NERD tree whether to display hidden
                                 files on startup.
 
-|NERDTreeShowLineNumbers|       Tells the NERD tree whether to display line
+|'NERDTreeShowLineNumbers'|     Tells the NERD tree whether to display line
                                 numbers in the tree window.
 
-|NERDTreeSortOrder|             Tell the NERD tree how to sort the nodes in
+|'NERDTreeSortOrder'|           Tell the NERD tree how to sort the nodes in
                                 the tree.
 
-|NERDTreeSplitVertical|         Tells the script whether the NERD tree should
-                                be created by splitting the window vertically
-                                or horizontally.
-
-|NERDTreeWinPos|                Tells the script where to put the NERD tree
+|'NERDTreeWinPos'|              Tells the script where to put the NERD tree
                                 window.
 
-
-|NERDTreeWinSize|               Sets the window size when the NERD tree is
+|'NERDTreeWinSize'|             Sets the window size when the NERD tree is
                                 opened.
 
 ------------------------------------------------------------------------------
@@ -552,13 +631,13 @@ NERD tree. These options should be set in your vimrc.
 To enable any of the below options you should put the given line in your
 ~/.vimrc
 
-                                                            *loaded_nerd_tree*
+                                                          *'loaded_nerd_tree'*
 If this plugin is making you feel homicidal, it may be a good idea to turn it
 off with this line in your vimrc: >
     let loaded_nerd_tree=1
 <
 ------------------------------------------------------------------------------
-                                                           *NERDChristmasTree*
+                                                         *'NERDChristmasTree'*
 Values: 0 or 1.
 Default: 1.
 
@@ -568,12 +647,12 @@ added to the nerd tree to make it more colourful.
 Set it to 0 for a more vanilla looking tree.
 
 ------------------------------------------------------------------------------
-                                                          *NERDTreeAutoCenter*
+                                                        *'NERDTreeAutoCenter'*
 Values: 0 or 1.
 Default: 1
 
 If set to 1, the NERD tree window will center around the cursor if it moves to
-within |NERDTreeAutoCenterThreshold| lines of the top/bottom of the window.
+within |'NERDTreeAutoCenterThreshold'| lines of the top/bottom of the window.
 
 This is ONLY done in response to tree navigation mappings,
 i.e. |NERDTree-J| |NERDTree-K| |NERDTree-C-J| |NERDTree-c-K| |NERDTree-p|
@@ -582,15 +661,15 @@ i.e. |NERDTree-J| |NERDTree-K| |NERDTree-C-J| |NERDTree-c-K| |NERDTree-p|
 The centering is done with a |zz| operation.
 
 ------------------------------------------------------------------------------
-                                                 *NERDTreeAutoCenterThreshold*
+                                               *'NERDTreeAutoCenterThreshold'*
 Values: Any natural number.
 Default: 3
 
 This option controls the "sensitivity" of the NERD tree auto centering. See
-|NERDTreeAutoCenter| for details.
+|'NERDTreeAutoCenter'| for details.
 
 ------------------------------------------------------------------------------
-                                                   *NERDTreeCaseSensitiveSort*
+                                                 *'NERDTreeCaseSensitiveSort'*
 Values: 0 or 1.
 Default: 0.
 
@@ -611,10 +690,10 @@ account. The above nodes would then be sorted like this: >
     boner.c
 <
 ------------------------------------------------------------------------------
-                                                           *NERDTreeChDirMode*
+                                                         *'NERDTreeChDirMode'*
 
 Values: 0, 1 or 2.
-Default: 1.
+Default: 0.
 
 Use this option to tell the script when (if at all) to change the current
 working directory (CWD) for vim.
@@ -633,13 +712,8 @@ the CWD is changed whenever the tree root is changed. For example, if the CWD
 is /home/marty/foobar and you make the node for /home/marty/foobar/baz the new
 root then the CWD will become /home/marty/foobar/baz.
 
-Authors note: at work i have this option set to 1 because i have a giant ctags
-file in the root dir of my project. This way i can initialise the NERD tree
-with the root dir of my project and always have ctags available to me --- no
-matter where i go with the NERD tree.
-
 ------------------------------------------------------------------------------
-                                                 *NERDTreeHighlightCursorline*
+                                               *'NERDTreeHighlightCursorline'*
 Values: 0 or 1.
 Default: 1.
 
@@ -647,13 +721,30 @@ If set to 1, the current cursor line in the NERD tree buffer will be
 highlighted. This is done using the |cursorline| option.
 
 ------------------------------------------------------------------------------
-                                                              *NERDTreeIgnore*
+                                                       *'NERDTreeHijackNetrw'*
+Values: 0 or 1.
+Default: 1.
+
+If set to 1, doing a >
+    :edit <some directory>
+<
+will open up a "secondary" NERD tree instead of a netrw in the target window.
+
+Secondary NERD trees behaves slighly different from a regular trees in the
+following respects:
+    1. 'o' will open the selected file in the same window as the tree,
+       replacing it.
+    2. you can have as many secondary tree as you want in the same tab.
+
+------------------------------------------------------------------------------
+                                                            *'NERDTreeIgnore'*
 Values: a list of regular expressions.
 Default: ['\~$'].
 
 This option is used to specify which files the NERD tree should ignore.  It
 must be a list of regular expressions. When the NERD tree is rendered, any
-files/dirs that match any of the regex's in NERDTreeIgnore wont be displayed.
+files/dirs that match any of the regex's in 'NERDTreeIgnore' wont be
+displayed.
 
 For example if you put the following line in your vimrc: >
     let NERDTreeIgnore=['\.vim$', '\~$']
@@ -669,14 +760,14 @@ The file filters can be turned on and off dynamically with the |NERDTree-f|
 mapping.
 
 ------------------------------------------------------------------------------
-                                                       *NERDTreeBookmarksFile*
+                                                     *'NERDTreeBookmarksFile'*
 Values: a path
 Default: $HOME/.NERDTreeBookmarks
 
 This is where bookmarks are saved. See |NERDTreeBookmarkCommands|.
 
 ------------------------------------------------------------------------------
-                                                           *NERDTreeMouseMode*
+                                                       *'NERDTreeMouseMode'*
 Values: 1, 2 or 3.
 Default: 1.
 
@@ -694,31 +785,50 @@ then (to single click activate it) you must click somewhere in
 'application.rb'.
 
 ------------------------------------------------------------------------------
-                                                           *NERDTreeShowFiles*
+                                                        *'NERDTreeQuitOnOpen'*
+
+Values: 0 or 1.
+Default: 0
+
+If set to 1, the NERD tree window will close after opening a file with the
+|NERDTree-o| or |NERDTree-i| mappings.
+
+------------------------------------------------------------------------------
+                                                     *'NERDTreeShowBookmarks'*
+Values: 0 or 1.
+Default: 0.
+
+If this option is set to 1 then the bookmarks table will be displayed.
+
+This option can be toggled dynamically, per tree, with the |NERDTree-B|
+mapping.
+
+------------------------------------------------------------------------------
+                                                         *'NERDTreeShowFiles'*
 Values: 0 or 1.
 Default: 1.
 
 If this option is set to 1 then files are displayed in the NERD tree. If it is
 set to 0 then only directories are displayed.
 
-This option can be toggled dynamically with the |NERDTree-F| mapping and is
-useful for drastically shrinking the tree when you are navigating to a
-different part of the tree.
+This option can be toggled dynamically, per tree, with the |NERDTree-F|
+mapping and is useful for drastically shrinking the tree when you are
+navigating to a different part of the tree.
 
 ------------------------------------------------------------------------------
-                                                          *NERDTreeShowHidden*
+                                                        *'NERDTreeShowHidden'*
 Values: 0 or 1.
 Default: 0.
 
 This option tells vim whether to display hidden files by default. This option
-can be dynamically toggled with the |NERDTree-H| mapping.
-Use one of the follow lines to set this option: >
+can be dynamically toggled, per tree, with the |NERDTree-I| mapping.  Use one
+of the follow lines to set this option: >
     let NERDTreeShowHidden=0
     let NERDTreeShowHidden=1
 <
 
 ------------------------------------------------------------------------------
-                                                     *NERDTreeShowLineNumbers*
+                                                   *'NERDTreeShowLineNumbers'*
 Values: 0 or 1.
 Default: 0.
 
@@ -729,7 +839,7 @@ window.  Use one of the follow lines to set this option: >
 <
 
 ------------------------------------------------------------------------------
-                                                           *NERDTreeSortOrder*
+                                                         *'NERDTreeSortOrder'*
 Values: a list of regular expressions.
 Default: ['\/$', '*', '\.swp$',  '\.bak$', '\~$']
 
@@ -744,8 +854,8 @@ all .h files. All files containing the string 'foobar' will be placed at the
 end.  The star is a special flag: it tells the script that every node that
 doesnt match any of the other regexps should be placed here.
 
-If no star is present in NERDTreeSortOrder then one is automatically appended
-to the array.
+If no star is present in 'NERDTreeSortOrder' then one is automatically
+appended to the array.
 
 The regex '\/$' should be used to match directory nodes.
 
@@ -762,44 +872,28 @@ Other examples: >
    backup files will appear last with everything else preceding them.
 
 ------------------------------------------------------------------------------
-                                                       *NERDTreeSplitVertical*
-Values: 0 or 1.
-Default: 1.
+                                                            *'NERDTreeWinPos'*
+Values: "left" or "right"
+Default: "left".
 
-This option, along with |NERDTreeWinPos|, is used to determine where the NERD
-tree window appears.
-
-If it is set to 1 then the NERD tree window will appear on either the left or
-right side of the screen (depending on the |NERDTreeWinPos| option).
-
-If it set to 0 then the NERD tree window will appear at the top of the screen.
-
-------------------------------------------------------------------------------
-                                                              *NERDTreeWinPos*
-Values: 0 or 1.
-Default: 1.
-
-This option works in conjunction with the |NERDTreeSplitVertical| option to
-determine where NERD tree window is placed on the screen.
-
-If the option is set to 1 then the NERD tree will appear on the left or top of
-the screen (depending on the value of |NERDTreeSplitVertical|). If set to 0,
-the window will appear on the right or bottom of the screen.
+This option is used to determine where NERD tree window is placed on the
+screen.
 
 This option is makes it possible to use two different explorer type
 plugins simultaneously. For example, you could have the taglist plugin on the
 left of the window and the NERD tree on the right.
 
 ------------------------------------------------------------------------------
-                                                             *NERDTreeWinSize*
+                                                           *'NERDTreeWinSize'*
 Values: a positive integer.
 Default: 31.
 
 This option is used to change the size of the NERD tree when it is loaded.
 
 ==============================================================================
-                                                     *NERDTreePublicFunctions*
-5. Public functions      ~
+4. Hacking the NERD tree                                     *NERDTreeHacking*
+
+Public functions ~
 
 The script provides 2 public functions for your hacking pleasure. Their
 signatures are: >
@@ -814,16 +908,29 @@ style OO. To see the functions that each class provides you can read look at
 the code.
 
 Use the node objects to manipulate the structure of the tree. Use the path
-objects to access the data the tree represents and to make changes to the
-filesystem.
+objects to access the files/directories the tree nodes represent.
+
+The NERD tree filetype ~
+
+NERD tree buffers have a filetype of "nerdtree". You can use this to hack the
+NERD tree via autocommands (on |FileType|) or via an ftplugin.
+
+For example, putting this code in ~/.vim/ftplugin/nerdtree.vim would override
+the o mapping, making it open the selected node in a new gvim instance. >
+
+    nnoremap <silent> <buffer> o :call <sid>openInNewVimInstance()<cr>
+    function! s:openInNewVimInstance()
+        let p = NERDTreeGetCurrentPath()
+        if p != {}
+            silent exec "!gvim " . p.strForOS(1) . "&"
+        endif
+    endfunction
+<
+This way you can add new mappings or :commands or override any existing
+mapping.
 
 ==============================================================================
-5. TODO list                                                    *NERDTreeTodo*
-
-Window manager integration?
-
-==============================================================================
-6. The Author                                                 *NERDTreeAuthor*
+5. About                                                       *NERDTreeAbout*
 
 The author of the NERD tree is a terrible terrible monster called Martyzilla
 who gobbles up small children with milk and sugar for breakfast.
@@ -833,275 +940,79 @@ you, so feel free to send him suggestions and/or comments about this plugin.
 Don't be shy --- the worst he can do is slaughter you and stuff you in the
 fridge for later ;)
 
-==============================================================================
-7. Changelog                                               *NERDTreeChangelog*
+The latest stable versions can be found at
+    http://www.vim.org/scripts/script.php?script_id=1658
 
-2.11.0
-    - changes to the 'o' mapping when opening files:
-      - dont clobber "special" windows (eg taglist/quickfix/etc). This should
-        make the NERD tree play nicer with other explorer plugins. Thanks to
-        Yuan Jiang for the suggestion.
-      - if the file is already open in the current tab, just move the cursor
-        to that window
-    - highlight executable files, made some slight changes to other
-      highlighting
-    - if the user resizes the tree window, keep that new size. Dont reset to
-      the default during the <tab> mapping, or :NERDTreeToggle command. Only
-      reset the size if a fresh tree is started with :NERDTree.
-    - remove the "magic" functionality from the <c-j>/<c-k> mappings (it was
-      more confusing than helpful)
-    - other minor fixes
-
-2.10.0
-    - added bookmarks, see :help NERDTreeBookmarkCommands for details. Thanks
-      to Piotr Czachur for all his testing and suggestions.
-    - fixed screen jumping bug with when &scrolloff != 0
-    - fixed some bugs with copying nodes
-    - other random fixes
-    - change license to wtfpl
-
-2.9.0
-
-    - path handling improvements, thanks to Zhang Shuhan for heaps of
-      testing/bug reports
-        * improved how paths are stored, now the script will no longer get
-          confused about drives on MF Windows
-        * made the script way better at handling paths with strange characters
-          in them (eg '$@; etc)
-    - applied a patch from Cory Echols
-        * add the command :NERDTreeClose to close the tree for the current tab
-        * set the filetype for the NERD tree buffer to "nerdtree"
-
-2.8.0
-    - added an option to enable/disable line numbers in the NERD tree window,
-      thanks to Olivier Yiptong for the email.
-
-2.7.1
-    - Changed the keys for the filesystem menu to be mnemonic rather than
-      arbitrary integers
-    - Documented the copying functionality in the filesystem menu
-
-2.7.0
-    - Bug fix: Now when you have the tree on the right and you open it with
-      multiple windows stacked, it will take up the full height of the vim
-      window.
-    - Now line numbers always turned off in the tree by default
-    - Implemented copying of nodes (via the filesystem menu) for *nix/macosx
-    - took the help doc out of the script and repackaged the whole thing as a
-      zip
-
-2.6.2
-    - Now when you try to open a file node into a window that is modified, the
-      window is not split if the &hidden option is set. Thanks to  Niels Aan
-      de Brugh for this suggestion.
-
-2.6.1
-    - Fixed a major bug with the <tab> mapping. Thanks to Zhang Weiwu for
-      emailing me.
-
-2.6.0
-    - Extended the behaviour of <c-j/k>. Now if the cursor is on a file node
-      and you use <c-j/k> the cursor will jump to its PARENTS next/previous
-      sibling. Go :help NERDTree-c-j and :help NERDTree-c-k for info.
-    - Extended the behaviour of the J/K mappings. Now if the cursor is on the
-      last child of a node and you push J/K it will jump down to the last child
-      of the next/prev of its parents siblings that is open and has children.
-      Go :help NERDTree-J and :help NERDTree-K for info.
-    - The goal of these changes is to make tree navigation faster.
-    - Reorganised the help page a bit.
-    - Removed the E mapping.
-    - bugfixes
-
-2.5.0
-    - Added an option to enforce case sensitivity when sorting tree nodes.
-      Read :help NERDTreeCaseSensitiveSort for details.  (thanks to Michael
-      Madsen for emailing me about this). Case sensitivity defaults to off.
-    - Made the script echo a "please wait" style message when opening large
-      directories. Thanks to AOYAMA Shotaro for this suggestion.
-    - Added 2 public functions that can be used to retrieve the treenode and
-      path that the cursor is on. Read :help NERDTreePublicFunctions for
-      details (thanks again to AOYAMA Shotaro for the idea :).
-    - added 2 new mappings for file nodes: "g<tab>" and "go". These are the
-      same as the "<tab>" and "o" maps except that the cursor stays in the
-      NERDTree. Note: these maps are slaved to the o and <tab> mappings, so if
-      eg you remap "<tab>" to "i" then the "g<tab>" map will also be changed
-      to "gi".
-    - Renamed many of the help tags to be simpler.
-    - Simplified the ascii "graphics" for the filesystem menu
-    - Fixed bugs.
-    - Probably created bugs.
-    - Refactoring.
-
-2.4.0
-    - Added the P mapping to jump to the tree root.
-    - Added window centering functionality that can be triggered when doing
-      using any of the tree nav mappings. Essentially, if the cursor comes
-      within a certain distance of the top/bottom of the window then a zz is
-      done in the window. Two related options were added: NERDTreeAutoCenter
-      to turn this functionality on/off, and NERDTreeAutoCenterThreshold to
-      control how close the cursor has to be to the window edge to trigger the
-      centering.
-
-2.3.0
-    - Tree navigation changes:
-      - Added J and K mappings to jump to last/first child of the current dir.
-        Options to customise these mappings have also been added.
-      - Remapped the jump to next/prev sibling commands to be <C-j> and <C-k> by
-        default.
-      These changes should hopefully make tree navigation mappings easier to
-      remember and use as the j and k keys are simply reused 3 times (twice
-      with modifier keys).
-
-    - Made it so that, when any of the tree filters are toggled, the cursor
-      stays with the selected node (or goes to its parent/grandparent/... if
-      that node is no longer visible)
-    - Fixed an error in the doc for the mouse mode option.
-    - Made the quickhelp correctly display the current single/double click
-      mappings for opening nodes as specified by the NERDTreeMouseMode option.
-    - Fixed a bug where the script was spazzing after prompting you to delete
-      a modified buffer when using the filesystem menu.
-    - Refactoring
-2.2.3
-    - Refactored the :echo output from the script.
-    - Fixed some minor typos in the doc.
-    - Made some minor changes to the output of the 'Tree filtering mappings'
-      part of the quickhelp
-
-2.2.2
-    - More bugfixes... doh.
-
-2.2.1
-    - Bug fix that was causing an exception when closing the nerd tree. Thanks
-      to Tim carey-smith and Yu Jun for pointing this out.
-
-2.2.0
-    - Now 'cursorline' is set in the NERD tree buffer by default. See :help
-      NERDTreeHighlightCursorline for how to disable it.
-
-2.1.2
-    - Stopped the script from clobbering the 1,2,3 .. 9 registers.
-    - Made it "silent!"ly delete buffers when renaming/deleting file nodes.
-    - Minor correction to the doc
-    - Fixed a bug when refreshing that was occurring when the node you
-      refreshed had been deleted externally.
-    - Fixed a bug that was occurring when you open a file that is already open
-      and modified.
-
-2.1.1
-    - Added a bit more info about the buffers you are prompted to delete when
-      renaming/deleting nodes from the filesystem menu that are already loaded
-      into buffers.
-    - Refactoring and bugfixes
-
-2.1.0
-    - Finally removed the blank line that always appears at the top of the
-      NERDTree buffer
-    - Added NERDTreeMouseMode option. If set to 1, then a double click is
-      required to activate all nodes, if set to 2 then a single click will
-      activate directory nodes, if set to 3 then a single click will activate
-      all nodes.
-    - Now if you delete a file node and have it open in a buffer you are given
-      the option to delete that buffer as well. Similarly if you rename a file
-      you are given the option to delete any buffers containing the old file
-      (if any exist)
-    - When you rename or create a node, the cursor is now put on the new node,
-      this makes it easy immediately edit  the new file.
-    - Fixed a bug with the ! mapping that was occurring on windows with paths
-      containing spaces.
-    - Made all the mappings customisable. See |NERD_tree-mappings| for
-      details. A side effect is that a lot of the "double mappings" have
-      disappeared. E.g 'o' is now the key that is used to activate a node,
-      <CR> is no longer mapped to the same.
-    - Made the script echo warnings in some places rather than standard echos
-    - Insane amounts of refactoring all over the place.
-
-2.0.0
-    - Added two new NERDChristmasTree decorations. First person to spot them
-      and email me gets a free copy of the NERDTree.
-    - Made it so that when you jump around the tree (with the p, s and S
-      mappings) it is counted as a jump by vim. This means if you, eg, push
-      'p' one too many times then you can go `` or ctrl-o.
-    - Added a new option called NERDTreeSortOrder which takes an array of
-      regexs and is used to determine the order that the treenodes are listed
-      in. Go :help NERDTreeSortOrder for details.
-    - Removed the NERDTreeSortDirs option because it is consumed by
-      NERDTreeSortOrder
-    - Added the 'i' mapping which is the same as <tab> but requires less
-      effort to reach.
-    - Added the ! mapping which is  used to execute file in the tree (after it
-      prompts you for arguments etc)
+The latest dev versions are on github
+    http://github.com/scrooloose/nerdtree
 
 
 ==============================================================================
-8. Credits                                                   *NERDTreeCredits*
+6. Changelog                                               *NERDTreeChangelog*
 
-Thanks to Tim Carey-Smith for testing/using the NERD tree from the first
-pre-beta version, for his many suggestions and for his constant stream of bug
-complaints.
+3.0.1
+    Bugfixes:
+    - fix bugs with :NERDTreeToggle and :NERDTreeMirror when 'hidden
+      was not set
+    - fix a bug where :NERDTree <path> would fail if <path> was relative and
+      didnt start with a ./ or ../  Thanks to James Kanze.
+    - make the q mapping work with secondary (:e <dir>  style) trees,
+      thanks to jamessan
+    - fix a bunch of small bugs with secondary trees
 
-Thanks to Vigil for trying it out before the first release :) and suggesting
-that mappings to open files in new tabs should be implemented.
+    More insane refactoring.
 
-Thanks to Nick Brettell for testing, fixing my spelling and suggesting i put a
-    .. (up a directory)
-line in the gui.
-
-Thanks to Thomas Scott Urban - the author of the vtreeexplorer plugin - whose
-gui code i borrowed from.
-
-Thanks to Terrance Cohen for pointing out a bug where the script was changing
-vims CWD all over the show.
-
-Thanks to Yegappan Lakshmanan (author of Taglist and other orgasmically
-wonderful plugins) for telling me how to fix a bug that was causing vim to go
-into visual mode everytime you double clicked a node :)
-
-Thanks to Jason Mills for sending me a fix that allows windows paths to use
-forward slashes as well as backward.
-
-Thanks to Michael Geddes (frogonwheels on #vim at freenode) for giving me some
-tips about syntax highlighting when i was doing highlighting for the
-quickhelp.
-
-Thanks to Yu Jun for emailing me about a bug that was occurring when closing
-the tree.
-
-Thanks to Michael Madsen for emailing me about making case sensitivity
-optional when sorting nodes.
-
-Thanks to AOYAMA Shotaro for suggesting that i echo a "please wait" message
-when opening large directories.
-
-Thanks to Michael Madsen for requesting the NERDTreeCaseSensitiveSort option.
-
-Thanks to AOYAMA Shotaro for suggesting that a "please wait" style message be
-echoed when opening large directories. Also, thanks for the suggestion of
-having public functions in the script to access the internal data :D
-
-Thanks to Zhang Weiwu for emailing me about a bug with the the <tab> mapping
-in 2.6.0
-
-Thanks to  Niels Aan de Brugh for the suggestion that the script now split the
-window if you try to open a file in a window containing a modified buffer when
-the &hidden option is set.
-
-Thanks to Olivier Yiptong for prompting me to make line numbers in the
-NERD tree window optional.
-
-Thanks to Zhang Shuhan for all of his emails and testing to help improve the
-NERD tree path handling.
-
-Thanks to Cory Echols for sending a patch to add the :NERDTreeClose command and
-set the NERD tree buffers filetype to 'nerdtree'
-
-Thanks to Piotr Czachur for all his suggestions and testing for the bookmarks
-feature.
-
-Thanks to Yuan Jiang for suggesting the "o" mapping shouldnt clobber "special"
-windows, like taglist.
+3.0.0
+    - hijack netrw so that doing an :edit <directory>  will put a NERD tree in
+      the window rather than a netrw browser. See :help 'NERDTreeHijackNetrw'
+    - allow sharing of trees across tabs, see :help :NERDTreeMirror
+    - remove "top" and "bottom" as valid settings for NERDTreeWinPos
+    - change the '<tab>' mapping to 'i'
+    - change the 'H' mapping to 'I'
+    - lots of refactoring
 
 ==============================================================================
-9. License                                                   *NERDTreeLicense*
+7. Credits                                                   *NERDTreeCredits*
+
+Thanks to the following people for testing, bug reports, ideas etc. Without
+you I probably would have got bored of the hacking the NERD tree and
+just downloaded pr0n instead.
+
+    Tim Carey-Smith (halorgium)
+    Vigil
+    Nick Brettell
+    Thomas Scott Urban
+    Terrance Cohen
+    Yegappan Lakshmanan
+    Jason Mills
+    Michael Geddes (frogonwheels)
+    Yu Jun
+    Michael Madsen
+    AOYAMA Shotaro
+    Zhang Weiwu
+    Niels Aan de Brugh
+    Olivier Yiptong
+    Zhang Shuhan
+    Cory Echols
+    Piotr Czachur
+    Yuan Jiang
+    Matan Nassau
+    Maxim Kim
+    Charlton Wang
+    Matt Wozniski (godlygeek)
+    knekk
+    Sean Chou
+    Ryan Penn
+    Simon Peter Nicholls
+    Michael Foobar
+    Tomasz Chomiuk
+    Denis Pokataev
+    Tim Pope (tpope)
+    James Kanze
+    James Vega (jamessan)
+
+==============================================================================
+8. License                                                   *NERDTreeLicense*
 
 The NERD tree is released under the wtfpl.
 See http://sam.zoy.org/wtfpl/COPYING.