Improves english documentation a bit
This commit is contained in:
parent
a4c2f3d376
commit
549c42d4d3
@ -61,62 +61,65 @@ COMMANDS *neosnippet-commands*
|
|||||||
|
|
||||||
:NeoSnippetMakeCache [filetype]
|
:NeoSnippetMakeCache [filetype]
|
||||||
*:NeoSnippetMakeCache*
|
*:NeoSnippetMakeCache*
|
||||||
Makes cache of [filetype] snippets. It automatically selects
|
|
||||||
current buffer's filetype unless you specify [filetype].
|
Creates a cache of the [filetype] snippets. It automatically
|
||||||
|
choses the current buffer's file type unless you specify one by
|
||||||
|
[filetype].
|
||||||
|
|
||||||
*:NeoComplCacheCachingSnippets*
|
*:NeoComplCacheCachingSnippets*
|
||||||
Note: |:NeoComplCacheCachingSnippets| is obsolete name.
|
Note: |:NeoComplCacheCachingSnippets| is an obsolete name.
|
||||||
|
|
||||||
:NeoSnippetEdit [{options}] [filetype]
|
:NeoSnippetEdit [{options}] [filetype]
|
||||||
*:NeoSnippetEdit*
|
*:NeoSnippetEdit*
|
||||||
Opens [filetype] snippets to edit. It automatically selects
|
Opens the [filetype] snippets to edit. It automatically selects
|
||||||
current buffer's filetype unless you specify [filetype].
|
the current buffer's filetype unless you specify it by [filetype].
|
||||||
|
|
||||||
If [filetype] snippets has a directory, it automatically edit
|
If the path to [filetype] snippets is a directory, it automatically edits
|
||||||
"[filetype].snip" in [filetype] subdirectory.
|
the "[filetype].snip" in the [filetype] subdirectory.
|
||||||
|
|
||||||
It edits a snippet file in |g:neosnippet#snippets_directory|
|
It edits a snippet file in |g:neosnippet#snippets_directory|
|
||||||
with precedence.
|
with precedence. The snippets are re-cached automatically
|
||||||
Re-make cache will be done automatically when you save the
|
when you save the file after edit.
|
||||||
file.
|
|
||||||
|
|
||||||
*:NeoComplCacheEditSnippets*
|
*:NeoComplCacheEditSnippets*
|
||||||
{options} are options for the command. You may give the
|
{options} are options for the command. You may give the
|
||||||
following parameters for a option; you must escape with "\"
|
following parameters as an option. Note: You must escape spaces with a
|
||||||
when it contains spaces.
|
backslash "\".
|
||||||
|
|
||||||
*neosnippet-edit-options-vertical*
|
*neosnippet-edit-options-vertical*
|
||||||
-vertical
|
-vertical
|
||||||
Splits window vertically.
|
Split the window vertically.
|
||||||
|
|
||||||
*neosnippet-edit-options-horizontal*
|
*neosnippet-edit-options-horizontal*
|
||||||
-horizontal
|
-horizontal
|
||||||
Splits window horizontally.
|
Split the window horizontally.
|
||||||
|
|
||||||
The behavior is undefined when both options are defined.
|
The behavior is undefined when both options are set.
|
||||||
|
|
||||||
*neosnippet-edit-options-direction*
|
*neosnippet-edit-options-direction*
|
||||||
-direction={direction}
|
-direction={direction}
|
||||||
Defines split position rule. The default value is "belowleft".
|
Define the split position rule. The default value is "belowleft".
|
||||||
|
|
||||||
*neosnippet-edit-options-split*
|
*neosnippet-edit-options-split*
|
||||||
-split
|
-split
|
||||||
Split buffer.
|
Split the buffer.
|
||||||
|
|
||||||
*neosnippet-edit-options-runtime*
|
*neosnippet-edit-options-runtime*
|
||||||
-runtime
|
-runtime
|
||||||
Edit runtime snippets instead of user snippets.
|
Edit the runtime (built-in standard) snippets instead of the user
|
||||||
|
snippets defined by g:neosnippet#snippets_directory.
|
||||||
|
|
||||||
Note: |:NeoComplCacheEditSnippets| is obsolete name.
|
Note: |:NeoComplCacheEditSnippets| is an obsolete name.
|
||||||
|
|
||||||
:NeoComplCacheEdit -runtime [filetype]
|
:NeoComplCacheEdit -runtime [filetype]
|
||||||
|
|
||||||
It edits a runtime snippet file with neosnippet.
|
Opens the [filetype] runtime snippets to edit. It automatically
|
||||||
Re-make cache will be done automatically when you save the
|
selects the current buffer's file type snippets unless you specify
|
||||||
file.
|
a file type by [filetype]. The snippets are re-cached automatically
|
||||||
|
when you save the file after edit.
|
||||||
|
|
||||||
*:NeoComplCacheEditRuntimeSnippets*
|
*:NeoComplCacheEditRuntimeSnippets*
|
||||||
Note: |:NeoComplCacheEditRuntimeSnippets| is obsolete name.
|
Note: |:NeoComplCacheEditRuntimeSnippets| is an obsolete name.
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
VARIABLES *neosnippet-variables*
|
VARIABLES *neosnippet-variables*
|
||||||
@ -134,7 +137,7 @@ g:neosnippet#snippets_directory *g:neosnippet#snippets_directory*
|
|||||||
"vim.snip*" and "vim_*.snip*" and "vim/**/*.snip" snippet files.
|
"vim.snip*" and "vim_*.snip*" and "vim/**/*.snip" snippet files.
|
||||||
|
|
||||||
*g:neocomplcache_snippets_dir*
|
*g:neocomplcache_snippets_dir*
|
||||||
Note: |g:neocomplcache_snippets_dir| is obsolete name.
|
Note: |g:neocomplcache_snippets_dir| is an obsolete name.
|
||||||
|
|
||||||
This variable doesn't exist unless you declare it.
|
This variable doesn't exist unless you declare it.
|
||||||
|
|
||||||
@ -230,7 +233,7 @@ i_<Plug>(neosnippet_start_unite_snippet)
|
|||||||
Note: |unite.vim| is required.
|
Note: |unite.vim| is required.
|
||||||
|
|
||||||
*<Plug>(neocomplcache_start_unite_snippet)*
|
*<Plug>(neocomplcache_start_unite_snippet)*
|
||||||
Note: |<Plug>(neocomplcache_start_unite_snippet)| is obsolete
|
Note: |<Plug>(neocomplcache_start_unite_snippet)| is an obsolete
|
||||||
name.
|
name.
|
||||||
|
|
||||||
x_<Plug>(neosnippet_expand_target)
|
x_<Plug>(neosnippet_expand_target)
|
||||||
@ -261,7 +264,7 @@ neosnippet#expandable()
|
|||||||
|neocomplcache#sources#snippets_complete#expandable()|
|
|neocomplcache#sources#snippets_complete#expandable()|
|
||||||
and
|
and
|
||||||
|neocomplcache#sources#snippets_complete#force_expandable()|
|
|neocomplcache#sources#snippets_complete#force_expandable()|
|
||||||
is obsolete name.
|
are obsolete names.
|
||||||
|
|
||||||
neosnippet#jumpable()
|
neosnippet#jumpable()
|
||||||
*neosnippet#jumpable()*
|
*neosnippet#jumpable()*
|
||||||
@ -271,7 +274,7 @@ neosnippet#jumpable()
|
|||||||
|
|
||||||
*neocomplcache#sources#snippets_complete#jumpable()*
|
*neocomplcache#sources#snippets_complete#jumpable()*
|
||||||
Note: |neocomplcache#sources#snippets_complete#jumpable()| is
|
Note: |neocomplcache#sources#snippets_complete#jumpable()| is
|
||||||
obsolete name.
|
an obsolete name.
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
FUNCTIONS *neosnippet-functions*
|
FUNCTIONS *neosnippet-functions*
|
||||||
@ -285,7 +288,7 @@ neosnippet#get_snippets_directory()
|
|||||||
*neocomplcache#sources#snippets_complete#get_snippets_dir()*
|
*neocomplcache#sources#snippets_complete#get_snippets_dir()*
|
||||||
Note:
|
Note:
|
||||||
|neocomplcache#sources#snippets_complete#get_snippets_dir()|
|
|neocomplcache#sources#snippets_complete#get_snippets_dir()|
|
||||||
is obsolete name.
|
is an obsolete name.
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
EXAMPLES *neosnippet-examples*
|
EXAMPLES *neosnippet-examples*
|
||||||
|
Loading…
Reference in New Issue
Block a user