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

Merge pull request #75 from cpfaff/english_doc

Browse Source 
English doc
This commit is contained in:
ujihisa 2012-10-30 03:48:52 -07:00
commit 7b4a6d18ab
1 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
doc/neosnippet.txt
View File

@ -40,9 +40,10 @@ Changelog |neosnippet-changelog|
==============================================================================
INTRODUCTION *neosnippet-introduction*
This source analyzes snippet files for completion, offers functionality
similar to snipMate.vim or snippetsEmu.vim. Since you can choose snippet with
neocomplcache interface, you might have less trouble learning it.
This plugin analyzes snippet files which you can use for completion. It offers
functionality similar to snipMate.vim or snippetsEmu.vim. Since you can choose
snippets with the neocomplcache interface, you might have less trouble learning
it because you do not have to remember each snippet name.
==============================================================================
INSTALL *neosnippet-install*
@ -62,7 +63,7 @@ COMMANDS *neosnippet-commands*
:NeoSnippetMakeCache [filetype]
*:NeoSnippetMakeCache*
Creates a cache for the [filetype] snippets. It automatically
Creates a cache for the given [filetype] snippets. It automatically
choses the current buffer's file type unless you specify one by
[filetype].
@ -152,7 +153,7 @@ g:neosnippet#disable_select_mode_mappings
Note: |g:neocomplcache_disable_select_mode_mappings| is an
obsolete name.
Default value is 1.
The default value is 1.
g:neosnippet#disable_runtime_snippets
*g:neosnippet#disable_runtime_snippets*
@ -173,7 +174,7 @@ g:neosnippet#disable_runtime_snippets
\ }
" Works like g:neocomplcache_snippets_disable_runtime_snippets
" (Disable all runtime snippets).
" which disables all runtime snippets
let g:neosnippet#disable_runtime_snippets = {
\ '_' : 1,
\ }
@ -192,49 +193,49 @@ KEY MAPPINGS *neosnippet-key-mappings*
s_<Plug>(neosnippet_expand_or_jump)
*s_<Plug>(neosnippet_expand_or_jump)*
Expands a cursor snippet of plural lines. When there is no
snippet, jumps to the next placeholder.
snippet, it jumps to the next placeholder.
*<Plug>(neocomplcache_snippets_expand)*
Note: |<Plug>(neocomplcache_snippets_expand)| is obsolete
Note: |<Plug>(neocomplcache_snippets_expand)| is an obsolete
name.
<Plug>(neosnippet_jump_or_expand)
*<Plug>(neosnippet_jump_or_expand)*
s_<Plug>(neosnippet_jump_or_expand)
*s_<Plug>(neosnippet_jump_or_expand)*
Jump to next placeholder. If there is no placeholder, expand a
multiline cursor snippet.
Jump to the next placeholder. If there is no placeholder, it expands a
multi line cursor snippet.
*<Plug>(neocomplcache_snippets_jump)*
Note: |<Plug>(neocomplcache_snippets_jump)| is obsolete
Note: |<Plug>(neocomplcache_snippets_jump)| is an obsolete
name.
<Plug>(neosnippet_expand)
*<Plug>(neosnippet_expand)*
s_<Plug>(neosnippet_expand)
*s_<Plug>(neosnippet_expand)*
Expand a cursor snippet. Does nothing if there is no snippet.
Expand a cursor snippet. It does nothing if there is no snippet.
*<Plug>(neocomplcache_snippets_force_expand)*
Note: |<Plug>(neocomplcache_snippets_force_expand)| is
obsolete name.
an obsolete name.
<Plug>(neosnippet_jump)
*<Plug>(neosnippet_jump)*
s_<Plug>(neosnippet_jump)
*s_<Plug>(neosnippet_jump)*
Jump to next place holder. Do not expand any snippet. When
you do not want to expand a snippet name, use this keymapping.
Jump to the next place holder. Do not expand any snippet. When
you do not want to expand a snippet name, use this key mapping.
*<Plug>(neocomplcache_snippets_force_jump)*
Note: |<Plug>(neocomplcache_snippets_force_jump)| is
obsolete name.
an obsolete name.
i_<Plug>(neosnippet_start_unite_snippet)
*i_<Plug>(neosnippet_start_unite_snippet)*
Start unite snippet source. You can expand a snippet by unite
interface.
Note: |unite.vim| is required.
Starts the unite snippet source. You can expand a snippet by the
unite interface. Note: The plugin |unite.vim| is required for
that.
*<Plug>(neocomplcache_start_unite_snippet)*
Note: |<Plug>(neocomplcache_start_unite_snippet)| is an obsolete
@ -242,20 +243,20 @@ i_<Plug>(neosnippet_start_unite_snippet)
x_<Plug>(neosnippet_expand_target)
*x_<Plug>(neosnippet_expand_target)*
Expand inputted trigger by selected target text.
Expand the input trigger by a selected target text.
x_<Plug>(neosnippet_register_oneshot_snippet)
*x_<Plug>(neosnippet_register_oneshot_snippet)*
Register oneshot snippet in current buffer.
Register oneshot snippet in the current buffer.
neosnippet#expandable()
*neosnippet#expandable()*
Use this function with imap <expr>. It checks whether cursor
text is a snippet trigger or a placeholder exists in the
current buffer. It's useful for saving keymappings.
Return value is not just a boolean but either
0: not found
1: cursor text is a snippet trigger
You can use this function with imap <expr>. It checks whether the
cursor text is a snippet trigger or a placeholder. This is is useful
to save key mappings. The return values of the function are:
0: not found
1: the cursor text is a snippet trigger
2: a placeholder exists in the current buffer
3: both found
>
@ -272,9 +273,9 @@ neosnippet#expandable()
neosnippet#jumpable()
*neosnippet#jumpable()*
Use this function with imap <expr>. It checks whether cursor
text is an existing placeholder in current buffer.
Useful for saving keymappings.
Use this function with imap <expr>. It checks if the cursor
text is an existing placeholder in current buffer. This is
useful to save key mappings.
*neocomplcache#sources#snippets_complete#jumpable()*
Note: |neocomplcache#sources#snippets_complete#jumpable()| is