Pop-up Dictionary for Anki

Connecting the flashcard-dots

This is an add-on for the spaced-repetition flashcard app Anki. It provides the ability to quickly draw up related facts on words or phrases, just by double-clicking on them.

Table of Contents

• Installation
• Documentation
• Building
• Contributing
• License and Credits

Installation

AnkiWeb

The easiest way to install Pop-up Dictionary is through AnkiWeb.

Manual installation

Please click on the entry corresponding to your Anki version:

Anki 2.14+

(using this method, you are installing a development version of the popup-dictionary addon - not a released version. Follow this instruction at your own risk)

1. download this repository git clone [url] in terminal OR download and extract .zip from github
2. open anki21's addon folder. On a mac it's located at /Users/[user]/Library/Application\ Support/Anki2/addons21. You can also go to addons, choose one, click view files, and then go up one level to find it on your machine.
3. go to /path/to/popup-dictionary/src
4. drag or copy the popup-dictionary folder contained inside src to Anki's addons21 folder

Anki 2.1

1. Make sure you have the latest version of Anki 2.1 installed. Earlier releases (e.g. found in various Linux distros) do not support .ankiaddon packages.
2. Download the latest .ankiaddon package from the releases tab (you might need to click on Assets below the description to reveal the download links)
3. From Anki's main window, head to Tools → Add-ons
4. Drag-and-drop the .ankiaddon package onto the add-ons list
5. Restart Anki

Anki 2.0

1. Go to Tools → Add-ons → Open add-ons folder
2. Find and delete the Pop-up Dictionary.py file if it already exists.
3. See if you can find a popup_dictionary folder. If so:
   1. If the folder contains a meta.json file, copy the file to a safe location. This will allow you to preserve your current settings.
   2. Proceed to delete the popup_dictionary folder
4. Download and extract the latest Anki 2.0 add-on release from the releases tab (you might need to click on Assets below the description to reveal the download links)
5. Move the extracted Pop-up Dictionary.py and popup_dictionary into the add-ons folder
6. Optional: Place the meta.json file back into the directory if you created a copy beforehand.
7. Restart Anki

Documentation

For further information on the use of this add-on please check out the description text for AnkiWeb.

Building

With Anki add-on builder installed:

git clone https://github.com/glutanimate/popup-dictionary.git
cd popup-dictionary
aab build

For more information on the build process please refer to aab's documentation.

Contributing

Contributions are welcome! Please review the contribution guidelines on how to:

• Report issues
• File pull requests
• Support the project as a non-developer

License and Credits

Pop-up Dictionary is Copyright © 2018-2019 Aristotelis P. (Glutanimate)

My work on the initial version of this add-on was partially funded by two fellow Anki users. I would like to thank both of them for their help.

Ships with the following javascript libraries:

• jQuery (v1.12.4), (c) jQuery Foundation, licensed under the MIT license
• qTip2 (v2.1.1), (c) 2011-2018 Craig Michael Thompson, licensed under the MIT license
• jQuery.highlight, (c) 2007-2014 Johann Burkard, licensed under the MIT license

Pop-up Dictionary is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the LICENSE file that accompanied this program.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

---

The continued development of this add-on is made possible
thanks to my Patreon and Ko-Fi supporters.
You guys rock ❤️ !