jalvesaq / zotcite

Neovim plugin for integration with Zotero
GNU General Public License v3.0
159 stars 13 forks source link

Zotero Citation Key #60

Closed dandennison84 closed 1 year ago

dandennison84 commented 1 year ago

I'm not sure how active this project still is? At any rate, what is the reasoning behind the section titled, ZCitationTemplate, in the documentation? Zotero and plugins like BetterBibTex already provide a citation key that many of us use in its Citation Key field in Zotero. Zotero users construct that key to fit whatever needs we have. For example, I use: auth(10).lower+veryshorttitle +year. There are more examples of fields here: https://retorque.re/zotero-better-bibtex/citing/.

I don't see any instructions in how to match key styles with zotcite? Only the small number of fields in the ZCitationTemplate section. Are there more and do they match?

I also don't see why the 'ZoteroKey#' is required on every key. I have many markdown documents from other tools full of keys with the above referencing style that zotcite can't figure out because of that identifier. Parity with what would have been generated by Zotero as a key in a json or bib file should also be a goal.

Ex: My current key in a pandoc markdown context: [@managerWhat2021] zotcite: [@SIPZIE2M#Manager_Fox_2021] Even if I could somehow fix zotcite to match my style, I would still have: [@SIPZIE2M#managerWhat2021]

I don't think this will work with all of my existing markdown files since I'm stuck with the non-id version and not about to go change them all.

jalvesaq commented 1 year ago

what is the reasoning behind the section titled, ZCitationTemplate

It's aesthetic. The citation template may be whatever pleases you because it is deleted by the zotref filter before the document is passed to Pandoc's citeproc.

I don't see any instructions in how to match key styles with zotcite?

It's irrelevant because (in my case) the purpose of the citation key is to have visible text in the markdown that resembles what will be seen in the final document. This is useful for the author-date system (common in the social sciences), not for the numeric citation system (common in other areas).

Due to the conceal feature of Vim/Neovim, the visible part of @SIPZIE2M#Manager_Fox_2021 will be Manager_Fox_2021. I find this useful when I have to write something like:

"Manager and Fox (2021) say that..."

because what I see in the markdown is almost the same:

"Manager_Fox_2021 say that..."

With your preferred citation key (managerWhat2021), I would not know whether to write "say" or "says", unless I remembered that managerWhat2021 refers to a paper co-authored by two people.

That is, the purpose of the citation key in zotcite is to contribute to making Vim/Neovim closer to a WYSWYG editor of markdown documents.

I don't think this will work with all of my existing markdown files since I'm stuck with the non-id version and not about to go change them all.

Unfortunately, it will not. It may also not be good for collaborative work when each co-author uses his/her own Zotero database because the internal Zotero keys will be different.