Zotero Better Notes

Everything about note management. All in Zotero.

User Guide(EN) | 用户指引(中文)

All in Zotero: Best Note Practice

https://user-images.githubusercontent.com/33902321/167992626-34adfd97-c2df-48b0-b9ff-e245bd792d5c.mp4

Features

• LaTex view supported(v0.4.0). Click the Tex button in the toolbar or Ctrl/⌘+'/' to switch between editor view & LaTex view!
  
• Archive notes/annotations in one place with just a click;
• Foward-link to sub-notes and back-link to PDF attachments;
• Export archived notes in MarkDown/rich-text format.
  • Export markdown with images is supported in v0.1.1
• Use templates to customize your note! Document. Discuss & contribute your template here

Quick Start Guide

Install

• Download the latest release (.xpi file) from the Releases PageNote If you're using Firefox as your browser, right-click the .xpi and select "Save As.."
• In Zotero click Tools in the top menu bar and then click Addons
• Go to the Extensions page and then click the gear icon in the top right.
• Select Install Add-on from file.
• Browse to where you downloaded the .xpi file and select it.
• Restart Zotero, by clicking restart now in the extensions list where the Zotero PDF Translate plugin is now listed.

Usage

For new users, a User Guide will help you get started quickly and create a user guide note for you. Use it as a playground and explore your own workflow!

Important Changes

• Since v0.2.0, most of the workspace bottom-left buttons are moved to menu bar.
• Since v0.5.0, workspace will open as a Zotero tab by default. Menu -> File -> Open in New Window or press shift while clicking the Open Workspace button to use the standalone mode.

Documentation:
User Guide(EN) | 用户指引(中文)

Development & Contributing

This add-on is built on the Zotero Addon Template of zotero-pdf-translate.

Build

# A release-it command: version increase, npm run build, git push, and GitHub release
# You need to set the environment variable GITHUB_TOKEN https://github.com/settings/tokens
# release-it: https://github.com/release-it/release-it
npm run release

Alternatively, build it directly using build.js: npm run build

Build Steps

1. Clean ./builds
2. Copy ./addon to ./builds
3. Esbuild to ./builds/addon/chrome/content/scripts
4. Replace __buildVersion__ and __buildTime__ in ./builds/addon
5. Zip the ./builds/addon to ./builds/*.xpi

Debug

1. Copy zotero command line config file. Modify the commands.

cp zotero-cmd-default.json zotero-cmd.json

2. Setup addon development environment following this link.

3. Build addon and restart Zotero with this npm command.

npm run restart

You can also debug code in these ways:

• Test code segments in Tools->Developer->Run Javascript;
• Debug output with Zotero.debug(). Find the outputs in Help->Debug Output Logging->View Output;
• UI debug. Zotero is built on the Firefox XUL framework. Debug XUL UI with software like XUL Explorer.

  XUL Documents:
  https://www.xul.fr/tutorial/
  http://www.xulplanet.com/

Disclaimer

Use this code under AGPL (open source required). No warranties are provided. Keep the laws of your locality in mind!

Part of the code of this repo refers to other open-source projects within the allowed scope.

• zotero-pdf-translate

My Other Zotero Addons

• zotero-pdf-translate PDF translation for Zotero 6
• zotero-tag Automatically tag items/Batch tagging