Review annotations plugin for KOReader

The following project is a KOReader plugin that allows to review the annotations in all documents or a specific document as anki-style flashcards.

The plugin was developped and tested for a jailbroken Kindle Voyage but should work on any device that support KOReader.

To understand how the SM2-based algorithm work, please read this article.

Disclaimer

Do not think of this project as a full-featured Anki replacement. It is intended as minimalist, configless, setupless and portable everywhere you can have KOReader. A tradeoff for maximum learning productivity if you have a wandering mind like mine.

KOReader is a low-distraction environment by design, as it is no more than a (very powerful) document reader, you can't doomscroll on social media or what on a e-reader, so it's a very convenient learning environment.

Features

• Review user annotations and highlights from documents using flashcards and Anki/Remnote spaced repetition algorithm

• Review all documents from history or the currently opened document in the reader

• Go to source / location in book from the card during neview

• Continue a previously interrupted review

• Set a card limit per session

• Set card priority

• Add questions to cards, to be asked before review

Requirement

• Please have an up-to-date KOReader version (stable release)

Install

From this repository

• Clone with git or download the repo. You can used both the main branch (latest stable and working version) or any commit tagged as a version number (x.x.x). It you do so, please check the changelog to see which version you want. Please do not try to use any other branch/tag.

• Please copy the .koplugin directory in the plugins directory of your KOReader installation.

From koreader/contrib

• Alternatively, this plugin should be available in the (https://github.com/koreader/contrib)[koreader-contrib] GitHub repository. Please note that this version might be slightly outdated.

• Same as previously, you can simply clone/download the repo and copy the folder to your koreader install plugins directory.

Enabling the plugin

• Enable the plugin in KOReader like any other one.

Upgrading and versioning

• Any minor and patch update (last two number of the x.x.x semver) will be retrocompatible with the previous. Majour should be as well, but please check the changelog to be sure it is the case.

How to use

You will find the menu in the « tools » KOReader menu.

From there, you can :

• Start a review session for the current document
• Start a review session for all documents (in the local KOReader history)
• Open book manager
• set limits of cards and new cards (cards never reviewed) per session
• Re-enable all disabled cards (legacy feature, I will probably remove this option later)
• Permanentely Reset review metadata (this will cleanup the metadata files data structure from all data from this plugin)

In addition, in the reader with an opened document, you can edit annotation/highlights review config from the highlight extended menu (the three dots), then selecting the Manage review option. From there you can :

• Set a question that will be added during review before showing the highlight(/note)
• Set the card priority (will change order during review)
• Disable or enable the card (disabled card will not show in review)
• Get additional infos on a card
• Navigate through highlight/annotations

During a review, each card due will be show to you, you will have then to rate your memorization of the highlight(annotation). The memorization score will determine the next time the card will be shown. In addition, from card review interface you can :

• Change card priority
• Disable the card
• Go to the source material
• Delay the review to the next session (will simply skip card from current session)
• Get additionnal infos on the card

The book manager allows you to :

• View statistics about the book annotations reviews
• Set « book priority » (news cards from this book will be reviewed for the first time before those of book with lower priority )
• Disable or enable the book

Syncing data between devices

Since review data are store in documents metadata, you can refer to any method available to sync documents between devices. I use syncthing, a free software on all my device for this purpose

Planned features

see CHANGELOG.MD

Translation

The plugin is currently available in :

• French
• English

I don't plan to support other languages but every contribution / merge request is welcomed.

Known bug

• It's currently impossible to start a review with only one card to review in a deck.

Acknowledgements

This plugin was built upon this this obsolete codebase from EyalGol, no longer fonctional. It does not contain any code belonging to the original project anymore.