You’re reading the ZotLit v2 beta docs. Still on v1? Read the v1 docs

ZotLit

Keep notes up to date

Update a single literature note or a batch of notes when your Zotero data changes, without losing your own writing.

When your Zotero metadata or annotations change, you can refresh your literature notes to match. ZotLit preserves your own writing by updating only the parts it manages.

Update a single note

These commands are available from the command palette and from the right-click context menu on a literature note file. They only appear when the active file is a literature note (a note with a zotero-key frontmatter field).

Update the full note

Open a literature note

Open the literature note you want to update.

Run the update command

Open the command palette (Ctrl+P on Windows/Linux, Cmd+P on macOS) and run:

ZotLit: Update literature note

ZotLit refreshes the frontmatter and re-renders the content inside the managed region (%%zt-managed%% ... %%/zt-managed%%). Your writing outside the managed region stays untouched.

A notice confirms: "Literature note updated."

Update metadata only

To refresh frontmatter without touching the note body, run:

ZotLit: Update literature note metadata

A notice confirms: "Metadata updated." The note body is not changed.

Context menu

You can also right-click a literature note file in the file explorer. The ZotLit section of the context menu offers Update literature note, Update literature note metadata, and Overwrite literature note.

Update notes in batch

You start batch updates from the ZotLit companion, not from an Obsidian command.

Select items in Zotero

In Zotero, select one or more items in your library. Right-click to open the context menu, then choose ZotLit > Update note(s) in Obsidian (or Update note(s) metadata in Obsidian for metadata only).

Confirm in Obsidian

Obsidian opens a confirmation dialog titled Update literature notes. It shows how many notes will be created or updated, grouped by status (Update, Create, Not found).

Click Update notes to proceed.

Review the summary

After the batch completes, a summary appears: "Done. {created} created, {updated} updated, {failed} failed."

Large selections

A selection too large to fit in a protocol link falls back to an HTTP connection to Obsidian. If the ZotLit server is not enabled in Obsidian, Zotero shows a notice asking you to enable it or select fewer items.

You can also open a single note from Zotero by right-clicking one item and choosing ZotLit > Open note in Obsidian.

Overwrite a note

ZotLit: Overwrite literature note is a separate, destructive command. It replaces the entire note body with the re-rendered note template. Frontmatter keys managed by ZotLit are refreshed; other frontmatter keys you added are kept.

A confirmation dialog appears before the overwrite proceeds.

Notes created with ZotLit v1

Literature notes created with ZotLit v1 do not have a managed region. Running Update literature note on a v1 note refreshes its frontmatter but leaves the body untouched, showing the notice "Frontmatter updated. No managed region found."

To fully refresh a v1 note's body, use ZotLit: Overwrite literature note. This replaces the entire body with the current note template.

See also

On this page