/zotcite

Vim plugin for integration with Zotero

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Zotcite

Zotcite is a Vim plugin that provides integration with Zotero. With zotcite you can:

  • Do omni completion of citation keys from Zotero database in Markdown, RMarkdown and Quarto documents.

    Omni completion

    Citation key highligting

  • Quickly see on the status bar information on the reference under the cursor.

    Reference brief information

    Complete reference information

  • Use the zotref.py filter to pre-process the Markdown document before the citations are processed by pandoc, avoiding the need of bib files.

  • Open the PDF attachment of the reference associated with the citation key under cursor.

  • Extract highlighted text and text notes from PDF attachments of references.

  • Extract Zotero notes from Zotero database.

  • Add all cited references to the YAML header of the Markdown document.

Zotcite is being developed and tested on Linux and should work flawlessly on other Unix systems, such as Mac OS X. It may require additional configuration on Windows.

Installation

Requirements:

  • Zotero 5

  • Python 3

  • Python modules PyQt5 and popplerqt5 (only if you are going to extract annotations from PDF documents). On Debian based Linux distributions, you can install them with the command:

    sudo apt install python3-pyqt5 python3-poppler-qt5

Zotcite can be installed as any Vim plugin. It is recommended the use of a plugin manager, such as Vim-Plug.

The zotero module does not import the vim module. Hence, its code could easily be adapted to other text editors such as Emacs or Gedit.

Usage

Please, read the plugin's documentation for further instructions.

Known bug

Zotcite syntax highlighting will not be enabled if the file type is pandoc.

Acknowledgment

Zotcite code was based on the citation.vim project.