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 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.

Settings

Find settings here: Menubar -> Edit -> Preferences -> Preview

Advanced Usage of Preview Page Index

A python-style slice command is supported.

Syntax: command1,command2,...
Supported Commands:

• Number
  Number from 1 to last page

  Example:
  1
  preview page 1

  ---

  Example:
  10
  preview page 10

• Slice
  startIndex:stopIndex.
  The startIndex page is included while the stopIndex page is excluded.

  startIndex or stopIndex may be a negative number, which means it counts from the end of the file instead of the beginning.

  The startIndex or stopIndex may be missing to indicate that starts from the first page or ends at the last page.

  Example:
  1:11
  preview page 1-10

  ---

  Example:
  :11
  preview page first page(1)-10

  ---

  Example:
  10:
  preview page 10-last page

  ---

  Example:
  -3:
  preview last 3 pages

  ---

  Example:
  :-3
  preview page first page(1)-last 3rd page(excluded)

  ---

  Example:
  :
  preview every page

Development & Contributing

This add-on is built on the zotero-addon-template.

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-better-notes Note enhancements for Zotero
• zotero-pdf-translate PDF translation for Zotero 6
• zotero-tag Automatically tag items/Batch tagging