Permalink
Browse files

Add documentations about new Unite integration

  • Loading branch information...
1 parent d18e10c commit 4a0d4e2bba0a5a96a5a9c0cccc2594d8a416a4c7 @lambdalisue lambdalisue committed Nov 24, 2014
View
@@ -147,9 +147,11 @@ endfunction
Call functions BookmarkSave, BookmarkLoad and BookmarkClearAll with the last argument set to 0 to perform these operations silently. You may use this to manage your bookmark list transparently from within your custom script.
## Unite Integration
+![A screenshot of vim-bookmarks' Unite interface](./screenshot-unite-interface.png)
[Unite](https://github.com/Shougo/unite.vim) is a multi-purpose user-interface plugin platform.
-When showing all your bookmarks, Unite is detected and the plugin will open `:Unite vim_bookmarks` instead of Vim's quickfix window.
+vim-bookmarks provide an Unite source called `vim_bookmarks` so users who use Unite will handle bookmarks with the Unite interface.
+Additionally, when showing all your bookmarks, Unite is detected and the plugin will open `:Unite vim_bookmarks` instead of Vim's quickfix window.
Note that `g:bookmark_auto_close` is no longer applied, once opened, the window is managed by Unite.
To set a global per-source context setting, that will apply to Unite's vim_bookmarks source everytime it's opened, you can add this to your `vimrc`:
@@ -164,6 +166,19 @@ call unite#custom#profile('source/vim_bookmarks', 'context', {
\ })
```
+With the Unite interface, when you select bookmarks, you can perform the following actions.
+
+- Open the selected bookmarks in various ways (open in right, open in above, open in new tab, etc.)
+- Yank the informations of selected bookmarks (path and line number, the line content, annotation, etc.)
+- Highlight the lines of the selected bookmarks
+- Replace the contents of selected bookmarks with [vim-qfreplace](https://github.com/thinca/vim-qfreplace) interface
+- Delete the selected bookmarks
+- And more!
+
+See the screenshot below to get the image of what you can do with the interface (the size of the picture is not enough, that mean you can select even more actions actually!).
+
+![A screenshot of action list of vim-bookmarks' Unite interface](./screenshot-unite-interface-actions.png)
+
For more information about Unite, start reading `:help Unite`.
## FAQ
View
@@ -227,10 +227,12 @@ this feature is located in the 'examples/bm-autoload-example.vim' file.
===============================================================================
7. Unite Integration *BookmarksUniteIntegration*
-Unite is a multi-purpose user-interface plugin platform. When showing all your
-bookmarks, Unite is detected and the plugin will open ':Unite vim_bookmarks'
-instead of Vim's quickfix window. Note that |g:bookmark_auto_close| is no
-longer applied, once opened, the window is managed by Unite.
+Unite is a multi-purpose user-interface plugin platform. vim-bookmarks provide
+an Unite source called *vim_bookmarks* so users who use Unite will handle
+bookmarks with the Unite interface. When showing all your bookmarks, Unite is
+detected and the plugin will open ':Unite vim_bookmarks' instead of Vim's
+quickfix window. Note that |g:bookmark_auto_close| is no longer applied, once
+opened, the window is managed by Unite.
To set a global per-source context setting, that will apply to Unite's quickfix
source everytime it's opened, you can add this to your |vimrc|:
@@ -243,9 +245,23 @@ source everytime it's opened, you can add this to your |vimrc|:
\ 'no_quit': 1,
\ })
<
+
+With the Unite interface, when you select bookmarks, you can perform the
+following actions.
+
+- Open the selected bookmarks in various ways (open in right, open in above,
+ open in new tab, etc.)
+- Yank the informations of selected bookmarks (path and line number, the line
+ content, annotation, etc.)
+- Highlight the lines of the selected bookmarks
+- Replace the contents of selected bookmarks with vim-qfreplace
+- Delete the selected bookmarks
+- And more!
+
For more information about Unite, start reading |:Unite|.
https://github.com/Shougo/unite.vim
+https://github.com/thinca/vim-qfreplace
===============================================================================
8. FAQ *BookmarksFAQ*
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4a0d4e2

Please sign in to comment.