Overleaf-Bib-Helper

A UserScript to enhance Overleaf by allowing article searches and BibTeX retrieval from DBLP and Google Scholar directly within the Overleaf editor.

---

中文文档 • Installation • Usage • Supported Sources • Troubleshooting • Disclaimer • Changelog • License • Contributing • Contact • Organizers • Contributors • Acknowledgments

Motivation

Writing LaTeX documents often requires including numerous academic references. Manually searching for and formatting BibTeX entries can be time-consuming. Overleaf-Bib-Helper streamlines this process by integrating search functionality from DBLP and Google Scholar right into the Overleaf interface, allowing users to quickly find and copy BibTeX entries with minimal effort.

Features

• Search for academic articles from DBLP or Google Scholar within Overleaf.
• Retrieve and copy BibTeX entries with a single click.
• Configurable result counts (5, 10, 20, or 50 results).
• Scrollable results list for easy browsing.
• Keyboard shortcuts: Enter to search, Esc to close the popup.
• Supports multiple Google Scholar mirrors for accessibility.

Changelog

• 2025-04-14: Added support for advanced search options in Google Scholar (v1.3).
• 2025-04-10: Added support for cn.overleaf.com and cn.overleaf.com domains (v1.2).
• 2025-04-09: Initial release with basic functionality for DBLP and Google Scholar (v1.1).

Installation

Step 1: Install Tampermonkey

Tampermonkey is a browser extension required to run UserScripts like Overleaf-Bib-Helper. Follow these steps:

1. Download Tampermonkey:
   • Chrome: Chrome Web Store
   • Firefox: Mozilla Add-ons
   • Edge: Microsoft Edge Add-ons
   • Safari: App Store (requires macOS)
2. Enable Tampermonkey:
   • After installation, click the Tampermonkey icon in your browser’s toolbar and ensure it’s enabled.
   • Note:
3. Enable Developer Mode for the Extension:
   • For Chrome, go to the extensions page (chrome://extensions/) and enable Developer mode.

Step 2: Install Overleaf-Bib-Helper

You can install the script in one of two ways:

Option 1: Install from Greasy Fork (Recommended)

1. Visit the Greasy Fork page.
2. Click the "Install this script" button.
3. Tampermonkey will open a confirmation window. Click "Install" to add the script.
4. The script will automatically activate on Overleaf project pages (https://www.overleaf.com/project/*).
5. To keep the script updated, enable auto-updates in Tampermonkey settings.

Option 2: Install from GitHub

1. Go to the GitHub repository.
2. Open the Overleaf-Bib-Helper.js file in the repository.
3. Copy the entire script content.
4. In your browser, click the Tampermonkey icon > "Create a new script".
5. Paste the copied code into the editor, replacing the default template.
6. Click File > Save in the Tampermonkey editor.
7. The script will be active on Overleaf project pages.
8. Note: For manual installations from GitHub, please check the repository periodically for updates and reinstall as needed.

Usage

Opening the Tool

1. Open an Overleaf project in your browser (https://www.overleaf.com/project/*).
2. Look for a new icon in the Overleaf toolbar (a small document-like icon).
3. Click the icon to open the search popup.

Searching for Articles

1. Enter a Query: Type your search term (e.g., article title, author, or keywords) into the input field.
2. Select Source: Choose "DBLP" or "Google Scholar" from the "Source" dropdown.
   • DBLP: Best for computer science literature with structured data.
   • Google Scholar: Broader coverage across various fields but may require CAPTCHA verification.
3. Set Result Count: Select 5, 10, 20, or 50 results from the "Results" dropdown.
4. Start Search:
   • Press the Enter key or click the magnifying glass icon.
5. Results will appear in a scrollable list below the input field.

Copying BibTeX

1. Click on any result in the list (e.g., "Title@Author").
2. The BibTeX entry will be copied to your clipboard.
3. A notification will confirm success ("Copy successfully") or report an error ("Copy failed").

Closing the Popup

• Press Esc or click the toolbar icon again.

Supported Sources

• DBLP: A comprehensive computer science bibliography providing reliable BibTeX entries.
• Google Scholar: A broader academic search engine that may include more recent or interdisciplinary works but might require user verification (e.g., CAPTCHA).

Troubleshooting

• Script Not Working?
  • Ensure your browser has developer mode enabled for extensions.
  • Ensure Tampermonkey is enabled and the script is active.
  • Verify you’re on an Overleaf project page.
  • Reload or reinstall from Greasy Fork.
• No Results?
  • Check your query for typos.
  • Ensure you have granted the plugin search permissions.
  • Try switching between DBLP and Google Scholar.
• Google Scholar Issues?
  • If CAPTCHA blocks access, complete it in the opened tab and retry.

Disclaimer

While Overleaf-Bib-Helper aims to provide a seamless experience, please note that it relies on external services (DBLP and Google Scholar) which may change their APIs or require user verification (e.g., CAPTCHA). Use this tool at your own discretion and always verify retrieved BibTeX entries before including them in your documents.

License

This project is licensed under the MIT License - see LICENSE.md for details.

Contributing

Feel free to fork the GitHub repository, submit issues, or create pull requests with improvements!

Contact

Please email Xunjian Yin or create Github issues here if you have any questions or suggestions.

Organizers

Contributors

Acknowledgments

Inspired by similar tools and the academic community’s need for efficient reference management.