windingwind / zotero-pdf-preview

Preview Zotero attachments in the library view.
GNU General Public License v3.0
1.17k stars 19 forks source link
pdf preview zotero zotero-plugin zotero7

This repository/plugin is archived and no longer maintained, since from Zotero 7.0.0-beta.55, attachment preview is supported natively.

Preview for Zotero

Using Zotero Plugin Template

teaser

Preview attachments in the library view.

Fast & easy. Do not require any third-party softwares.

🧩 Outline

👋 Install

😎 Quick start

🔧 Development

🔎 My Zotero Plugins

👋 Install

For Zotero 6, install the latest stable version; For Zotero 7, install the latest prerelease version

😎 Quick start

Preview can be found in the right side panel of Zotero's main window. You can preview items in either the top/bottom of the info pane or the preview pane. See Settings to customize your preview position.

Shortcuts

To show/hide the preview in info pane, use shortcut P or drag/click the toggel bar.

To zoom in or zoom out, hold ctrl/cmd and scroll, or ctrl/cmd and +/-;

To reset zoom, use ctrl/cmd + 0.

Settings

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

Setting Details Default Value
Enable Preview Enable to allow the preview behavior. true
Preview in Info Tab Enable to show the preview in a split view under 'info' tab. true
Preview Position Preview position in the Info Tab bottom
Preview in 'Preview' Tab Enable show the preview in a new tab of right sidebar. true
Show Toolbar in Info Tab/Preview Tab Enable show the toolbar there. true
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 See below 10
Preview Tab Name Set the tab label. preview

Advanced Usage of Preview Page Index

A python-style slice command is supported.

Syntax: Click to expand `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

This plugin is built based on the Zotero Plugin Template. See the setup and debug details there.

To startup, run

git clone https://github.com/windingwind/zotero-better-notes.git
cd zotero-better-notes
npm install
npm run build

The plugin is built to ./builds/*.xpi.

🔔 Disclaimer

Use this code under AGPL. No warranties are provided. Keep the laws of your locality in mind!

🔎 My Zotero Plugins