{"id":21536625,"url":"https://github.com/abdnh/anki-zim-reader","last_synced_at":"2025-06-26T07:31:59.098Z","repository":{"id":59433209,"uuid":"537264508","full_name":"abdnh/anki-zim-reader","owner":"abdnh","description":"Anki add-on to view and extract info from ZIM files","archived":false,"fork":false,"pushed_at":"2024-03-20T17:09:49.000Z","size":1045,"stargazers_count":9,"open_issues_count":8,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T01:59:30.173Z","etag":null,"topics":["anki","anki-addon","dictionary","kiwix","wiktionary","wiktionary-data","zim"],"latest_commit_sha":null,"homepage":"https://ankiweb.net/shared/info/951350249","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abdnh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"abdnh","patreon":"abdnh","ko_fi":"abdnh"}},"created_at":"2022-09-16T01:32:20.000Z","updated_at":"2024-12-29T19:58:57.000Z","dependencies_parsed_at":"2025-04-10T01:52:07.142Z","dependency_job_id":"de30d08e-0491-45a1-b957-9c8801f13531","html_url":"https://github.com/abdnh/anki-zim-reader","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/abdnh/anki-zim-reader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abdnh%2Fanki-zim-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abdnh%2Fanki-zim-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abdnh%2Fanki-zim-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abdnh%2Fanki-zim-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abdnh","download_url":"https://codeload.github.com/abdnh/anki-zim-reader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abdnh%2Fanki-zim-reader/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262022394,"owners_count":23246306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["anki","anki-addon","dictionary","kiwix","wiktionary","wiktionary-data","zim"],"created_at":"2024-11-24T03:20:26.879Z","updated_at":"2025-06-26T07:31:59.078Z","avatar_url":"https://github.com/abdnh.png","language":"Python","funding_links":["https://github.com/sponsors/abdnh","https://patreon.com/abdnh","https://ko-fi.com/abdnh","https://www.patreon.com/abdnh","https://ko-fi.com/abdnh'"],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"./src/icons/logo.svg\" width=\"250\"\u003e\n\nAnki add-on that allows you to import [ZIM](\u003chttps://en.wikipedia.org/wiki/ZIM_(file_format)\u003e) files\nand 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.\n\nThis is a fork of the [Wiktionary](https://github.com/abdnh/anki-wiktionary) 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.\n\n## Supported dictionaries\n\nCurrently supported Wiktionary versions are the following:\n\n- Greek\n- Spanish\n- German\n- Turkish\n\nWe try to support the ZIM files provided by the [Kiwix](https://www.kiwix.org/) team at https://wiki.kiwix.org/wiki/Content_in_all_languages\n\nIf you want to see support for your language, you can open a feature request in the [issue tracker](https://github.com/abdnh/anki-zim-reader/issues).\nIf you're a developer and want to contribute, please see [development.md](./development.md).\n\n## Usage\n\n### Importing a ZIM file\n\nThe dialog under _Tools \u003e ZIM Reader \u003e Import a file_ allows you to import a new ZIM file and make it available for use in the add-on. [The Kiwix library](https://library.kiwix.org/) has a lot of ZIM files available for download.\n\n\u003cimg src=\"./images/import_dialog.png\" width=\"600\"\u003e\n\n### Filling in notes\n\nThe add-on provides an interface to fill existing notes with defintions, example sentences, etc. from imported files.\nThe interface can either be accessed from a button in the editor, or via the _Edit \u003e Bulk-define from ZIM file_ menu\nitem in the browser for bulk operations on selected notes. You can also configure shortcuts from _Tools \u003e Add-ons_.\n\n\u003cimg src=\"./images/dialog.png\" width=\"600\"\u003e\n\nExplanation of some options:\n\n- **File**: The imported ZIM file you want to extract info from.\n- **Parser**: 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.\n- **Word**: The field where the word you want to query exists.\n- The other options decide to which field each kind of supported info goes.\n\n### Pop-up dictionary\n\nThere is also a feature to look up words in the reviewing screen in imported ZIM files.\nUnlike the \"fill-in\" feature, this should work on any imported ZIM file without the need for a special parser.\nIf you select any word and press \"Alt+Shift+S\", a pop-up should be shown with the page of the selected word if found.\nYou can configure the ZIM file used for the pop-up feature and some other settings from the [Settings](#settings) dialog.\n\n\u003cimg src=\"./images/popup.png\" width=\"600\"\u003e\n\n### Browser\n\nYou can browse the contents of imported ZIM files from the window under _Tools \u003e ZIM Reader \u003e Browser_.\n\n\u003cimg src=\"./images/browser.png\" width=\"600\"\u003e\n\n### Settings\n\nYou can configure some settings of the add-on from _Tools \u003e ZIM Reader \u003e Settings_.\nCurrently only the pop-up dictionary's settings are configurable here.\nFor 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.\n\n\u003cimg src=\"./images/settings.png\" width=\"600\"\u003e\n\n## Download\n\nYou can download the add-on from AnkiWeb: https://ankiweb.net/shared/info/951350249\n\n## Development\n\nSee [development.md](./development.md) for docs that only interest developers and contributors.\n\n## Changelog\n\nSee [CHANGELOG.md](./CHANGELOG.md) for a list of changes.\n\n## License\n\nGPLv3 or later. See [LICENSE](./LICENSE).\n\n## Credit\n\n- The logo is adapted from the [Kiwix logo](https://en.wikipedia.org/wiki/File:Kiwix_logo_v3.svg) (licensed under the [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en)) and the Anki logo from the [Papirus icon theme](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme) (licensed under the [GPLv3](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme/blob/master/LICENSE)).\n- Some icons are adapted from [Bootstrap Icons](https://icons.getbootstrap.com/) (licensed under the [MIT](https://github.com/twbs/icons/blob/main/LICENSE.md)).\n\n## Support \u0026 feature requests\n\nPlease post any questions, bug reports, or feature requests in the [support page](https://forums.ankiweb.net/t/zim-reader-for-anki/23669) or the [issue tracker](https://github.com/abdnh/anki-zim-reader/issues).\n\nIf you want priority support for your feature/help request, I'm available for hire.\nYou can get in touch from the aforementioned pages, via [email](mailto:abdo@abdnh.net) or on [Fiverr](https://www.fiverr.com/abd_nh).\n\n## Support me\n\nConsider supporting me if you like my work:\n\n\u003ca href=\"https://github.com/sponsors/abdnh\"\u003e\u003cimg height='36' src=\"https://i.imgur.com/dAgtzcC.png\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.patreon.com/abdnh\"\u003e\u003cimg height='36' src=\"https://i.imgur.com/mZBGpZ1.png\"\u003e\u003c/a\u003e\n\u003ca href='https://ko-fi.com/abdnh'\u003e\u003cimg height='36' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /\u003e\u003c/a\u003e\n\nI'm also available for freelance add-on development on Fiverr:\n\n\u003ca href=\"https://www.fiverr.com/abd_nh/develop-an-anki-addon\"\u003e\u003cimg height='36' src=\"https://i.imgur.com/0meG4dk.png\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabdnh%2Fanki-zim-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabdnh%2Fanki-zim-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabdnh%2Fanki-zim-reader/lists"}