-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
ankiweb_page.html
53 lines (39 loc) · 6 KB
/
ankiweb_page.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
This add-on allows you to import <a href="https://en.wikipedia.org/wiki/ZIM_(file_format)">ZIM</a> files and access their data inside Anki. The main focus of the add-on is to support extracting information such word definitions, example sentences, pronunciation, etc. from the Wiktionary ZIM files and add them to notes.
This is a fork of the <a href="https://github.com/abdnh/anki-wiktionary">Wiktionary</a> add-on. The plan was to add ZIM support to the Wiktionary add-on in addition to the original support for Kaikki files, but I got some ideas to extend the add-on with ZIM-specific additions like a pop-up dictionary and a local server that can be accessed from other add-ons, so I decided to split it into a new add-on to keep the Wiktionary add-on simple.
<b>Supported dictionaries</b>
Currently supported Wiktionary versions are the following:
<ul><li>Greek</li><li>Spanish</li><li>German</li><li>Turkish</li></ul>
We try to support the ZIM files provided by the <a href="https://www.kiwix.org/">Kiwix</a> team at https://wiki.kiwix.org/wiki/Content_in_all_languages
If you want to see support for your language, you can open a feature request in the <a href="https://github.com/abdnh/anki-zim-reader/issues">issue tracker</a>. If you're a developer and want to contribute, please see <a href="https://github.com/abdnh/anki-zim-reader/blob/master/development.md">development.md</a>.
<b>Usage</b>
<b>Importing a ZIM file</b>
The dialog under <i>Tools > ZIM Reader > Import a file</i> allows you to import a new ZIM file and make it available for use in the add-on. <a href="https://library.kiwix.org/">The Kiwix library</a> has a lot of ZIM files available for download.
<img src="https://raw.githubusercontent.com/abdnh/anki-zim-reader/master/images/import_dialog.png" width="600"/>
<b>Filling in notes</b>
The add-on provides an interface to fill existing notes with defintions, example sentences, etc. from imported files. The interface can either be accessed from a button in the editor, or via the <i>Edit > Bulk-define from ZIM file</i> menu item in the browser for bulk operations on selected notes. You can also configure shortcuts from <i>Tools > Add-ons</i>.
<img src="https://raw.githubusercontent.com/abdnh/anki-zim-reader/master/images/dialog.png" width="600"/>
Explanation of some options:
<ul><li><b>File</b>: The imported ZIM file you want to extract info from.</li><li><b>Parser</b>: For the add-on to understand how to extract data from the chosen file, you need to tell it what "parser" it should use to do that. Only a limited number of ZIM files for a couple of languages currently have parsers.</li><li><b>Word</b>: The field where the word you want to query exists.</li><li>The other options decide to which field each kind of supported info goes.</li></ul>
<b>Pop-up dictionary</b>
There is also a feature to look up words in the reviewing screen in imported ZIM files. Unlike the "fill-in" feature, this should work on any imported ZIM file without the need for a special parser. If you select any word and press "Alt+Shift+S", a pop-up should be shown with the page of the selected word if found. You can configure the ZIM file used for the pop-up feature and some other settings from the <a href="https://github.com/abdnh/anki-zim-reader/blob/master/#settings">Settings</a> dialog.
<img src="https://raw.githubusercontent.com/abdnh/anki-zim-reader/master/images/popup.png" width="600"/>
<b>Settings</b>
You can configure some settings of the add-on from <i>Tools > ZIM Reader > Settings</i>. Currently only the pop-up dictionary's settings are configurable here. For the parser option, if your chosen dictionary file doesn't have a dedicated parser, you can simply choose the "Default" parser. Parsers here are currently only useful to convert a word to its base form and search for that instead using language-specific rules if the exact word doesn't have a page in the dictionary.
<img src="https://raw.githubusercontent.com/abdnh/anki-zim-reader/master/images/settings.png" width="600"/>
<b>Browser</b>
You can browse the contents of imported ZIM files from the window under <i>Tools > ZIM Reader > Browser</i>.
<img src="https://raw.githubusercontent.com/abdnh/anki-zim-reader/master/images/browser.png" width="600">
<b>Changelog</b>
See <a href="https://github.com/abdnh/anki-zim-reader/blob/master/CHANGELOG.md">CHANGELOG.md</a> for a list of changes.
<b>License</b>
GPLv3 or later. See <a href="https://github.com/abdnh/anki-zim-reader/blob/master/LICENSE">LICENSE</a>.
<b>Credit</b>
<ul><li>The logo is adapted from the <a href="https://en.wikipedia.org/wiki/File:Kiwix_logo_v3.svg">Kiwix logo</a> (licensed under the <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">CC BY-SA 4.0</a>) and the Anki logo from the <a href="https://github.com/PapirusDevelopmentTeam/papirus-icon-theme">Papirus icon theme</a> (licensed under the <a href="https://github.com/PapirusDevelopmentTeam/papirus-icon-theme/blob/master/LICENSE">GPLv3</a>).</li></ul>
<b>Support & feature requests</b>
Please post any questions, bug reports, or feature requests in the <a href="https://forums.ankiweb.net/t/zim-reader-for-anki/23669">support page</a> or the <a href="https://github.com/abdnh/anki-zim-reader/issues">issue tracker</a>.
If you want priority support for your feature/help request, I'm available for hire. You can get in touch from the aforementioned pages, via <a href="mailto:abdo@abdnh.net">email</a> or on <a href="https://www.fiverr.com/abd_nh">Fiverr</a>.
<b>Support me</b>
Consider supporting me if you like my work:
<a href="https://github.com/sponsors/abdnh"><img height='36' src="https://i.imgur.com/dAgtzcC.png"></a><a href="https://www.patreon.com/abdnh"><img height='36' src="https://i.imgur.com/mZBGpZ1.png"></a><a href='https://ko-fi.com/abdnh'><img height='36' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
I'm also available for freelance add-on development on Fiverr:
<a href="https://www.fiverr.com/abd_nh/develop-an-anki-addon"><img height='36' src="https://i.imgur.com/0meG4dk.png"></a>