https://github.com/aesarab/contextual-wiktionary

A fork of Lynn's context-menu-wiktionary.
https://github.com/aesarab/contextual-wiktionary

dictionary firefox-extension wiktionary-api

Last synced: about 1 month ago
JSON representation

A fork of Lynn's context-menu-wiktionary.

• Host: GitHub
• URL: https://github.com/aesarab/contextual-wiktionary
• Owner: AesaraB
• License: unlicense
• Created: 2021-04-21T10:32:06.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-17T09:49:35.000Z (about 1 year ago)
• Last Synced: 2024-11-08T04:42:42.501Z (3 months ago)
• Topics: dictionary, firefox-extension, wiktionary-api
• Language: HTML
• Homepage: https://addons.mozilla.org/en-US/firefox/addon/opendictionary/
• Size: 624 KB
• Stars: 12
• Watchers: 3
• Forks: 3
• Open Issues: 14
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [Contextual Wiktionary](https://addons.mozilla.org/en-US/firefox/addon/opendictionary/)

Contextual Wiktionary is a Firefox web-extension that enables the user to search Wiktionary with the context menu or a pop-up. The Contextual Wiktionary extension uses the Unlicense license.

## Features

* Select a word and use the context-menu to search, or just use the add-on's search bar.

* Use and contribute to the world's largest open dictionary.

* Seamlessly tangent through definitions with embedded links and a search bar that lets you quickly learn what you're looking for.

* A self-contained design avoids build-up of tabs, though an external link button lets you view definitions in a new tab.

* View English definitions for non-English words.

* *Minimal* support for non-English Wiktionaries (due to API limitations).

* Themed for both light and dark modes\*, the add-on is designed to integrate\*\* easily with Firefox' design.

*\*updated Firefox Proton designs coming soon (Proton design specifications have yet to be released to my knowledge, but a Proton-like dark imitation theme is featured in the add-on).

\*\*due to API limitations, only the English Wiktionary is themed.*

# Requirements

This extension requires Firefox 57.

# Permissions

* *Context menus*

* *Wiktionary API [https://en.wiktionary.org/api/rest_v1/page/definition/\*](https://en.wiktionary.org/api/)*

* *Storage (for setting configuration)*

* *Scripting (only if using keyboard shortcuts)*

* *Active Tab (only if using keyboard shortcuts)*

# Debugging the Extension

To debug Right Click Wiktionary:

1. Clone this repository

2. Init submodules with `git submodule update --init`

3. Run `/src/resources/stylesheet/sassBuild.sh` (need [sass]https://sass-lang.com) installed)

4. Head to `about:debugging`

5. Load the manifest.json as temporary addon.

# Acknowledgements

* This add-on was forked from [Losnappa's Right Click Wiktionary](https://gitlab.com/losnappas/Context-menu-Wiktionary/).

* Neither myself, nor Losnappas are officially affiliated with Wiktionary, or the Wikimedia Foundation in any way.

* If you like the work done on this add-on, [please consider supporting a charity](https://www.thetrevorproject.org).