dwp-forge / refnotes

4 stars 6 forks source link

using - in cite keys #34

Closed Jas2Ma closed 8 years ago

Jas2Ma commented 8 years ago

I'm using better bibtex pluging for zotero which uses "-" characters in cite keys. I actually found no documentation for bibtex cite keys, but "-" seems to agree with my bibtex.

Nevertheless refnotes does not like "-", I can't get a refnotes reference using "-" characters in cite keys. Can you fix this?

dwp-forge commented 8 years ago

The BibTeX support was added as an extension of named note syntax. The names use DW page naming convention (alphanumerics plus "_"), so "-" was not supposed to be supported. Yet BibTeX example uses ":ref:Knuth-LCE-1985" as a name. Not sure anymore if it was planned or I just overlooked and didn't test properly. In any case it's a bug either in the code or in the documentation.

I no longer actively work on the plugin, and it would take me some time to figure side effects of such a change. There are number of ways to define and use a note and all of them should be considered before extending the syntax. The easiest way would be just to update the documentation to ":ref:Knuth_LCE_1985" but I guess that is not the solution you are looking for.

Maybe if I will have a spare weekend and I'll look into this in more detail but I cannot promise anything. The pull requests are welcome, though.

Jas2Ma commented 8 years ago

Too bad you don't actively work on this plugin anymore. Since this problem is giving me real trouble, I may at least find some workaround for me. Don't know whether I will take the time to search for a profound solution, because I have no qualification regarding this problem at the moment.

dwp-forge commented 8 years ago

I looked at the code again and it turned out that "-" is supported throughout the plugin. It was just BibTeX parser that could not handle it. I already released the fix.

Jas2Ma commented 8 years ago

Perfect! Thanks a lot!