citekey: link to BibDesk (in wiki.vim too) [feature request]

[alexandreroberts]

This is a feature request just like the one I just opened for vimtex. It too is based on an old thread from a year ago about how doing so might be feasible.

What I would like is to be able to enter a single command (in the case of wiki.vim, simply <CR>) in order to open the citekey under the cursor in BibDesk (on MacOS). Unlike in vimtex, I don't think wiki.vim "knows" which .bib file to use, so perhaps it would make most sense for it to simply be a reference to whatever .bib file is open in BibDesk at the time. I think this might be what open x-bdsk://citekey (see description here) does by default anyway.

[lervag]

Just for completeness, could you give one or more examples of wiki text with citekeys?

As a very simple, first step, I've added a handler for bdsk: schemes. Thus, if you write a link like bdsk:citekey, then I believe it should work as expected already.

[alexandreroberts]

Just for completeness, could you give one or more examples of wiki text with citekeys?

Here is an example: See @ei2 and @BS. (The cite keys are ei2 and BS, respectively. Note that final dots do not count as part of the citekey, as we determined here.)

As a very simple, first step, I've added a handler for bdsk: schemes. Thus, if you write a link like bdsk:citekey, then I believe it should work as expected already.

I've just tested it and can confirm that it works: when I type <CR> while the cursor is over the text bdsk:ei2 in a wiki file, BibDesk opens and displays the ei2 entry.

[lervag]

Ok, so what is missing now is to connect @... with bdsk:.... Or, is it? In fact, it is not. You can change it with:

let g:wiki_link_default_schemes = { 'cite': 'bdsk' }

Can you test this and see if it is actually a sufficient solution here?

[alexandreroberts]

That did it! Once I added this line to my nvim configuration, it worked perfectly: with cursor over the @, e, i, or 2 in @ei2., pressing <CR> brought opened the ei2 entry in BibDesk.

As I tested it further, I noticed a "bug" related to that wiki-ft.vim query of mine from a year ago: if the citekey contains :, then wiki-ft.vim and wiki.vim treat it as if the citekey ended before the :, i.e., both in how it is highlighted and what citekey string wiki.vim passes to BibDesk. Many of my citekeys use the character :.

I think the solution to that "bug" would be the same as for .: count : as part of the citekey unless it is the very last permissible character of a citekey.

[alexandreroberts]

Ditto for +, which I also use in citekeys!

[lervag]

That did it! Once I added this line to my nvim configuration, it worked perfectly: with cursor over the @, e, i, or 2 in @ei2., pressing <CR> brought opened the ei2 entry in BibDesk.

Great, glad to hear it!

As I tested it further, I noticed a "bug" related to that wiki-ft.vim query of mine from a year ago: if the citekey contains :, then wiki-ft.vim and wiki.vim treat it as if the citekey ended before the :, i.e., both in how it is highlighted and what citekey string wiki.vim passes to BibDesk. Many of my citekeys use the character :.

I think the solution to that "bug" would be the same as for .: count : as part of the citekey unless it is the very last permissible character of a citekey.

Could you give a couple of examples of this? And, just for the sake of clarity, is this a bug in wiki.vim or in wiki-ft.vim? Or both?

[lervag]

Nevermind, I think I figured out what you want and I think my latest commit fixes it. Please update and test.

[alexandreroberts]

Thanks for the fix! I've just tested it now, and in the case of + it works perfectly (both wiki-ft.vim, i.e., the highlighting and wiki.vim, i.e., the link to BibDesk).

In the case of : the highlighting is right, but when I type <CR> while the cursor is on a citekey that includes :, nothing happens at all.

[lervag]

Huh, strange. Can you type <leader>wl on that link and post the information you get here?

[lervag]

Also, can you give me an example of how that link looks like?

[alexandreroberts]

The citekey is @john.skylitzes:histories:thurn1973. This is what wiki.vim returns:

 Type:          url
 Match:         skylitzes:histories:thurn1973
 URL:           skylitzes:histories:thurn1973
 Description:   N/A
                
 Resolved URL object: 
   url:         skylitzes:histories:thurn1973
   stripped:    histories:thurn1973
   origin:      /Users/robe941/Documents/wikiNotepad/index.wiki
   scheme:      skylitzes

So it looks like . and : don't work together in the same citekey.

Here is a screenshot showing that this citekey is nevertheless correctly highlighted:

[alexandreroberts]

Ah, but curiously when I put my cursor over the john part, this is what I get instead:

 Type:          cite
 Match:         @john.skylitzes:histories:thurn1973
 URL:           bdsk:john.skylitzes:histories:thurn1973
 URL (raw):     john.skylitzes:histories:thurn1973
 Description:   N/A
                
 Resolved URL object: 
   url:         bdsk:john.skylitzes:histories:thurn1973
   stripped:    john.skylitzes:histories:thurn1973
   origin:      /Users/robe941/Documents/wikiNotepad/index.wiki
   scheme:      bdsk

But even then, <CR> does nothing.