Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Ron89 committed Jun 1, 2016
1 parent b031c10 commit 203d880
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ prefer the split buffer display of result over the word replacement routine.
----------------

Another might-be-useful routine is the one to query synonym for and replace
a multi-word phrase covered in visual mode.
a multi-word phrase covered in visual mode, using the same key mapping
`<Leader>cs`

```
vnoremap <Leader>cs y:ThesaurusQueryReplace <C-r>"<CR>
Expand All @@ -92,6 +93,14 @@ function. To invoke it, use keybinding `ctrl-x ctrl-u` in insert mode. This
function resembles Vim's own thesaurus checking function, but using online
resources for matchings.

---------------

Finally, this plugin support thesaurus checkup for manually input through
command mode command `:Thesaurus`.

```
:Thesaurus your phrase
```

## Configuration

Expand Down
4 changes: 2 additions & 2 deletions doc/thesaurus_query.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Internet is required for online query backend to be functional;
===============================================================================
3. Usage *tq-usage*

The plugin provides three ways of using.
The plugin provides several ways of using.

:ThesaurusQueryReplaceCurrentWord *:ThesaurusQueryReplaceCurrentWord*
This command checkup the word under cursor and attempt to replace it with
Expand Down Expand Up @@ -85,7 +85,7 @@ The functionalities are also mapped to key-bindings, if `g:tq_map_keys=1` as
default (Note: since this plugin is active for all buffers, the use of
`<LocalLeader>`is now depreciated):
nnoremap <unique> <Leader>cs :ThesaurusQueryReplaceCurrentWord<CR>
vnoremap <unique> <Leader>cs y:Thesaurus <C-r>"<CR>
vnoremap <unique> <Leader>cs "ky:ThesaurusQueryReplace <C-r>k<CR>
nnoremap <LocalLeader>cs :ThesaurusQueryReplaceCurrentWord<CR>
vnoremap <LocalLeader>cs "ky:ThesaurusQueryReplace <C-r>k<CR>

Expand Down

0 comments on commit 203d880

Please sign in to comment.