diff --git a/doc/neocomplcache-snippets-complete.txt b/doc/neosnippet.txt similarity index 79% rename from doc/neocomplcache-snippets-complete.txt rename to doc/neosnippet.txt index b3a84d7..35bc60e 100644 --- a/doc/neocomplcache-snippets-complete.txt +++ b/doc/neosnippet.txt @@ -1,7 +1,7 @@ -*neocomplcache-snippets-complete.txt* - neocomplcache complete snippets source +*neosnippet.txt* + neo-snippet plugin contains neocomplcache snippets source -Version: 2.0 +Version: 3.0 Author : Shougo License: MIT license {{{ Permission is hereby granted, free of charge, to any person obtaining @@ -23,44 +23,46 @@ License: MIT license {{{ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. }}} -CONTENTS *neocomplcache-snippets-complete-contents* +CONTENTS *neosnippet-contents* -Introduction |neocomplcache-snippets-complete-introduction| -Install |neocomplcache-snippets-complete-install| -Interface |neocomplcache-snippets-complete-interface| - Commands |neocomplcache-snippets-complete-commands| - Variables |neocomplcache-snippets-complete-variables| - Key mappings |neocomplcache-snippets-complete-key-mappings| - Functions |neocomplcache-snippets-complete-functions| -Examples |neocomplcache-snippets-complete-examples| -Snippet syntax |neocomplcache-snippets-complete-snippet-syntax| -Changelog |neocomplcache-snippets-complete-changelog| +Introduction |neosnippet-introduction| +Install |neosnippet-install| +Interface |neosnippet-interface| + Commands |neosnippet-commands| + Variables |neosnippet-variables| + Key mappings |neosnippet-key-mappings| + Functions |neosnippet-functions| +Examples |neosnippet-examples| +Snippet syntax |neosnippet-snippet-syntax| +Changelog |neosnippet-changelog| ============================================================================== -INTRODUCTION *neocomplcache-snippets-complete-introduction* +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. ============================================================================== -INSTALL *neocomplcache-snippets-complete-install* +INSTALL *neosnippet-install* 1: Install neocomplcache (https://github.com/Shougo/neocomplcache). 2: Extract the file and put files in your Vim directory (usually ~/.vim/ or Program Files/Vim/vimfiles on Windows). ============================================================================== -INTERFACE *neocomplcache-snippets-complete-interface* +INTERFACE *neosnippet-interface* ------------------------------------------------------------------------------ -COMMANDS *neocomplcache-snippets-complete-commands* +COMMANDS *neosnippet-commands* -:NeoComplCacheCachingSnippets [filetype] *:NeoComplCacheCachingSnippets* +:NeoComplCacheCachingSnippets [filetype] + *:NeoComplCacheCachingSnippets* Makes cache of [filetype] snippets. It automatically selects current buffer's filetype unless you specify [filetype]. -:NeoComplCacheEditSnippets [filetype] *:NeoComplCacheEditSnippets* +:NeoComplCacheEditSnippets [filetype] + *:NeoComplCacheEditSnippets* Opens [filetype] snippets to edit. It automatically selects current buffer's filetype unless you specify [filetype]. @@ -71,7 +73,8 @@ COMMANDS *neocomplcache-snippets-complete-commands* |g:neocomplcache_snippets_dir| with precedence. Re-cache will be done automatically when you save the file. -:NeoComplCacheEditRuntimeSnippets [filetype] *:NeoComplCacheEditRuntimeSnippets* +:NeoComplCacheEditRuntimeSnippets [filetype] + *:NeoComplCacheEditRuntimeSnippets* Opens [filetype] snippets to edit. It automatically selects current buffer's filetype unless you specify [filetype]. @@ -83,7 +86,7 @@ COMMANDS *neocomplcache-snippets-complete-commands* you save the file. ------------------------------------------------------------------------------ -VARIABLES *neocomplcache-snippets-complete-variables* +VARIABLES *neosnippet-variables* g:neocomplcache_snippets_dir *g:neocomplcache_snippets_dir* This variable appoints a path to user-defined snippet files. @@ -95,7 +98,8 @@ g:neocomplcache_snippets_dir *g:neocomplcache_snippets_dir* This variable doesn't exist unless you declare it. -g:neocomplcache_disable_select_mode_mappings *g:neocomplcache_disable_select_mode_mappings* +g:neocomplcache_disable_select_mode_mappings + *g:neocomplcache_disable_select_mode_mappings* This variable controls whether to disable Key-mappings in |Select-mode| when snippets_complete performs. Usually you had better enable it. @@ -103,39 +107,44 @@ g:neocomplcache_disable_select_mode_mappings *g:neocomplcache_disable_select_mod Default value is 1. g:neocomplcache_snippets_disable_runtime_snippets - *g:neocomplcache_snippets_disable_runtime_snippets* + *g:neocomplcache_snippets_disable_runtime_snippets* If this variable is 1, runtime snippets won't be loaded. This variable is useful to avoid snippets conflictions. Default value is 0. ------------------------------------------------------------------------------ -KEY MAPPINGS *neocomplcache-snippets-complete-key-mappings* +KEY MAPPINGS *neosnippet-key-mappings* -(neocomplcache_snippets_expand) *(neocomplcache_snippets_expand)* +(neocomplcache_snippets_expand) + *(neocomplcache_snippets_expand)* Expands a cursor snippet of plural lines. When there is no snippet, jumps to the next placeholder. Note: It searches cursor snippet from keyword patterns in the first. -(neocomplcache_snippets_jump) *(neocomplcache_snippets_jump)* +(neocomplcache_snippets_jump) + *(neocomplcache_snippets_jump)* Jump to next placeholder. If there is no placeholder, expand a multiline cursor snippet. -(neocomplcache_snippets_force_expand) *(neocomplcache_snippets_force_expand)* +(neocomplcache_snippets_force_expand) + *(neocomplcache_snippets_force_expand)* Expand a cursor snippet. Does nothing if there is no snippet. -(neocomplcache_snippets_force_jump) *(neocomplcache_snippets_force_jump)* +(neocomplcache_snippets_force_jump) + *(neocomplcache_snippets_force_jump)* Jump to next place holder. Do not expand any snippet. When you do not want to expand a snippet name, use this keymapping. -(neocomplcache_start_unite_snippet) *(neocomplcache_start_unite_snippet)* +(neocomplcache_start_unite_snippet) + *(neocomplcache_start_unite_snippet)* Start unite snippet source. Note: This mappings is available in insert mode. neocomplcache#sources#snippets_complete#expandable() - *neocomplcache#sources#snippets_complete#expandable()* + *neocomplcache#sources#snippets_complete#expandable()* Use this function with imap . It checks whether cursor text is a snippet trigger or a placeholder exists in the current buffer. It's useful for saving keymappings. @@ -149,27 +158,27 @@ neocomplcache#sources#snippets_complete#expandable() \ "\(neocomplcache_snippets_expand)" : "\" < neocomplcache#sources#snippets_complete#force_expandable() - *neocomplcache#sources#snippets_complete#force_expandable()* + *neocomplcache#sources#snippets_complete#force_expandable()* Use this function with imap . It checks whether cursor text is snippet trigger. Useful for saving keymappings. neocomplcache#sources#snippets_complete#jumpable() - *neocomplcache#sources#snippets_complete#jumpable()* + *neocomplcache#sources#snippets_complete#jumpable()* Use this function with imap . It checks whether cursor text is an existing placeholder in current buffer. Useful for saving keymappings. ------------------------------------------------------------------------------ -FUNCTIONS *neocomplcache-snippets-complete-functions* +FUNCTIONS *neosnippet-functions* neocomplcache#sources#snippets_complete#get_snippets_dir() - *neocomplcache#sources#snippets_complete#get_snippets_dir()* + *neocomplcache#sources#snippets_complete#get_snippets_dir()* Gets snippet directories. This directories contain runtime snippets directories and |g:neocomplcache_snippets_dir| directories. ============================================================================== -EXAMPLES *neocomplcache-snippets-complete-examples* +EXAMPLES *neosnippet-examples* > " Plugin key-mappings. imap (neocomplcache_snippets_expand) @@ -185,7 +194,7 @@ EXAMPLES *neocomplcache-snippets-complete-examples* endif < ============================================================================== -SNIPPET SYNTAX *neocomplcache-snippets-complete-snippet-syntax* +SNIPPET SYNTAX *neosnippet-snippet-syntax* The snippet syntax is similar to |snipMate|. @@ -199,7 +208,8 @@ Example: endif < snippet {snippet_name} syntax is the snippet name. -abbr {abbr_name} is the completion abbrevation (same to completion "abbr" key). +abbr {abbr_name} is the completion abbrevation (same to completion "abbr" +key). prev_word '^' means this snippet is enabled only in line head. By the way, it is warned that the snippet name was already defined by other @@ -284,12 +294,13 @@ languages' indent files can not work very well (e.g.: PHP, Python). } < ============================================================================== -UNITE SOURCES *neocomplcache-snippets-complete-unite-sources* +UNITE SOURCES *neosnippet-unite-sources* - *neocomplcache-snippets-complete-unite-source-snippet* + *neosnippet-unite-source-snippet* snippet - The candidates are neocomplcache snippets. The kinds are "snippet". - Normally used in |(neocomplcache_start_unite_snippet)| mappings. + The candidates are neocomplcache snippets. The kinds are + "snippet". Normally used in + |(neocomplcache_start_unite_snippet)| mappings. But you can execute it by ":Unite snippet". You can edit snippet file in "edit" action. Examples: @@ -298,13 +309,20 @@ snippet < source actions -snippet *neocomplcache-snippets-complete-unite-action-snippet* +snippet *neosnippet-unite-action-snippet* expand Expand snippet (default action) edit Edit snippet preview View snippet definition ============================================================================== -CHANGELOG *neocomplcache-snippets-complete-changelog* +CHANGELOG *neosnippet-changelog* + +2012-09-27 +- Ver.3 development is started. +- Renamed documentation. + +------------------------------------------------------------------------------ +ChangeLog 2.0: 2012-09-27 - Improved add placeholder behavior.