koreader/koreader

This release debuts the new KOReader logo, courtesy of @AliLozano. We're very happy with it!

MuPDF has been updated to version 1.13, which means there is now basic support for tables in EPUB in that rendering engine.

We'd like to thank all contributors for their efforts. Some highlights include:

• Various AppImage improvements (#3868, #3884, #3892, #3893) @Frenzie
• README: add new logo and links from koreader.rocks homepage (#3881) @Frenzie
• [chore] A round of Kobo specific script cleanup (#3876) @NiLuJe
• [fix, spec] Stop the kobo_touch_probe test from causing problems for other tests. (#3877) @edorfaus
• [spec] Replace custom assert[Not]AlmostEquals with assert.is[_not].near (#3885) @edorfaus
• Wiki saved as EPUB: stylesheet fix (#3894) @poire-z
• cre hyphenation: allow for setting min left/right fragment length (#3890) @poire-z
• Fix the bug where "Press" key does not open config menu on Kindle 4 NT (#3898) @insraq
• [fix] tar args order & Kobo IR grid regression (#3895) @NiLuJe
• Update OTA mirrors (#3901) @NiLuJe
• [Menusorter] Ignore warning for the plus_menu. (#3903) @onde2rock
• ImageViewer: allow viewing a list of images @poire-z
• Many crengine fixes @poire-z
• [CI] Add a check to detect tab in lua files (#3919) @onde2rock
• bump base for MuPDF 1.13.0 (#3927) Thanks very much to @TnS-hun
• CloudStorage: Allow use reserved characters in FTP username and FTP password (#3924) @robert00s
• Add HTML widget in GoodReads review (#3929) @robert00s
• Close filemanger after open last document (#3933) @robert00s
• Another round of Kobo Fixes (#3939) @NiLuJe
• Font menu: add symbols for default and fallback fonts (#3941) @poire-z
• Style tweaks: use css snippets to tweak book styles (#3944) @poire-z
• End of document action (#3943) @robert00s
• [feat] Integrated Dropbear SSH server (#3842) @onde2rock
• Re-order typeset menu (#3946) @poire-z
• [chore] Make the binary fonts a submodule (#3951) @Frenzie
• [chore] Default to shallow clone of binary submodules where history is seldom relevant (#3951) @Frenzie
• Update Google Fonts (#3942) @NiLuJe
• A round of Kindle fixes (#3955) @NiLuJe
• Try to inhibit USBMS on Kindles (#3957) @NiLuJe
• Show current and default values in config dialog (epub) (#3952) @robert00s
• [UX] Notification are displayed too short (#3962) @robert00s
• [feat] Add default to the last value used in ReadTimer (#3963) @robert00s
• Always close filemanger before open document (#3935) @robert00s
• bump crengine: LI and CITE fixes are now the defaults (#3976) @poire-z
• TouchMenu: added hook to show help text on long-press (#3980) @poire-z
• Show current and default values in config dialog (pdf) (#3973) @robert00s
• Screen refresh between chapters (#3989) @robert00s
• Fix sort-by-last-read when partition is mounted noatime (#3990) @alethiophile
• bump crengine: HTML and rendering fixes (#3992) @poire-z
• UI Behavior tweaks (#3983) @NiLuJe

Full changelog

This is mainly an AppImage bug fix release. Due to an oversight in the build process the AppImage was incompatible with older CPUs (#3867).

We'd like to thank all contributors for their efforts. Some highlights include:

• [fix] Add Categories= key to koreader.desktop (#3854) @probonopd
• Wikipedia Save as EPUB: various encoding fixes (#3851) @poire-z
• [chore] setupkoenv: output some info about library loading (#3857, #3859, #3860) @Frenzie
• ReaderBack: allow for disabling back history (#3862) @poire-z
• NewsDownloader: add date time to filename (#3863) @mwoz123
• [fix] AppImage: use $XDG_DOCUMENTS_DIR if available (#3865) @Frenzie
• [fix] AppImage advanced settings location (#3866) @Frenzie

Full changelog

This release significantly improves usability on non-touch devices thanks to @onde2rock. @dengste dotted the i's and crossed the t's of natural light support by implementing an automatic setting for warmth. KOReader now also supports the Pocketbook Inkpad 3 (PB740). Last but not least, this release debuts an AppImage for Linux desktop computers.

Besides the emboldened introduction, there's been a small change with big consequences. KOReader will now start in CoverBrowser view by default (#3834). If you want to change to a different view, choose the file browser menu (top left) → Display mode → Classic/Mosaic/Detailed.

Automatic warmth

NB Only the Kobo Aura One and the Kobo H2Ov2 support warmth. The new automatic warmth settings look like this:

So what is this “AppImage”?

Simply put, it's a portable app for Linux, which has been a long-standing request (#1417). After you download the file, you'll first need to allow it to run as a program. You can do so by right clicking in your file manager, choosing Properties → Permissions and checking the box that reads Allow this file to run as a program or something equivalent. If you prefer to use the terminal, run chmod +x koreader-appimage-x86_64-linux-gnu-v2015.11-1644-ge39ed90_2018-04-09.AppImage.

The AppImage is a release version of what we KOReader developers call “the emulator.” It has existed since all the way back in 2011 to ease the development process. Until the past few weeks it didn't have any of the regular desktop amenities, but I've added a few over the past weeks. The improvements include dragging and dropping a file onto the window to open it, a title that indicates the currently opened file, a basic albeit imperfect form of window resizing and a filechooser dialog accessible through Ctrl + O. For now the filechooser will only work if your system has Gtk3 installed.

Because the AppImage is built on top of the emulator, you can set default window sizes and DPI through the command line. EMULATE_READER_W=2000 EMULATE_READER_H=1500 EMULATE_READER_DPI=180 ./koreader-appimage-x86_64-linux-gnu-v2015.11-1644-ge39ed90_2018-04-09.AppImage. You could also try out other debugging aids such as EMULATE_READER_FLASH=100. There's also another more practical use besides just reading documents: you could use the AppImage to verify whether a bug is specific to your device or if it's inherent in the program.

All of the improvements I mentioned above, such as dragging a file onto the window, were merely part of making the emulator easier to use. There's not much point to emulating the limitations of a Kindle or a Kobo if you're just trying to figure out why a document crashed the program! But a better emulator is also a better desktop app. What actually pushed me over the edge into creating the AppImage, which was surprisingly easy in spite of the somewhat sprawling yet vague documentation, was @onde2rock's efforts to make the program properly usable on the Kindle 4NT and other older non-touch devices.

After the program became usable without touch, I thought it'd be a fun experiment to implement game controller support (#3819). The control scheme is depicted below, and you can use it in the AppImage. It's currently equivalent to the functionality offered by the Kindle 4NT.

It might sound slightly odd, but it's rather nice to just lean back with a gamepad while having some document on your screen. I implemented it as a half joking “wouldn't it be cool if…” but it turned out to be a killer feature, at least to me. It's what made me think that having KOReader easily available as a desktop app just might be a worthwhile endeavor.

We'd like to thank all contributors for their efforts. Some highlights include:

• Clarification of error messages (#3752, #3753) @anarcat
• [i18n] Update frontend/ui/language: add Basque and uncomment Vietnamese (#3755) @Frenzie
• coverbrowser: allow for batch metadata extraction (#3750) @poire-z
• Most of the program is now usable on non-touch devices (such as the Kindle 4NT) thanks to @onde2rock (#3796, #3785, #3774, #3765 and #3745)
• Adds 'cre_disk_cache_max_size' setting (#3760) @poire-z
• new option: Save Wikipedia EPUB in current book directory (#3762) @poire-z
• UIManager: avoid painting widgets covered by a full screen widget (#3770) @poire-z
• [feat] SDL2: resize window (#3775, #3776, #3780 ) @Frenzie
• [crengine] Supports <ol start=N> and <li value=N> attributes (koreader/crengine#135) @poire-z
• [UX] SDL2: set window title (#3784) @Frenzie
• fix MuPDF Mac Build (#3788) @Frenzie
• FileManagerMenu: show tab from gesture position (#3792) @poire-z
• [feat, UX] SDL2: drop file to open (#3793) @Frenzie
• [fix] calibrecompanion.plugin (#3799) @Frenzie
• [Fix] Make ScrollTextWidget:moveCursor return the new charpos. (#3808) @edorfaus
• [fix] Kobo suspend when touching screen (#3809) @Frenzie
• [feat, UX] Support the virtualKeyboard on non touch-device (#3796) @onde2rock
• [feat, UX] bump base for SDL2: preliminary gamepad support (#3819) @Frenzie
• [feat] Add ReaderBack (#3821) @Frenzie
• Automatic setting for 'warmth' (#3820, #3840) @dengste
• [chore] Handle SDL_MOUSEWHEEL and less hackish SDL events (#3826) @Frenzie
• [feat, UX] SDL: add Gtk3 filechooser (#3827) @Frenzie
• [chore] device/input: migrate custom event map to settings dir (#3822) @Frenzie
• [PocketBook] Add Inkpad 3 (PB740) definition (#3830) @Frenzie (hat tip @Vaanen @Maradar)
• [UX] FileManager menu: split Settings tab into 2 tabs (#3836) @poire-z
• [UX] CoverBrowser: set default display modes on first launch (#3834) @poire-z
• Wikipedia link: check if previously saved as EPUB (#3837) @poire-z
• djvulibre: add Kobo always UTF-8 filenames patch (#3845) This finally allows for opening DjVu files with Cyrillic characters @Frenzie
• [feat] Build AppImage (#3850) @Frenzie

Full changelog

This release adds support for the Kobo H2Ov2 thanks to @cairnsh. You need to use at least KSM 9 with update 1.

@dengste added a widget to configure the natural light on the Kobo H2Ov2 and the Kobo Aura One in #3744.

The Android x86 build is now a regular part of the nightly builds (see #3384 but it wasn't finalized on the build server until koreader/koreader-misc#14).

We'd like to thank all contributors for their efforts. Some highlights include:

• [feat] Add Android clipboard definition (#3479, #3682) @Frenzie
  If you highlight some text you can copy it. Middle click in a text field to paste.
• Send2Ebook (receiver) plugin (#3681) @mwoz123
• [fix] Long Hold on DjVu/PDF documents crash (#3697) @poire-z
• coverbrowser list view: show book status (#3708) @poire-z
• [fix] Better error handling when MuPDF document has no pages (#3710)
• [feat] Add H2O2 natural light (#3709) @Frenzie (thanks to @gilali from the MobileRead forum)
• [feat] Make touch work on the H2O2 (#3715) @cairnsh
• crengine: fix various rendering glitches (#3700, #3720, ) @poire-z
• [UX] Add InfoMessage about OCR (#3718) @Frenzie
• Fix some issues with movable dict window (#3722, #3726) @poire-z
• reader.lua: add version to ascii art (#3724) @Frenzie
• crengine: add list-style-type: none (#3727) @Frenzie
• Add date to git-rev version (#3723) @Frenzie
• Set default 'cre_storage_size_factor' to 20 (#3732, #3733) @poire-z
• Various crengine fixes (#3735, ) @poire-z
  • Fix crash on following empty links koreader/crengine#120
  • Fix page-mode rendering of tables with tall rows koreader/crengine#119
  • Crash with fatal error when max nodes limit reached koreader/crengine#121
  • Fix cppcheck warnings koreader/crengine#114
• coverbrowser: quicker extraction of EPUB metadata (#3736) @poire-z
  • Allow for quicker loading when interested in metadata only koreader/crengine#123
  • Allow for more than 65535 different attribute values koreader/crengine#124
  • Increase gamma values range koreader/crengine#122
• cre: more constrast settings (#3737)
• Speed up page turning on big cre documents (#3740) @poire-z
• [typo] PerceptionExpander: main.lua fix typo (#3747) @cramoisi
• Natural light configuration (#3744) @dengste

Full changelog

Special thanks to @dengste this month for adding natural light support on the Kobo Aura One (#3661, #3679).

You can control the natural light feature on the Kobo Aura One through the regular frontlight widget and the frontlight gesture controller. The latter allows for controlling warmth by swiping on the right of the screen, and is accessible via Tools → More plugins → Frontlight gesture controller.

Those who read two-column papers might like the new two-column navigation (#3674) by @FranMarelli This does not work in conjunction with scroll mode.

Those willing to experiment can try the new Open with… option (#3653, #3678). You can choose which rendering engine to use for files that are supported by multiple rendering engines. Most notably you can choose to use either crengine or MuPDF for EPUB and FB2 files. MuPDF support is still experimental, but it may be faster in some cases. The program can now also directly open .bmp, .gif, .hdp, .j2k, .jp2, .jpeg, .jpg, .jpx, .jxr, .pam, .pbm, .pgm, .png, .pnm, .ppm, .svg, .tif, .tiff, and .wdp (#3651).

Finally, a little clarification on last month's HTML dictionary support. We use MuPDF to render the HTML dictionary results. Unfortunately, MuPDF expects its input to be well-formed XHTML, meaning XML. When the HTML is tag soup instead, KOReader will fall back to a stripped version of the HTML dictionary entry. Should this be the case, you can manually fix up the output by adding a .lua file in the dictionary directory. Further details and a few examples are provided by @poire-z in #3585 as well as #3606 and #3611.

We'd like to thank all contributors for their efforts. Some highlights include:

• Fix speedup of dictionaries init (#3592) @poire-z
• Swipe down or tap on top left/right to access left/right reader menu tab directly (#3595) @nagyation
• Menu: configure number of items per page, wrap entries (#3589) @robert00s
• OPDS - add confirm when file exist in local destination (#3605) @robert00s
• HTML dictionary link support (#3603) @TnS-hun
• Update History and Last open document when move (cut and paste) file (#3607) @poire-z
• Do not execute background runner if device is suspended (#3608) @Hzj-jie
• [feat] Add NetworkManager:isConnected() (#3593) @Frenzie
• Filemanager - sort by percent of book (#3614) @robert00s
• [UX] Move "Go back to previous location" up one menu level (#3615) @Frenzie
• Wikipedia: show images and allow interrupting queries (#3609) @poire-z
• luasettings: backup previous file and auto-recover (#3625) @poire-z
• epub metadata: support multiple authors (#3624) @poire-z
• HtmlBoxWidget: fix selection when starting from end (#3632) @poire-z
• Bump base: fix gray background instead of white on Kindle (#3634) @poire-z
• Add MovableContainer: allow moving some widgets (#3636) @poire-z
• Add menu item for toggling auto_book_status (#3642) @poire-z
• [UX] Dict: scroll back with tap: go to bottom of prev definition (#3647) @poire-z
• NewsDownloader: better exception handling and basic redirects (#3652) @mwoz123
• [feat] Open with: choose which engine to use for file (#3651, #3653, #3678) @Frenzie
• Menu: speed up rendering of long texts (#3657) @robert00s
• cre full text search: fix inconsistencies (#3656) @poire-z
• kobolight.plugin: Support for setting natural light (#3661, #3679) @dengste
• Show vertical marker at original position when back from link (#3669) @poire-z
• File manager: added 'Go to letter' (#3664) @robert00s
• cre cache: allow for disabling compression (#3670) @poire-z
• [feat] Two-column navigation (#3674) @FranMarelli
• [fix] larger max font size for crengine (#3676) @Frenzie

Full changelog

This release updates MuPDF to the latest 1.12 and adds support for HTML dictionaries thanks to @TnS-hun.

We'd like to thank all contributors for their efforts. Some highlights include:

• NewsDownloader: wifi off prompt after download (#3395) @mwoz123
• [UX] Improve ConfigDialog (#3443) @robert00s
• More contrast settings (#3463) @robert00s
• Add PocketBook626 (#3472) @mk-f
• Android: Change screenOrientation to sensorPortrait (#3474) @poire-z
• [UX] Always show screensaver menu in reader (#3471) @Frenzie
• [fix] add OSX build prerequisites cmake and makedepend (#3478) @chrox
• [feat] Add Device:hasClipboard() (#3465) @Frenzie
• Speedup dictionaries init (#3489) @poire-z
• Disable Purge .sdr and Delete for currently opened book (#3500) @poire-z
• [UX] Fix bookstatuswidget truncated at the bottom in landscape (#3498) @robert00s
• [UX] Option to show dictionary in large window (#3499) @TnS-hun
• [build] Darwin build of Android port (#3520) @chrox
• Added Pocketbook 624 alias Basic Touch (#3528) @mk-f
• Add PB623 alias Touch Lux (#3542) @mk-f
• MuPDF 1.12 (#3547) @TnS-hun
• cbt support (#3533) (#3554) @TnS-hun
• Remove not empty folder (#3562) @robert00s
• copying file with .sdr (#3563) @robert00s
• Basic fixes to calibre-sync (#3558) @ToxicFrog
• New option - create new directory (#3555) @robert00s
• [fix] small skim problem (#3580) @nagyation
• HTML dictionary support (#3573) @TnS-hun
• HTML dict: enable color rendering and per-dict user fix html func (#3585) @poire-z

Full changelog

This release supports KOReader on PocketBook631 (Touch HD) thanks to @mk-f.

This release enables DjVu on Android.

We'd like to thank all contributors for their efforts. Some highlights include:

• kodev: add run android convenience shortcut (#3297) @Frenzie
• Migrate Goodreads to https (#3298) @robert00s
• [fix] Avoid multiple refreshes when opening credocuments (#3300) @poire-z
• [fix] Android screen blackout on first light change (#3303) @Frenzie
• Fix footer, stats, TOC position with cre in scroll mode (#3304) @poire-z
• [ReadTimer] Time from now (#3311) @robert00s
• Add LuaData and Dictionary Lookup History (#3161) @Frenzie
• Option to disable show bottom menu on top menu activation (#3316) @robert00s
• [fix, Android] Don't steal frontlight control on start (#3319) @Frenzie
• Better vertical centering of text in its box @poire-z
• Normalize some widgets appearance (those using ButtonTable) @poire-z
• [feat] VirtualKeyboard cursor navigation (#3290) @robert00s
• Allow for disabling flashing of menu, icons and buttons (#3339) @poire-z
• Menu (TOC, bookmarks): add padding before right text (#3350) @poire-z
• kodev: Add $ANDROID_ARCH to enable x86 build (#3353) @Frenzie
• [android] fix hide nav bar on activity create (#3357) @chrox
• [Android] Enable DjVu (bump base) (#3358) @Frenzie
• djvu: enable color rendering (#3361) @poire-z
• Enable Edit (rename bookmark) when tap on highlight (#3369) @poire-z
• Android NetworkManager (#3386) @mwoz123
• NewsDownloader promptWifiOn (#3388) @mwoz123
• [feat] SkimToWidget chapter markers & next/prev chapter/bookmark (#3389) @robert00s
• [PocketBook] Use inkview-calls for battery-percentage/charging (#3402) @mk-f
• PocketBook: Basic device-detection / PocketBook631 (Touch HD) support (#3403)

Full changelog

This release solves all post-April Android regressions.

We'd like to thank all contributors for their efforts. Some highlights include:

• Added Dictionary settings and Wikipedia settings menus (#3121) @poire-z
• Statistics plugin v2 (SQLite) (#2893) @robert00s
• Dict settings menu: list dicts, and allow disabling them (#3144) @poire-z
• Added Embedded Fonts config toggle (#3149) @poire-z
• [UX] Add exit menu (#3167) @Frenzie
• frontlight on kobo: a few fixes (#3163) @poire-z
• [fix, UX] Allow modal widget on top of modal widget (#3170) @Frenzie
• [UX] Add "Follow Link" in hold/highlight dialog (#3190) @Frenzie
• Hold on a word for more than 3 seconds to access highlight menu (#3199) @poire-z
• Show vertical marker at target position when following a link (#3202) @poire-z
• Added Swipe to follow nearest link/to jump to latest bookmark (#3207) @poire-z
• Add horizontal_padding to IconButton (#3213) @poire-z
• kodev: add --graph option for rudimentary memory use tracking (#3209) @Frenzie
• [UX] Wikipedia save as EPUB: allow for aborting download (#3224) @poire-z
• Android fullscreen switcher (#2938) @mwoz123
• Add a date setting (#3234) @robert00s
• Added Size module to unify widget scaling and fix DPI issues (#3203) @Frenzie
• [UX] Smaller top menu icons (#3253) @Frenzie
• [UX] Smaller bottom menu icons (#3257) @poire-z
• [UX] Smoother image scaling (#3259, #3260, #3272) @poire-z
• [fix] Some Android issues (#3262) @Frenzie
• fix loading libandroid on MIUI ROMs (koreader/android-luajit-launcher#62) @chrox
• hide navigation bar on start (koreader/android-luajit-launcher#63) @chrox
• [UX] Add home button (#3263) @Frenzie
  
• [Android] Enable CoverBrowser (#3264) @Frenzie
• Add back button to statistics (#3267) @robert00s
• Rename bookmark (#3275) @robert00s
• Allow for colored rendering (#3276, #3285) @poire-z
  
• Read timer with normal time format (#3279) @robert00s
  
• [fix] KOSync server (#3288, #3291) @Frenzie @houqp
• [feat] Pocketbook840 enable frontlight (#3294) @mk-f

Full changelog

We'd like to thank all contributors for their efforts. Some highlights include:

• AutoFrontlight plugin (#2941) @Hzj-jie
• crengine update: description and keywords metadata, css improvements, fix crash, CSS improvements (#2985) @poire-z @frankyifei
• TextViewer widget, used when onHold on truncated item in KeyValuePage @poire-z
• Fix: Unhighlight is not clickable in dictionary view and Deleting highlights in bookmarks does not take effect (#3034) @robert00s
• KeyValuePage navigation buttons (#3043) @robert00s
• Gesture to show only config menu (#3051) @robert00s
• Support history as default view for filemanager (#3058) @Frenzie
• Ability to setup clock (#3085) @robert00s
• Newsdownloader: add HTTPS support and fixes @Frenzie
• [UX] FileManager: add ConfirmBox for purge .sdr @Frenzie
• CoverBrowser plugin: alt views for File Browser and History (#2940) @poire-z
  
  
• [UX] Add CheckMark and use in TouchMenu checkable indicator @Frenzie
  
• Added french keyboard @poire-z

Full changelog