Permalink
Browse files

Update vimwiki compatible hint.

  • Loading branch information...
jiangmiao committed Oct 29, 2012
1 parent 7287467 commit f8fa5227903e32bbc4b1d106a973be1ed142075a
Showing with 22 additions and 3 deletions.
  1. +22 −3 README.md
View
@@ -242,15 +242,34 @@ Compatible with Vimwiki - [issue #19](https://github.com/jiangmiao/auto-pairs/is
Description: When works with vimwiki `<CR>` will output `<SNR>xx_CR()`
Reason: vimwiki uses `<expr>` on mapping `<CR>` that auto-pairs cannot expanding.
- Solution: add `let g:AutoPairsMapCR = 0` to .vimrc to disable `<CR>` mapping.
+ Solution A: Add
+
+ " Copy from vimwiki.vim s:CR function for CR remapping
+ function! VimwikiCR()
+ let res = vimwiki#lst#kbd_cr()
+ if res == "\<CR>" && g:vimwiki_table_mappings
+ let res = vimwiki#tbl#kbd_cr()
+ endif
+ return res
+ endfunction
+ autocmd filetype vimwiki inoremap <buffer> <silent> <CR> <C-R>=VimwikiCR()<CR><C-R>=AutoPairsReturn()<CR>
+
+ to .vimrc, it will make vimwiki and auto-pairs 'Return' feature works together.
+ Solution B: add `let g:AutoPairsMapCR = 0` to .vimrc to disable `<CR>` mapping.
+
Compatible with viki - [issue #25](https://github.com/jiangmiao/auto-pairs/issues/25)
Description: When works with viki `<CR>` will output viki#ExprMarkInexistentInElement('ParagraphVisible','<CR>')
Reason: viki uses `<expr>` on mapping `<CR>` that auto-pairs cannot expanding.
- Solution A: add `autocmd filetype viki inoremap <buffer> <silent> <CR> <C-R>=viki#ExprMarkInexistentInElement('ParagraphVisible',"\n")<CR><C-R>=AutoPairsReturn()<CR>` to .vimrc
- It will make viki and auto-pairs works together.
+ Solution A: Add
+
+ autocmd filetype viki inoremap <buffer> <silent> <CR> <C-R>=viki#ExprMarkInexistentInElement('ParagraphVisible',"\n")<CR><C-R>=AutoPairsReturn()<CR>`
+
+ to .vimrc, it will make viki and auto-pairs works together.
+
Solution B: add `let g:AutoPairsMapCR = 0` to .vimrc to disable `<CR>` mapping.
+
Remarks: Solution A need NOT add `let g:AutoPairsMapCR = 0` to .vimrc, if Solution A still cannot work, then have to use Solution B to disable auto-pairs `<CR>`.
Breaks '.' - [issue #3](https://github.com/jiangmiao/auto-pairs/issues/3)

0 comments on commit f8fa522

Please sign in to comment.