Simple Citations

by masaki39
5
4
3
2
1
Score: 61/100

Description

Category: Learning & Knowledge Management

The Simple Citations plugin streamlines the process of managing literature notes in Obsidian by integrating with Zotero and the Citations plugin. It allows users to easily import or update literature notes with minimal setup. The plugin supports adding new notes or updating existing ones with metadata such as title, authors, journal, year, DOI, and Zotero URI, which are automatically appended to the frontmatter. Additionally, it offers compatibility with Pandoc for exporting citations in Word document format, while ensuring correct formatting for multiple citations and aliases. This plugin is ideal for researchers seeking a straightforward way to organize and manage their references.

Reviews

No reviews yet.

Stats

24
stars
5,653
downloads
1
forks
744
days
4
days
4
days
2
total PRs
0
open PRs
0
closed PRs
2
merged PRs
6
total issues
0
open issues
6
closed issues
23
commits

Latest Version

5 days ago

Changelog

Simple Citations 1.6.0

New Features

BetterBibTeX JSON support

  • BetterBibTeX JSON files exported by the Better BibTeX for Zotero extension can now be registered alongside Better CSL JSON files.
  • Format is detected automatically from file content — no additional configuration required.
  • Field mapping from BetterBibTeX JSON:
    • creators (author type) → authors
    • dateyear
    • publicationTitlejournal
    • DOIdoi
    • selectzotero (supports both personal and group libraries natively)
  • Two new opt-in properties, shown in settings only when a BetterBibTeX JSON file is detected:
    • Include PDF paths — automatically populates a pdf property from local attachment paths (no postscript required).
    • Include collections — automatically populates a collections property from Zotero collection membership.
  • Disabling either toggle removes the corresponding property from existing notes on the next update.
  • Both formats can be used simultaneously. File order in settings determines priority when the same citation key appears in multiple files.

Pandoc: CSL JSON–only bibliography

  • The Pandoc Citeproc command now passes only Better CSL JSON files to --bibliography, skipping BetterBibTeX JSON files (which are not supported by citeproc).
  • If no CSL JSON file is registered, the command is cancelled with an explanatory notice instead of silently failing.

PDF export commands (requires Poppler)

  • Export PDF — copies the PDF file(s) listed in the pdf frontmatter property to the configured export folder.
  • Export PDF images — extracts embedded images from PDF(s) as PNG files using pdfimages (part of Poppler). Output files are named pdf1-000.png, pdf1-001.png, etc.
  • Both commands read the pdf property set automatically when using BetterBibTeX JSON, or manually via the optional fields / postscript workflow.

README file from

Github

Simple Citations

GitHub Release Total Downloads

This is an Obsidian plugin that reinforces the workflow between Zotero and Obsidian. It enables the importation of literature notes from Zotero, and use them not only as the knowledge base but also the references for your writing. Requiring the installation of Better Bibtex for Zotero and Pandoc.

✨ Features

Add & update literature notes from the bibliography file in one go

command: Add literature note

The dataview query in the gif above is as follows:

table without id 
authors[0] as FirstAuthor, journal, year, title, 
link(file.name, "Note") as Note,
elink(zotero,"Zotero") as Zotero,
elink(doi,"DOI") as DOI
from "Literatures" // set the folder name of the literature notes
sort file.ctime desc
limit 100

And the notes generated by the command is as follows:

[!important] You have options to add or update literature notes automatically when the bibliography file is updated. You also have options to automatically update literature notes when opened.

This means that you have to add items only to Zotero, and automatically add/update them to Obsidian.

Using literature notes as the references and export to docx(requires pandoc)

command: Pandoc Citeproc Execution (docx)

  • Optionally, set csl file path or url in the properties named csl.
  • CSL file is the file that defines the citation style of the journal.
  • You can download or get url of the csl file from here.

The result file(docx) is as follows:

⚙️ Initial Settings

  1. Install the better bibtex for zotero to the Zotero and configure the export of the bibliography file.
    • Set the export location to your vault.
    • Set the automatic export option to true.
    • Set the file type to Better CSL JSON or BetterBibTeX JSON.

[!note] Better CSL JSON supports the Pandoc export feature but contains less information. Additional fields can be added via the postscript workflow described below. BetterBibTeX JSON provides richer data out of the box (group library URI, PDF paths, collections) but cannot be used with the Pandoc export feature. Both formats can be registered simultaneously in the plugin settings.

  1. Enable the Obsidian community plugin, then install Simple Citations and activate it.
  2. Set the bibliography file path and export folder path in the plugin settings.
  3. You can use the commands:
    • Add literature note
    • Update literature note
    • Update literature note (active file)
    • Pandoc Citeproc Execution (docx)
    • Conver to Pandoc format
    • Copy missing note links
      • This command identifies and copies links to literature notes that are not included in the JSON file.
    • Export PDF (requires export folder to be set)
      • Copies the PDF file(s) listed in the pdf frontmatter property to the export folder.
    • Export PDF images (requires Poppler)
      • Extracts embedded images from PDF(s) as PNG files using pdfimages.

[!warning] Citekeys containing # ^ [ ] | \ / : will be skipped as these characters are not allowed in Obsidian filenames. Check the console log if items are missing.

📚 Group libraries support

[!note] BetterBibTeX JSON handles group libraries automatically — no postscript required. The section below applies to Better CSL JSON only.

By default, the Zotero link in each literature note uses zotero://select/items/@citekey, which only works for personal libraries. If you use Zotero group libraries with Better CSL JSON, you need to add the following postscript in Better BibTeX to export the library URI:

if (Translator.BetterCSLJSON) {
  csl.zotero_uri = zotero.uri;
}

When zotero_uri is present and contains a group ID, the plugin automatically generates the correct link: zotero://select/groups/{groupId}/items/@citekey. No additional plugin settings are required.

➕ Additional options

[!tip] The optional content below will be removed if you set the option to false and execute the "Update" command.

🏷️ Tag Option

Generate tags for the following:

  • author/${firstAuthor}
  • journal/${journalName}

🧩 Optional fields

Better Bibtex for Zotero has the function to add optional fields to the bibliography file.

  1. Open the Zotero
  2. Open the "Preferences"
  3. Set "postscript" as you want

Reference for the script. → Scripting :: Better BibTeX for Zotero

Postscript examples
if (Translator.BetterCSLJSON) {
  csl.key = zotero.key;
}

Set key in the plugin settings.

if (Translator.BetterCSLJSON) {
  csl.pdf = zotero.attachments
    .filter(a => a.localPath && a.localPath.toLowerCase().endsWith('.pdf'))
    .map(a => a.localPath);
}

Set pdf in the plugin settings.

if (Translator.BetterCSLJSON) {
  function path(key) {
    const coll = Translator.collections[key];
    if (!coll) return '';
    if (!coll.parent) return coll.name;
    return `${path(coll.parent)}/${coll.name}`;
  }

  let collections = [];
  zotero.collections.forEach((key) => {
    const p = path(key);
    if (p) collections.push(p);
  });

  csl.collections = collections;
  csl.zotero_uri = zotero.uri;
}

Set collections in the plugin settings. Each entry gets its Zotero collection paths (e.g. ["Folder/Subfolder"]).

From Issues #5

if (Translator.BetterCSLJSON) {
  function path(key) {
    const coll = Translator.collections[key];
    if (!coll) return '';
    if (!coll.parent) return coll.name;
    return `${path(coll.parent)}/${coll.name}`;
  }

  let collections = [];
  let library = Translator.exportPath.replace(/.*[\\/]/, '').replace(/\.[^.]+$/, '');
  zotero.collections.forEach((key) => {
    const p = path(key);
    if (p) collections.push(library + ": " + p);
  });

  
  csl.collections = collections.length > 0 ? collections : [library];
  csl.zotero_uri = zotero.uri;
}

Set collections in the plugin settings. Each collection is prefixed with the library name derived from the export file name (e.g. "My Library: Folder/Subfolder"). Entries without collections show the library name alone (e.g. ["My Library"]).

📝 Abstract Option

Insert the abstract section in the top of the note. The comment tag below is used to identify the abstract section.

<!-- START_ABSTRACT -->

<!-- END_ABSTRACT -->

📄 Template Option

Insert the template content in the top of the note. The comment tag below is used to identify the template section.

<!-- START_TEMPLATE -->

<!-- END_TEMPLATE -->

[!note] This template is applied to all notes and the content is static. Therefore, it is recommended to use Dataview for setting dynamic templates.

When executing the "Pandoc Citeproc Execution (docx)" command, the link format is temporarily converted to the format of the pandoc citeproc.

The plugin modifies the link format as follows:

  • [[@citation-key]][@citation-key]
  • [[@citation-key|aliases]][@citation-key] // aliases are allowed
  • [[@citation-key]][[@citation-key]][@citation-key;@citation-key] // multiple citations are allowed
  • [[@citation-key]] [[@citation-key]][@citation-key;@citation-key] // spaces or line breaks can be inserted between links
  • End of a sentence: [[@citation-key]] → end of a sentence [@citation-key]. // inserts links before . if there is nothing between them.

🙏 Support

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.
Topic Linking
4 years ago by Liam Magee
An Obsidian plugin for finding and linking topics in a vault.
Zotero Desktop Connector
4 years ago by mgmeyers
Insert and import citations, bibliographies, notes, and PDF annotations from Zotero into Obsidian.
Pandoc Reference List
4 years ago by mgmeyers
Display a formatted reference in Obsidian's sidebar for each pandoc citekey in the active document.
Zotero Bridge
4 years ago by Shmavon Gazanchyan
Obsidian plugin to integrate with Zotero
Zotero Link
4 years ago by Shmavon Gazanchyan
Obsidian plugin to insert link to Zotero item
Pretty BibTeX
4 years ago by Sandro Figo
A plugin for Obsidian that shows raw BibTeX bibliography entries in a prettier way. (https://obsidian.md)
Reference Map
3 years ago by Anoop K. Chandran
Reference and citation map for literature review and discovery
Zotero Sync
3 years ago by Frithjof Gressmann
A Zotero Sync client for Obsidian
ZotLit
3 years ago by AidenLx
A third-party project that aims to facilitate the integration between Obsidian.md and Zotero, by providing a set of community plugins for both Obsidian and Zotero.
Citations
5 years ago by Jon Gauthier
Obsidian plugin which integrates your academic reference manager with the Obsidian editor. Search your references from within Obsidian and automatically create and reference literature notes for papers and books.
Copy as LaTeX
4 years ago by mo-seph
Quick plugin to be able to copy/paste from Obsidian/Markdown into a Latex document
Latex Exporter
a year ago by Matthew S. Scott
Paste Quote
a year ago by Jacob Williams
Helps with formatting and citing quotes when pasting into Obsidian.
logos-refs
a year ago by Joey Kilgore
Easily take refs from Logos into Obsidian
BibLib
a year ago by Callum Alpass
Obsidian-based reference and literature note manager.
Citation Callouts
9 months ago by Michael Marvive
Obsidian Plugin that formats a quote with a citation in a custom callout
Bibtex Entry View
9 months ago by Kyoungdeuk
Load the bibtex entry of a given bibkey from a given bib file and show the entry in the code block of bibkey.
LiteCite
8 months ago by ras0q
A lightweight Obsidian plugin that creates citation notes from a BibTeX / BibLaTeX file
BibTeX Scholar
7 months ago by Qilong Liu
Make your literature review and writing contextual and frictionless—right inside your Obsidian vault!