plugins.zotcite.settings

Options provided to the require('zotcite').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  filetypes = [
    "markdown"
    "quarto"
  ];
  hl_cite_key = false;
  open_in_zotero = true;
  wait_attachment = true;
}

Declared by:

plugins.zotcite.settings.conceallevel

Zotcite sets the conceallevel of the Markdown document to 2. Use this option if you want a different value.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 2

Declared by:

plugins.zotcite.settings.filetypes

Which filetypes to enable Zotcite on.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Plugin default:

[
  "markdown"
  "pandoc"
  "rmd"
  "quarto"
  "vimwiki"
]

Declared by:

plugins.zotcite.settings.hl_cite_key

Set to false if you want to disable Zotcite’s syntax highlighting of citation keys.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.zotcite.settings.open_in_zotero

Set this to true if you want :ZOpenAttachment to open PDF attachments in Zotero (as opposed to your system’s default PDF viewer).

Note that you’ll need to have Zotero configured as the default app for opening zotero:// links. On Linux, assuming your Zotero installation included a zotero.desktop file, you can do the following:

xdg-mime default zotero.desktop x-scheme-handler/zotero

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.zotcite.settings.wait_attachment

While opening an attachment, Zotcite cannot catch errors because it doesn’t wait for the application to finish.

If zotcite fails to open a PDF attachment, you may want to temporarily set this option to true.

Then, Neovim should freeze until the attachment is closed, and, if the PDF viewer finishes with non-zero status, anything output to the stderr will be displayed as a warning message.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: