vim/nerdtree
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update the documentation

Browse Source 
The docs for ":NERDTreeFind" are updated.  Some additional
formatting changes are made to other sections.
This commit is contained in:
Jason Franklin 2017-12-22 09:15:07 -05:00
parent 01b011d38e
commit f6dad4796e
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/NERDTree.txt
View File

@ -126,20 +126,20 @@ The following features and functionality are provided by the NERD tree:
Changes made to one tree are reflected in both as they are actually the Changes made to one tree are reflected in both as they are actually the
same buffer. same buffer.
If only one other NERD tree exists, that tree is automatically mirrored. If If only one other NERD tree exists, that tree is automatically mirrored.
more than one exists, the script will ask which tree to mirror. If more than one exists, the script will ask which tree to mirror.
:NERDTreeClose *:NERDTreeClose* :NERDTreeClose *:NERDTreeClose*
Close the NERD tree in this tab. Close the NERD tree in this tab.
:NERDTreeFind *:NERDTreeFind* :NERDTreeFind [<path>] *:NERDTreeFind*
Find the current file in the tree. Without the optional argument, find and reveal the file for the active
buffer in the NERDTree window. With the <path> argument, find and
reveal the specified path.
If no tree exists and the current file is under vim's CWD, then init a Focus will be shifted to the NERDTree window, and the cursor will be
tree at the CWD and reveal the file. Otherwise init a tree in the current placed on the tree node for the determined path. If a NERDTree for the
file's directory. current tab does not exist, a new one will be initialized.
In any case, the current file is revealed and the cursor is placed on it.
:NERDTreeCWD *:NERDTreeCWD* :NERDTreeCWD *:NERDTreeCWD*
Change tree root to current directory. If no NERD tree exists for this Change tree root to current directory. If no NERD tree exists for this
@ -1128,13 +1128,12 @@ NERDTreeAddKeyMap({options}) *NERDTreeAddKeyMap()*
Additionally, a "scope" argument may be supplied. This constrains the Additionally, a "scope" argument may be supplied. This constrains the
mapping so that it is only activated if the cursor is on a certain object. mapping so that it is only activated if the cursor is on a certain object.
That object is then passed into the handling method. Possible values are: That object is then passed into the handling method. Possible values are:
"FileNode" - a file node
"DirNode" - a directory node
"Node" - a file or directory node
"Bookmark" - A bookmark
"all" - the keymap is not constrained to any scope (default). When
thei is used, the handling function is not passed any arguments.
"FileNode" .... a file node
"DirNode" ..... a directory node
"Node" ........ a file node OR a directory node
"Bookmark" .... a bookmark
"all" ......... global scope; handler receives no arguments (default)
Example: > Example: >
call NERDTreeAddKeyMap({ call NERDTreeAddKeyMap({