Skip to content

aguvener/zTLDR

Repository files navigation

zTLDR - TL;DR Summaries for Zotero

zTLDR Logo

Automatically fetch and display TL;DR summaries from Semantic Scholar in Zotero 7

Latest Release License

Features

  • 🔍 Automatic TL;DR Fetching - Summaries are automatically fetched when you add new items
  • 📚 Semantic Scholar Integration - Uses both DOI and title matching for best coverage
  • 💾 Syncs Across Devices - TL;DR data is stored in the Extra field, so it syncs with your Zotero library
  • 🔄 Smart Retry - Automatically retries failed API requests
  • 📊 Statistics Dashboard - Track how many items have summaries
  • 🌐 Multi-language - English and Chinese localization

How It Works

  1. When you add items to your library, zTLDR automatically queries Semantic Scholar
  2. It first tries to find the paper by DOI for accurate matching
  3. If no DOI or no match, it falls back to title-based search
  4. The TL;DR summary is stored in the item's Extra field as TLDR: <summary>
  5. Summaries are displayed in a dedicated section in the item pane

Installation

  1. Download the latest .xpi file from Releases
  2. In Zotero, go to Tools → Add-ons
  3. Click the gear icon and select Install Add-on From File...
  4. Select the downloaded .xpi file
  5. Restart Zotero

Usage

Automatic Fetching

By default, TL;DR summaries are automatically fetched when you add new items. You can disable this in preferences.

Manual Actions

  • Right-click an itemUpdate TL;DR - Refresh the summary for selected items
  • Right-click an itemCopy TL;DR - Copy the summary to clipboard
  • Right-click an itemOpen in Semantic Scholar - View the paper on Semantic Scholar
  • Right-click a collectionUpdate TL;DR for Collection - Fetch summaries for all items

Tools Menu

  • TL;DR Statistics - View counts of items with/without summaries
  • Retry Failed TL;DR Fetches - Retry items that failed due to API errors
  • Clear All TL;DR Data - Remove all TL;DR data from your library
  • Fetch TL;DR for All Items - Process all items in your library

Preferences

Go to Zotero → Settings → TL;DR to configure:

Setting Default Description
Auto-fetch on add ✅ Enabled Automatically fetch TL;DR when items are added
Auto-retry errors ✅ Enabled Automatically retry failed requests
Request delay 100ms Delay between API requests (rate limiting)
Retry delay 30 min How long to wait before retrying failed items

Status Messages

When a TL;DR cannot be retrieved, the plugin shows the specific reason:

Status Meaning
[No DOI or title available] Item lacks searchable metadata
[Paper not found in Semantic Scholar] Paper not in the database
[Paper found but no TL;DR available] Paper exists but has no summary
[API error - will retry] Temporary error, will retry later

Data Storage

TL;DR summaries are stored in the item's Extra field in the format:

TLDR: <summary text> [SS:<paper_id>]

This means:

  • ✅ Summaries sync across all your devices via Zotero Sync
  • ✅ Data is preserved in library exports
  • ✅ Other Extra field content is preserved

Credits

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

About

Fetch and display TL;DR summaries from Semantic Scholar in Zotero

Topics

Resources

License

Stars

Watchers

Forks