Merge pull request #74 from cpfaff/english_doc

improves the english of the second part of the documentation
This commit is contained in:
Shougo 2012-10-30 02:50:35 -07:00
commit 512c27f72e

View File

@ -62,7 +62,7 @@ COMMANDS *neosnippet-commands*
:NeoSnippetMakeCache [filetype] :NeoSnippetMakeCache [filetype]
*:NeoSnippetMakeCache* *:NeoSnippetMakeCache*
Creates a cache of the [filetype] snippets. It automatically Creates a cache for the [filetype] snippets. It automatically
choses the current buffer's file type unless you specify one by choses the current buffer's file type unless you specify one by
[filetype]. [filetype].
@ -94,7 +94,7 @@ COMMANDS *neosnippet-commands*
-horizontal -horizontal
Split the window horizontally. Split the window horizontally.
The behavior is undefined when both options are set. Note: The behavior is undefined when both options are set.
*neosnippet-edit-options-direction* *neosnippet-edit-options-direction*
-direction={direction} -direction={direction}
@ -129,12 +129,12 @@ g:neosnippet#snippets_directory *g:neosnippet#snippets_directory*
You can set multiple values in comma-separated form. You can set multiple values in comma-separated form.
If the directory doesn't exist, it is ignored. If the directory doesn't exist, it is ignored.
User defined snippets were read after normal snippet files, User defined snippets are read after built-in snippet files,
so redundant snippets will be overwritten. and redundant snippets get overwritten.
Note: Neosnippet loads filetype snippet files. Note: Neosnippet loads the file type snippet files as follows.
If you are editing "vim" filetypes files, neosnippet wll load If you edit "vim" file types files, neosnippet loads
"vim.snip*" and "vim_*.snip*" and "vim/**/*.snip" snippet files. "vim.snip*", "vim_*.snip*" and "vim/**/*.snip" snippet files.
*g:neocomplcache_snippets_dir* *g:neocomplcache_snippets_dir*
Note: |g:neocomplcache_snippets_dir| is an obsolete name. Note: |g:neocomplcache_snippets_dir| is an obsolete name.
@ -143,24 +143,28 @@ g:neosnippet#snippets_directory *g:neosnippet#snippets_directory*
g:neosnippet#disable_select_mode_mappings g:neosnippet#disable_select_mode_mappings
*g:neosnippet#disable_select_mode_mappings* *g:neosnippet#disable_select_mode_mappings*
This variable controls whether to disable Key-mappings in This variable disables key-mappings in |Select-mode| where
|Select-mode| when snippets_complete performs. Usually you snippets_complete performs the snippet completion. Usually it
had better enable it. it better to leave it as it is. But if you have troubles with
the buffer switcher LustyJuggler it helps to disable them.
*g:neocomplcache_disable_select_mode_mappings* *g:neocomplcache_disable_select_mode_mappings*
Note: |g:neocomplcache_disable_select_mode_mappings| is Note: |g:neocomplcache_disable_select_mode_mappings| is an
obsolete name. obsolete name.
Default value is 1. Default value is 1.
g:neosnippet#disable_runtime_snippets g:neosnippet#disable_runtime_snippets
*g:neosnippet#disable_runtime_snippets* *g:neosnippet#disable_runtime_snippets*
This is dictionary variable. The key is filetype. If the This is a dictionary variable which uses the file type as key.
value is 1, all runtime snippets won't be loaded in the To set the value of a file type entry to 1 prevents loading all
specified filetype. built-in snippets for that file type. This is very useful to
If the key is "_", it will be used for default filetype. prevent snippet conflicts between self defined snippet files
This variable is useful to avoid snippets conflictions. and the built-in snippet files of neosnippet. If you use "_" as
Note: It must be set in .vimrc. key for an entry, this will be treated as default for all
file types.
Note: This dictionary must be set in your .vimrc.
For example: For example:
> >
@ -168,17 +172,17 @@ g:neosnippet#disable_runtime_snippets
\ 'c' : 1, 'cpp' : 1, \ 'c' : 1, 'cpp' : 1,
\ } \ }
" Like g:neocomplcache_snippets_disable_runtime_snippets " Works like g:neocomplcache_snippets_disable_runtime_snippets
" behavior(all runtime snippets are disabled). " (Disable all runtime snippets).
let g:neosnippet#disable_runtime_snippets = { let g:neosnippet#disable_runtime_snippets = {
\ '_' : 1, \ '_' : 1,
\ } \ }
< <
*g:neocomplcache_snippets_disable_runtime_snippets* *g:neocomplcache_snippets_disable_runtime_snippets*
Note: |g:neocomplcache_snippets_disable_runtime_snippets| is Note: |g:neocomplcache_snippets_disable_runtime_snippets| is
obsolete name. an obsolete name.
Default value is {}. The default value is {}.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
KEY MAPPINGS *neosnippet-key-mappings* KEY MAPPINGS *neosnippet-key-mappings*