KoHighlights

KoHighlights is a utility for viewing Koreader's highlights and/or export them to simple text, html, csv or markdown files.
Visit it's page at GitHub.


Download the latest version

Get KoHighlights v2.0.2.0 setup.exe, use it and if you like it, consider to

PayPal Button

Download Button Download Button


Usage / Features:

  • Load items by:
    • Selecting the reader's drive or any folder that contains books that where opened with Koreader.
      This will automatically load all the metadata files from all subdirectories.
    • Drag and drop files or folders.
      This will load the files and/or all the files inside the folders.
  • Export the highlights of the selected books to individual files or to one merged file.
  • Supported formats for exporting:
    • Plain text files (.txt)
    • Hypertext document files (.html)
    • Comma-separated values files (.csv)
    • Markdown files (.md)
  • View the highlights and various info for a book by selecting it in the list.
  • Save the highlights to the "Archive" database and view them, even if your reader is not connected.
  • Merge highlights from the same book that is read in different devices and/or sync its reading position.
  • Merge highlights/Sync position of a book with its archived version.
  • Double click or press the Open Book button to view the book in your system's reader.
  • Show/hide the page, date, chapter or even the highlight (!) text while viewing or exporting the highlights of the books.
  • Delete some or all the highlights of any book.
  • Clear/reset the .sdr folders with the metadata or the books in the eReader.

...also, Compatibility-wise...

Windows XP
From version 2.x onwards, KOHighlights dropped support for Windows XP.
Windows 7
KOHighlights can't start if Microsoft Visual C++ 14.0 is not installed. Get it here.
The Windows 7 32bit version also needs the KB2533623 update thats is included in KB3063858 (direct link).



ScreenShots:


Version History:

  • 2.0.2.0
    Added:
    • Support for displaying the user edited (inside KOReader) metadata.
    • Right clicking menu in the Highlights View lets you copy any column's value.
    Changed:
    • Sync Group paths are now collapsible.
    • Some more GUI changes.
  • 2.0.0.0
    This is a major update for KOHighlights.
    • It is adding a new concept, the Sync Groups.
      Sync Groups can be used to sync reading position and merge highlights between multiple books in different devices.
      These are groups of paths to different sidecar folder contents (.sdr folders with metadata .lua files), that can be synced together and to the database.
    • There are some GUI additions, like dark/light themes and new icons.
    • Also, the app has now preliminary support for the upcoming changes to the KOReader's metadata structure.
    • Finally, there are some compatibility changes.
      Because of the transition from Python 2/PySide to Python 3/PySide2, Windows XP are no longer supported and the Installer must uninstall any previous 1.x version.
      For Linux, the supported distributions are from Ubuntu 18 and up.

    Added:
    • Sync Groups as a way to sync position/merge highlights between books on different devices.
    • Option for Dark/Light/No theme and old/new icons.
    • Support for the upcoming changes to the KOReader's metadata.
    Changed:
    • Upgrade code to Python 3, Pyside2, so no more WindowsXP and Ubuntu 16 support.
    • When merging highlights between different devices, the app tries to re-compute the page numbers, so that are not all over the place.
    • Merging highlights will now keep the latest version of their comments.
    • Better wording with fewer items for the Export menu, if only one item is selected.
    • Can now delete highlights from the Highlights view.
    • Removed the requirement for the Statistics plugin to be enabled.
    Fixed:
    • Some times there was an error when deleting a highlight.
    • Delete a highlight from the highlight list some times did not work.
    • Display wrong highlight count if more than one highlight on the same page.
  • 1.7.6.0
    Fixed:
    • Problematic PyInstaller Windows executable.
  • 1.7.5.0
    Added:
    • PySide6 support.
    Fixed:
    • "Find in Books" for a highlight was finding the book but did not select the highlight.
  • 1.7.4.0
    Fixed:
    • Some problems with relative paths in Linux.
  • 1.7.3.0
    Fixed:
    • Could not parse highlights due to changes in KOReader latest release.
  • 1.7.2.0
    Fixed:
    • This is a Windows only release that fixes the startup problem that the previous one introduced.
  • 1.7.1.0
    Added:
    • This is a Windows only release that adds a portable mode for... Windows.
      When KOHighlights runs in Portable mode, will use a portable_settings directory to store its settings, that is located inside the installation directory of the app.
      Because of this, it is advised to not install the app inside the Program Files folder if you indent to use it as portable.
      There are two ways to start the app in Portable mode:
      • Run the KoHighlights Portable.exe that is located next to the KoHighlights.exe.
      • Run KoHighlights.exe with a -p argument.
        E.g. create a shortcut for the KoHighlights.exe and add a space and a -p argument at the end of the target filename.
  • 1.7.0.0
    Added:
    • Export highlights as markdown files.
    • Chapter title is available as part of the highlight data.
    • The document path from the metadata is used to locate the book if the .sdr folder is in the "DocSettings" directory of KOReader.
    Fixed:
    • "Scan Directory" and "About" shortcuts weren't working.
  • 1.6.0.0
    Added:
    • New toolbar button "Filter" to filter the current view's items by searching for keywords in Highlights and/or Comments and/or Book titles.
    Changed:
    • Added an arrow to the "Archived" view button, to invoke a drop-down menu with actions for the Archive database (other than right-clicking on it).
    Fixed:
    • Problem when exporting highlights from books with very long filenames (GitHub issue here).
  • 1.5.0.0
    Added:
    • "Show in Highlights" menu has a new entry, "Date Format", where you can customize the appearance of the date using format codes (info here).
      This influences the way the date is formatted when the highlights are exported, and the way its presented at the "Book Info" panel.
      It is not supported in the CLI side of the app though.
    Fixed:
    • Exporting highlights to csv from "Highlights View" did not work.
    • Some display problem when the system uses a dark theme.
  • 1.4.4.0
    Added:
    • A new column with the number of comments.
    • User's review is visible in "Book Info", if one exists.
    Changed:
    • More checks are added to the highlight extraction from the metadata file.
  • 1.4.2.0
    Added:
    • Right clicking the "Archived" button produces a menu with actions for the Archive database. That way we can use a database file that is located anywhere, even on the cloud.
    Fixed:
    • Exporting without the Page numbers but sorted "By Date" hung the app.
    • Exporting highlights from multiple books to individual files produced text files that contained html code or the opposite.
  • 1.4.0.0
    Added:
    • Export highlights to csv is now supported (in GUI and CLI), using tabs as separators and double quotes ["] as text qualifiers.
    Changed:
    • Selecting the exported file type/mode is done with popup questions.
  • 1.3.0.0
    Added:
    • Option to sync/merge a loaded book with a metadata file from any location.
    • Option to recalculate (and re-save in the metadata) the MD5 for a book.
    • Option to open the selected book's metadata location with the system's file manager.
    • Keyboard shortcuts to copy selected highlights/comments.
    Changed:
    • All found "metadata.lua" files are loaded (if more than one are present in the .sdr directory).
    • When checking if two books are the same (for sync/merge), the app now uses any MD5 present in the book's metadata, and if none exists, it calculates one.
    Fixed:
    • Canceling export of highlights still opened a "Success" dialog.
    • Sometimes the modified date had decimal digits.
    • Some cosmetic bugs.
  • 1.2.2.0
    Added:
    • Option to ignore the English articles at the start of the title while sorting.
  • 1.1.0.0
    Added:
    • Option to merge highlights/sync position with the archived version (using right click on loaded book).
    • New "Rating" column.
    Changed:
    • There is an optional question dialog when adding/merging books in the archive.
    • "Abandoned" book rows now have red text.
    • Single launch App.
    • No more Linux.x86 binary (nobody used it anyways...).
    Fixed:
    • Some problems with drag&dropping books.
    • Wrong "Delete" button when in Archived mode.
    • Better Python 3 compatibility (for the .py version).
  • 1.0.0.0
    Added:
    • New Archive mode. Using a local database in which we can add/upgrade any loaded book's metadata (with the highlights of course) that we get from the reader, and access it even if the reader is not connected.
    • We can now export to html from "Highlights" view too.
    Changed:
    • The user interface has 2 modes now ("Loaded" and "Archived"). In any of these modes we can view the highlights using two views: as rows of "Books" or as rows of "Highlights".
    Fixed:
    • Could not hide Comments while viewing or exporting highlights.
    • Drag & dropping multiple folders, was loading only the last one.
  • 0.9.1.0
    Changed:
    • Code refactoring.
    Fixed:
    • Comments in highlights with more than one paragraphs could not get changed.
  • 0.9.0.0
    Added:
    • Option to export highlights in HTML format.
    • Linux binaries now support the command-line interface.
    Fixed:
    • The sorting direction (ascending-descending) sometimes was not saved.
  • 0.8.0.0
    Added:
    • Option to change the size of the toolbar buttons with right-click.
    • Linux binaries for x86/x64 with PyInstaller.
    • The Python script has now a command-line interface for batch conversions.
    Fixed:
    • The Python script can run with Python2/3.
    • Reloading the same files after clearing the book list, works now.
  • 0.7.0.0
    Added:
    • Option to sort highlights by Date or Page (in "Books" view).
  • 0.6.1.0
    Added:
    • Merging the highlights of a book that is read in two different devices is now possible (beta). It must be from the same reader engine though. Read about it here.
    • Syncing the reading position for a book that is read in two different devices is also possible now.
    • We can now edit highlight comments while in the "Highlights" view, using the right-click menu or double clicking.
    • From "Highlights" view, using the right-click menu, we can locate the current highlight to the "Books" view.
    Changed:
    • When scanning a directory using the "Scan Directory" button, the previously loaded books are not unloaded from the list.
    Fixed:
    • The same book's metadata are not loaded more than one time any more.
    • The book's description text is now read only (as it should).
  • 0.5.0.0
    Added:
    • In "Highlights" view, using the right-click menu, we can copy to clipboard the selected highlights/comments.
    Changed:
    • Added "Tags" and "Description" to the "Book Info".
    • Removed "Total time" and "Status" from the "Book Info" because the relevant keys where removed from the more current KoReader versions' metadata.
    Fixed:
    • Some highlights where missing when exported to text file.
    • Better handling of lua comments.
  • 0.4.0.0
    Added:
    • New "Highlights" view, where we can see all the highlights from the opened books and sort them by date, book etc.
    Fixed:
    • Update book info when navigating using the arrows.
  • 0.3.5.0
    Added:
    • Support for comments (kind of), using the "Edit" highlight option of KoReader (click on a highlight).
    • Edit/Add/Delete a highlight's comment.
    Fixed:
    • Deleting an "Edited" highlight could not delete the associated bookmark too.
    • New lines in the highlight are now properly displayed.
  • 0.3.4.0
    Added:
    • Delete some or all the highlights from a book.
    • Copy some or all the highlights from a book in the clipboard.
    Changed:
    • Highlights are now a list with items that can be selected individually for copy/deletion, not just a text.
    • Highlight's elements like page, date and even highlight text can be individually turned on/off.
    Fixed:
    • If there was more than one highlight in a page, only the first was displayed.
    • Right click menu appeared even if the book list was empty.
    • ... and the various smaller bugs.
  • 0.3.2.0
    Added:
    • Page & Date reference for each highlight.
    • Option to show/hide page & date info that also affects if that info is going to be written in the saved text files.
    Changed:
    • Highlights are now sorted by page number.
    Fixed:
    • Right clicking and selecting "View Book" did nothing.
    • If another file was in an '.sdr' folder (like an '.old' backup file) it could be selected instead of the normal metadata file.
    • Saved texts were displayed wrong in Windows Notepad due to unix line breaks.
    • Various small fixes.
  • 0.3.1.2
    Added:
    • New "Book Info" panel.
    • Option to delete the .sdr folders for specific books or even the books themselves.
    • Option to view a book with the system's viewer.
    • Added "Book Type" and "Read percent" columns.
    • Color-coded rows based on Finished/Completed state and the presence or not of the actual book.
  • 0.2.1.1
    Added:
    • Added a "Modified" date column.
    • Option to pass folders or files as arguments.
  • 0.2.0.1
    • Totally re-written application with new GUI.
    • New GitHub repository.
    • Initial release.