Citater

citater (a fork of obsidian-citation-plugin) is a minimal Obsidian reference manager plugin.

Installation

citater has not been officially added to the Obsidian community plugin list. In the meantime, you can manually install the plugin by downloading main.js and manifest.json from the latest release and copy them to your vault at .obsidian/plugins/citater.

Usage

The plugin offers four simple features at the moment:

1. Open literature note (Ctrl+L): automatically create or open a literature note for a particular reference. The title, folder, and initial content of the note can be configured in the plugin settings.
2. Insert literature note reference (Ctrl+Shift+E): insert a link to the literature note corresponding to a particular reference.
3. Insert literature note content in the current pane (no hotkey by default): insert content describing a particular reference into the current pane. (This can be useful for updating literature notes you already have but which are missing reference information.)
4. Insert Markdown citation (no hotkey by default): insert a Pandoc-style citation for a particular reference. (The exact format of the citation can be configured in the plugin settings.)

Templates

You can set up your own template for both the title and content of literature notes. The following variables can be used:

* {{citekey}}
* {{abstract}}
* {{authorString}}
* {{containerTitle}}
* {{DOI}}
* {{eprint}}
* {{eprinttype}}
* {{eventPlace}}
* {{page}}
* {{publisher}}
* {{publisherPlace}}
* {{title}}
* {{titleShort}}
* {{URL}}
* {{year}}

For example, your literature note title template can simply be @{{citekey}} and the content template can look like:

---
title: {{title}}
authors: {{authorString}}
year: {{year}}
---
{{abstract}}

Releases

Complete the following tasks to release a new citater version.

1. Check that all tests pass by running npm run tests.
2. Export the new version to the environment variable citater_package_version. For example, `export citater_package_version='0.1.2'.
3. Create a new subheading in CHANGELOG.md with any updates specifying the new version and data of release. For example, ## [0.1.2] - 2024-07-02. Ensure that you leave the ## [Unreleased] above this new release.
4. Run npm run bump to automatically bump all relevant version strings. Check that all staged files in git are correct.
5. Run npm run release to commit, release, and push a new tag.

License

Code contained in this project is released under the MIT License as specified in LICENSE.md. This license grants you the freedom to use, modify, and distribute it as long as you include the original copyright notice contained in LICENSE.md and the following disclaimer.

Portions of this code were incorporated and adapted with permission from citater by OASCI under the MIT License.