Quick Abstract

A Firefox extension that generates a professional abstract and keywords for the current tab's content using the Perplexity AI API.

Features

• Fetches the text content of the active tab
• Sends the content to the Perplexity API for abstract and keyword generation
• Displays the generated abstract and keywords in the extension popup
• Generates an APA citation for the webpage based on the title, author, and publication date
• Allows copying the generated abstract, keywords, and citation in Markdown, HTML, or plain text format with the click of a button
• Allows customization of API key, model, and temperature through the options page.
• Supports internationalization (i18n) for English, Spanish, and French languages.
• Allows fine-tuning the abstract generation by adjusting the top-p, top-k, max-tokens, frequency-penalty, and presence-penalty parameters.

Installation from repository

Installation from XPI file (direct download)

Install the latest version of this add-on by clicking the link below, or you can download the latest version from the releases page.

Installation from source code (manual)

1. Clone this repository or download the source code
2. Open Firefox and go to about:debugging
3. Click on "This Firefox" in the left sidebar
4. Click on the "Load Temporary Add-on" button
5. Navigate to the directory where you cloned/downloaded the source code and select the manifest.json file
6. The extension should now be loaded and visible in your extensions list

Usage

1. Navigate to a web page you want to generate an abstract for
2. Click on the extension icon in the Firefox toolbar
3. Click the "Resume" button in the popup to fetch the page content and send it to the Perplexity API
4. The generated abstract, keywords, and APA citation will be displayed in the popup textarea
5. Click on the "Copy Markdown", "Copy HTML", or "Copy Text" button to copy the generated content in the desired format
6. To change settings like your API key, model, or temperature, click the "Settings" button to open the options page

Configuration

The extension uses the following default configuration:

• API Key: 'pplx-xxxxxxxxxxx' (replace with your own or it won't work)
• Model: 'sonar-medium-chat'
• Temperature: 1
• All other parameters are undefined by default.
• Please take account that top-k can't be defined at the same time as top-p, and vice versa.
• Same with presence-penalty and frequency-penalty.

You can change these settings on the options page.

TODO

• ✅ Add support for internationalization (i18n)
• ✅ Add support for generating abstracts from selected text on the page
• ✅ Add support for generating keywords from the content
• ✅ Add support for generating APA citations for the page
• ✅ Add support for copying the generated abstract, keywords, and citation in different formats
• ✅ Write a suitable CONTRIBUTING.md file for the project 😉
• ✅ Add a tab for About and Credits
• 🚧 Improve the UI/UX of the extension popup and options page
• 🚧 Add more customization options and features
• 🔜 Recover and save last abstract and keywords generated for a given page
• 🔜 Add support to export lists of abstracts and keywords to clipboard
• 🔜 Add support to write the abstract and keywords to a new tab
• 🔜 Add support for generating abstracts from multiple tabs at once
• 🔜 Add support for more API models and parameters
• 🔜 Add more languages to the supported locales
• 🔜 Improve error handling and user feedback

Main structure

quick-abstract/
│
├── icons/
│   ├── icon-16.png
│   ├── icon-32.png
│   ├── icon-48.png
│   ├── icon-64.png
│   ├── icon-96.png
│   ├── icon-128.png
│   └── icon.png
│
├── _locales/
│   ├── en/
│   │   └── messages.json
│   ├── es/
│   │   └── messages.json
│   └── fr/
│       └── messages.json
│
├── lib/
│   └── purify.min.js
│
├── background/
│   └── background.js
│
├── options/
│   ├── options.html
│   ├── options.js
│   └── options.css
│
├── popup/
│   ├── extension.html
│   ├── extension.js
│   └── popup.js
│
├── style/
│   └── style.css
│
├── CONTRIBUTING.md
├── LICENSE
├── manifest.json
└── README.md

Files

• manifest.json: The extension manifest file defining metadata, permissions, and scripts
• LICENSE: License file for the project
• README.md: Readme file with information about the extension
• CONTRIBUTING.md: Contributing guidelines for the project
• popup/extension.html: The HTML structure for the extension popup
• popup/extension.js: JavaScript for handling tabs interactions
• popup/popup.js: JavaScript handling popup interactions and API calls
• background/background.js: Background script for handling API requests and responses
• options/options.html: Options page for configuring API key, model, and temperature
• options/options.js: JavaScript for handling options page interactions and storage
• options/options.css: Stylesheet for the options page
• style/style.css: Stylesheet for the extension
• icons/: Directory containing the extension icons in various sizes
• _locales/: Directory containing language-specific message files
• lib/: Directory containing third-party libraries used in the extension (DOMPurify by now)

Dependencies

This extension relies on the Perplexity AI API. You need to sign up for an API key at https://www.perplexity.ai/ to use this extension. You can read the API documentation here.

Internationalization (i18n)

This extension now supports internationalization, allowing users to interact with it in their preferred language. The following languages are currently supported:

• English (default)
• Spanish
• French

To add support for more languages, follow the steps outlined in the "Adding New Languages" section below.

Language Files

The language-specific message files are located in the _locales directory, organized by locale code. Each locale directory contains a messages.json file that defines the localized strings for that language.

Example:

• _locales/en/messages.json: English messages
• _locales/es/messages.json: Spanish messages
• _locales/fr/messages.json: French messages

Using Localized Strings

The extension uses the browser.i18n API to retrieve localized strings in the JavaScript code. The getMessage() function is used to get the localized string for a given message ID.

Example:

const localizedString = browser.i18n.getMessage('messageId');

To use localized strings in HTML files, you can use the MSG_messageId syntax in the HTML attributes or content. Example:

<button title="__MSG_buttonTitle__">Click me</button>

Adding New Languages

To add support for a new language, follow these steps:

1. Create a new directory in the _locales directory with the locale code of the language (e.g., 'de' for German).
2. Create a messages.json file inside the new locale directory.
3. Add the localized strings for the new language in the messages.json file, following the same format as the existing language files.
4. Update the list of supported languages in the README.md file.

With the i18n support, the Perplexity Abstract Creator extension can now reach a wider audience and provide a localized user experience.

License

This project is open-source and available under the MIT License. Feel free to use, modify, and distribute the code as you see fit.

Thanks to

• Perplexity AI for providing the AI API used in this extension.
• Mozilla for the extensive documentation and resources on developing Firefox extensions.
• DOMPurify by @Cure53 for the HTML sanitization library used in the extension.