From f8fa5227903e32bbc4b1d106a973be1ed142075a Mon Sep 17 00:00:00 2001
From: Miao Jiang <jiangfriend@gmail.com>
Date: Mon, 29 Oct 2012 14:50:45 +0800
Subject: [PATCH] Update vimwiki compatible hint.

---
 README.md | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 51bd813..8fa2f68 100644
--- a/README.md
+++ b/README.md
@@ -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)