Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/glutanimate/popup-dictionary

Pop-up Dictionary Add-on for Anki
https://github.com/glutanimate/popup-dictionary

anki anki-addon

Last synced: 5 days ago
JSON representation

Pop-up Dictionary Add-on for Anki

Awesome Lists containing this project

README 

        



Pop-up Dictionary for Anki























> Connecting the flashcard-dots



This is an add-on for the spaced-repetition flashcard app [Anki](https://apps.ankiweb.net/). It provides the ability to quickly draw up related facts on words or phrases, just by double-clicking on them.



### Table of Contents 



- [Installation](#installation)

- [Documentation](#documentation)

- [Building](#building)

- [Contributing](#contributing)

- [License and Credits](#license-and-credits)



### Installation



#### AnkiWeb 



The easiest way to install Pop-up Dictionary is through [AnkiWeb](https://ankiweb.net/shared/info/153625306).



#### Manual installation 



Click here to see the instructions



1. Make sure you have the [latest version](https://apps.ankiweb.net/#download) of Anki 2.1 installed.

2. Download the latest `.ankiaddon` package from the [releases tab](https://github.com/glutanimate/popup-dictionary/releases) (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



### Documentation



For further information on the use of this add-on please check out [the description text](docs/description.md) for AnkiWeb.



### Building



With [Anki add-on builder](https://github.com/glutanimate/anki-addon-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](https://github.com/glutanimate/anki-addon-builder/#usage).



### Contributing



Contributions are welcome! Please review the [contribution guidelines](./CONTRIBUTING.md) on how to:



- Report issues

- File pull requests

- Support the project as a non-developer



### License and Credits



*Pop-up Dictionary* is *Copyright © 2018-2021 [Aristotelis P.](https://glutanimate.com/) (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 (v3.0.3), (c) 2011-2018 Craig Michael Thompson, licensed under the MIT license

- jQuery.highlight, (c) 2007-2014 Johann Burkard, licensed under the MIT license

- jQuery Migrate, (c) OpenJS Foundation and other contributors, https://openjsf.org/, 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](https://github.com/glutanimate/popup-dictionary/blob/master/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 ❤️ !