From 023cdd322a1c84ecba0e9b627561853cca88a668 Mon Sep 17 00:00:00 2001 From: Klaas Gunst Date: Fri, 26 Oct 2018 14:26:28 +0200 Subject: [PATCH 1/4] Multiple cites are put in one \cite{}. Correct bibtex ref If you select multiple papers at once, they are put in the same cite bracket (comma separated). "/" is substituted out of the id. Since this also happens for the bibtex refs. --- plugin/papis.vim | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/plugin/papis.vim b/plugin/papis.vim index 436f2a7..12aa5d6 100644 --- a/plugin/papis.vim +++ b/plugin/papis.vim @@ -26,14 +26,11 @@ function! s:handler(a) let candidates = [] for line in citations let id = matchlist(line, pat)[1] - call add(candidates, "\\cite{". id . "}") + call add(candidates, substitute(id, "/", "", "g")) endfor endif - for candidate in candidates - execute join([cmd, candidate]) - endfor - + execute "normal a\\cite{" . join(candidates, ", ") . "}\egql" endfunction From 3ef96995280419f15990d1da86c566b74884ce3d Mon Sep 17 00:00:00 2001 From: Klaas Gunst Date: Sun, 28 Oct 2018 00:37:14 +0200 Subject: [PATCH 2/4] Improved citation adding when inside \cite{} When inside a cite body, the citation is added to this \cite{} body and no new body is initialized --- plugin/papis.vim | 52 ++++++++++++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/plugin/papis.vim b/plugin/papis.vim index 12aa5d6..2b12f39 100644 --- a/plugin/papis.vim +++ b/plugin/papis.vim @@ -4,36 +4,50 @@ function! s:yank_to_register(data) silent! let @+ = a:data endfunction +function! s:get_reference(line) + let l:pat='@\v(.*)$' + return substitute(matchlist(a:line, l:pat)[1], "/", "", "g") +endfunction + +function! s:inside_cite_body() + execute "silent! normal mq?\\\\cite\\|}\r" + let l:inbody = getline('.')[col('.')-1: col('.') + 3] ==# '\cite' + execute "normal `q" + return l:inbody +endfunction function! s:handler(a) - let lines = a:a - if lines == [] || lines == ['','',''] + let l:lines = a:a + if l:lines == [] || l:lines == ['','',''] return endif " Expect at least 2 elements, `query` and `keypress`, which may be empty " strings. - let query = lines[0] - let keypress = lines[1] - let cmd = "normal a" - let pat = '@\v(.{-})$' + let l:keypress = l:lines[1] + let l:citations = l:lines[2:] + let l:candidates = [] + + " Making list of the things to cite + for l:line in l:citations + call add(l:candidates, s:get_reference(l:line)) + endfor + " it is possible to yank the doc id using the ctrl-y keypress - if keypress ==? "ctrl-y" - let hashes = join(filter(map(lines[2:], 'matchlist(v:val, pat)[1]'), 'len(v:val)'), "\n") - return s:yank_to_register(hashes) + if l:keypress ==? "ctrl-y" + execute s:yank_to_register(join(l:candidates, "\n")) " this will insert \cite{id} command for all selected citations else - let citations = lines[2:] - let candidates = [] - for line in citations - let id = matchlist(line, pat)[1] - call add(candidates, substitute(id, "/", "", "g")) - endfor + " If you are already in a \cite{} body + if s:inside_cite_body() + execute "normal \/\}\rgea, " . join(l:candidates, ", ") ."\e" + " start a fresh \cite{} body + else + execute "normal a\\cite{" . join(l:candidates, ", ") . "}\e" + endif endif - - execute "normal a\\cite{" . join(candidates, ", ") . "}\egql" endfunction +let g:PapisFormat = '"{doc[author]}: {doc[title]}' command! -bang -nargs=* Papis - \ call fzf#run(fzf#wrap({'source': 'papis list --format "{doc[author]}: {doc[title]} @{doc[ref]}"', 'sink*': function('handler'), 'options': '--multi --expect=ctrl-y --print-query'})) - + \ call fzf#run(fzf#wrap({'source': 'papis list --format ' . g:PapisFormat . ' @{doc[ref]}"', 'sink*': function('handler'), 'options': '--multi --expect=ctrl-y --print-query'})) From 108946be28e122d5b085efb591c5cd26948d1380 Mon Sep 17 00:00:00 2001 From: Klaas Gunst Date: Mon, 29 Oct 2018 10:06:29 +0100 Subject: [PATCH 3/4] Added PapisView PapisView: when cursor on a citation, opens the pdf through papis normal! everywhere also, to make that the command does not use userdefined mappings. --- plugin/papis.vim | 55 +++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 50 insertions(+), 5 deletions(-) diff --git a/plugin/papis.vim b/plugin/papis.vim index 2b12f39..957bf27 100644 --- a/plugin/papis.vim +++ b/plugin/papis.vim @@ -10,9 +10,9 @@ function! s:get_reference(line) endfunction function! s:inside_cite_body() - execute "silent! normal mq?\\\\cite\\|}\r" + execute "silent! normal! mq?\\\\cite\\|}\r" let l:inbody = getline('.')[col('.')-1: col('.') + 3] ==# '\cite' - execute "normal `q" + execute "normal! `q" return l:inbody endfunction @@ -39,15 +39,60 @@ function! s:handler(a) else " If you are already in a \cite{} body if s:inside_cite_body() - execute "normal \/\}\rgea, " . join(l:candidates, ", ") ."\e" + execute "normal! \/\}\rgea, " . join(l:candidates, ", ") ."\e" " start a fresh \cite{} body else - execute "normal a\\cite{" . join(l:candidates, ", ") . "}\e" + execute "normal! a\\cite{" . join(l:candidates, ", ") . "}\e" endif endif endfunction let g:PapisFormat = '"{doc[author]}: {doc[title]}' +let g:PapisBackend = 'whoosh' command! -bang -nargs=* Papis - \ call fzf#run(fzf#wrap({'source': 'papis list --format ' . g:PapisFormat . ' @{doc[ref]}"', 'sink*': function('handler'), 'options': '--multi --expect=ctrl-y --print-query'})) + \ call fzf#run(fzf#wrap({'source': 'papis list "*" --format ' . g:PapisFormat . ' @{doc[ref]}"', 'sink*': function('handler'), 'options': '--multi --expect=ctrl-y --print-query'})) + +function! s:get_citeref(cite, full_list) + for l:ref in a:full_list + if a:cite ==# substitute(l:ref, "/", "", "g") + return l:ref + endif + endfor +endfunction + +function! s:get_all_citerefs() + return systemlist('papis list "ref:*" --format "{doc[ref]}"') +endfunction + +function! s:get_cite_under_cursor() + if s:inside_cite_body() + if getline('.')[col('.') -1] ==# ',' + return + endif + + execute "silent! normal! mq/[}{]\r" + if getline('.')[col('.') -1] ==# '{' + execute "silent! normal! `q" + return + endif + + execute "silent! normal! `q" + execute "silent! normal! ?[{,]\rwv/[,}]\rge\"qy`q" + return @q + endif +endfunction + +function! s:PapisView() + let l:cite = s:get_cite_under_cursor() + if l:cite ==# "" + return + endif + + let l:full_list = s:get_all_citerefs() + let l:ref = s:get_citeref(l:cite, l:full_list) + call system('papis open "ref:' . l:ref . '"') +endfunction + +command! -bang PapisView + \ call s:PapisView() From 6a3048eee2ee0ae1db57e609e79a2d9cab773f64 Mon Sep 17 00:00:00 2001 From: Klaas Gunst Date: Wed, 28 Nov 2018 21:04:37 +0100 Subject: [PATCH 4/4] Changed README, added automatic detection of used backend --- README.md | 14 ++++++++++++++ plugin/papis.vim | 30 +++++++++++++++++++++++++----- 2 files changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 90fcd55..81cabd3 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,20 @@ Add these lines to the `.vimrc`: The `:Papis` command will open a search window for your bibliographic database. `Enter` command will insert citation for the selected record in the current buffer. +The `:PapisView` command will open the pdf file of the citation currently under your cursor with the same pdf-reader used by papis. +This currently only works when using whoosh as backend for the papis database. Add the following to your `config` file of papis: + + database-backend = whoosh + whoosh-schema-fields = ['ref'] + +The second is needed to enable whoosh for searches through the ref field. + + +Add the following to your `tex.vim` file for useful keyboard shortcuts: + + nnoremap pc :Papis + nnoremap pv :PapisView + ## Documentation For more information, execute `:help papis` in Vim. diff --git a/plugin/papis.vim b/plugin/papis.vim index 957bf27..6a3c294 100644 --- a/plugin/papis.vim +++ b/plugin/papis.vim @@ -48,10 +48,26 @@ function! s:handler(a) endfunction let g:PapisFormat = '"{doc[author]}: {doc[title]}' -let g:PapisBackend = 'whoosh' +let g:PapisBackend = '' -command! -bang -nargs=* Papis - \ call fzf#run(fzf#wrap({'source': 'papis list "*" --format ' . g:PapisFormat . ' @{doc[ref]}"', 'sink*': function('handler'), 'options': '--multi --expect=ctrl-y --print-query'})) +function! s:getPapisBackend() + if g:PapisBackend ==# '' + let g:PapisBackend = systemlist('papis config database-backend')[0] + endif + return g:PapisBackend +endfunction + +function! s:Papis(searchline) + let l:searchinp = a:searchline + if l:searchinp ==# '' + if s:getPapisBackend() ==# "whoosh" + let l:searchinp = '"*"' + endif + endif + call fzf#run(fzf#wrap({'source': 'papis list ' . l:searchinp . ' --format ' . g:PapisFormat . ' @{doc[ref]}"', 'sink*': function('s:handler'), 'options': '--multi --expect=ctrl-y --print-query'})) +endfunction + +command! -bang -nargs=* Papis call s:Papis('') function! s:get_citeref(cite, full_list) for l:ref in a:full_list @@ -84,6 +100,11 @@ function! s:get_cite_under_cursor() endfunction function! s:PapisView() + if s:getPapisBackend() !=# "whoosh" + echom "PapisView only works for Papis with whoosh as database-backend at the moment" + return + endif + let l:cite = s:get_cite_under_cursor() if l:cite ==# "" return @@ -94,5 +115,4 @@ function! s:PapisView() call system('papis open "ref:' . l:ref . '"') endfunction -command! -bang PapisView - \ call s:PapisView() +command! -bang PapisView call s:PapisView()