Zotero PDF Preview
Preview PDF attachments in the library view.
Fast & easy. Do not require any third-party softwares.
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 clickAddons
- 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.
Settings
Find settings here: Menubar -> Edit -> Preferences -> Preview
Setting | Details | Default Value |
---|---|---|
Enable Preview | Enable to allow the preview behavior. | true |
Auto Focus Preview Tab | Enable to focus the preview tab automatically when you select a valid preview item. | false |
Show Annotations | Enable to show annotations of the PDF files. May slow down the preview speed. | false |
Show Hovered Page Style | Enable extra style of the hovered page: box shadow and hand cursor. | true |
Double-click Preview Page to Open/Jump PDF | Enable double-click to open/jump to the selected page of PDF. | true |
Dark Mode | Enable to preview PDF files in dark mode. This is a naive dark mode and images color may not be displayed correctly. | false |
Preview First N Pages | Set how many pages you want to appear in preview. More pages will make the preview slower. Set to 1 for the cover view. |
10 |
Preview Tab Name | Set the tab label. | preview |
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
- Clean
./builds
- Copy
./addon
to./builds
- Esbuild to
./builds/addon/chrome/content/scripts
- Replace
__buildVersion__
and__buildTime__
in./builds/addon
- Zip the
./builds/addon
to./builds/*.xpi
Debug
- Copy zotero command line config file. Modify the commands.
cp zotero-cmd-default.json zotero-cmd.json
-
Setup addon development environment following this link.
-
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.
My Other Zotero Addons
- zotero-better-notes Note enhancements for Zotero
- zotero-pdf-translate PDF translation for Zotero 6
- zotero-tag Automatically tag items/Batch tagging