hasufell/neosnippet.vim
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #130 from crazymaster/master

Browse Source 
Updated doc.
This commit is contained in:
Shougo 2013-04-05 19:14:37 -07:00
commit 8126b9c3f5
2 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -6,14 +6,14 @@ small templates for commonly used code that you can fill in on the
fly. To use snippets can increase your productivity in Vim a lot. fly. To use snippets can increase your productivity in Vim a lot.
The functionality of this plug-in is quite similar to plug-ins like The functionality of this plug-in is quite similar to plug-ins like
snipMate.vim or snippetsEmu.vim. But since you can choose snippets with the snipMate.vim or snippetsEmu.vim. But since you can choose snippets with the
[Neocomplecache](https://github.com/Shougo/neocomplcache) interface, you might [Neocomplcache](https://github.com/Shougo/neocomplcache) interface, you might
have less trouble using them, because you do not have to remember each snippet have less trouble using them, because you do not have to remember each snippet
name. name.
Note: neocomplecache is NOT required! But recommended. Note: neocomplcache is NOT required! But recommended.
Extra snippets files are available in: Extra snippets files are available in:
[snipmate-snippets](https://github.com/honza/snipmate-snippets) [vim-snippets](https://github.com/honza/vim-snippets)
Installation Installation
------------ ------------
@ -24,14 +24,14 @@ required files into your `.vim` folder.
### Manual (not recommended) ### Manual (not recommended)
1. Install the [Neocomplecache](https://github.com/Shougo/neocomplcache) plugin first. 1. Install the [Neocomplcache](https://github.com/Shougo/neocomplcache) plugin first.
2. Put files in your Vim directory (usually `~/.vim/` or 2. Put files in your Vim directory (usually `~/.vim/` or
`%PROGRAMFILES%/Vim/vimfiles` on Windows). `%PROGRAMFILES%/Vim/vimfiles` on Windows).
### Vundle ### Vundle
1. Setup the [vundle](https://github.com/gmarik/vundle) package manager 1. Setup the [vundle](https://github.com/gmarik/vundle) package manager
2. Set the bundles for [Neocomplecache](https://github.com/Shougo/neocomplcache) and [Neosnippet](https://github.com/Shougo/neosnippet) 2. Set the bundles for [Neocomplcache](https://github.com/Shougo/neocomplcache) and [Neosnippet](https://github.com/Shougo/neosnippet)
``` ```
Bundle 'Shougo/neocomplcache.git' Bundle 'Shougo/neocomplcache.git'
@ -43,7 +43,7 @@ required files into your `.vim` folder.
### Neobundle ### Neobundle
1. Setup the [neobundle](https://github.com/Shougo/neobundle.vim) package manager 1. Setup the [neobundle](https://github.com/Shougo/neobundle.vim) package manager
2. Set the bundles for [Neocomplecache](https://github.com/Shougo/neocomplcache) and [Neosnippet](https://github.com/Shougo/neosnippet) 2. Set the bundles for [Neocomplcache](https://github.com/Shougo/neocomplcache) and [Neosnippet](https://github.com/Shougo/neosnippet)
``` ```
NeoBundle 'Shougo/neocomplcache.git' NeoBundle 'Shougo/neocomplcache.git'
@ -68,10 +68,10 @@ Configuration
------------- -------------
This is an example `~/.vimrc` configuration for Neosnippet. It is assumes you This is an example `~/.vimrc` configuration for Neosnippet. It is assumes you
already have Neocomplecache configured. With the settings of the example, you already have Neocomplcache configured. With the settings of the example, you
can use the following keys: can use the following keys:
* `C-k` to select-and-expand a snippet from the Neocomplecache popup (Use `C-n` * `C-k` to select-and-expand a snippet from the Neocomplcache popup (Use `C-n`
and `C-p` to select it). `C-k` can also be used to jump to the next field in and `C-p` to select it). `C-k` can also be used to jump to the next field in
the snippet. the snippet.
* `Tab` to select the next field to fill in the snippet. * `Tab` to select the next field to fill in the snippet.
@ -95,10 +95,10 @@ endif
If you want to use a different collection of snippets than the If you want to use a different collection of snippets than the
built-in ones, then you can set a path to the snippets with built-in ones, then you can set a path to the snippets with
the `g:neosnippet#snippets_directory` variable (e.g [Honza's the `g:neosnippet#snippets_directory` variable (e.g [Honza's
Snippets](https://github.com/honza/snipmate-snippets)) Snippets](https://github.com/honza/vim-snippets))
```vim ```vim
" Tell Neosnippet about the other snippets " Tell Neosnippet about the other snippets
let g:neosnippet#snippets_directory='~/.vim/bundle/snipmate-snippets/snippets' let g:neosnippet#snippets_directory='~/.vim/bundle/vim-snippets/snippets'
``` ```

5
doc/neosnippet.txt
View File

@ -54,10 +54,10 @@ INSTALL *neosnippet-install*
Note: If you want to complete snippets, you must install neocomplcache Note: If you want to complete snippets, you must install neocomplcache
(https://github.com/Shougo/neocomplcache). (https://github.com/Shougo/neocomplcache).
Note: neocomplecache is NOT required! But recommended. Note: neocomplcache is NOT required! But recommended.
Extra snippets files are available in: Extra snippets files are available in:
https://github.com/honza/snipmate-snippets https://github.com/honza/vim-snippets
============================================================================== ==============================================================================
INTERFACE *neosnippet-interface* INTERFACE *neosnippet-interface*
@ -736,6 +736,7 @@ Note: But you must unmap the mappings in select mode manually.
< <
Q: Error using snipmate-snippets Q: Error using snipmate-snippets
Note: snipmate-snippets is currently vim-snippets.
https://github.com/Shougo/neosnippet/issues/86 https://github.com/Shougo/neosnippet/issues/86
A: Please try below settings. It defines snipMate function. A: Please try below settings. It defines snipMate function.