Image credit: Bing Image Creator (Dall-E 3)

The user guide has had a big update. Included below is the full release announcement, thanks to @offset-torque.

USER GUIDE 23.10 UPDATE

This is the biggest ever update to the guide. 2 years ago I started with the intention to make a simple how-to guide. With this release, user guide reached 60 A4 pages ! KOReader might be the best documented reader app now :)

Our guide is now a HTML document: https://koreader.rocks/user_guide/

It was very tedious to recreate the PDF as a web page (especially considering that I had to learn CSS to do it). But there are many benefits like: - More frequent and real-time updates - Better compatibility for smaller devices - Ability to directly link to it in issues and discussions - Possibility to be packed as an EPUB - PDF sucks

Also I recently noticed that our color palette in the guide was not suitable for color blind people. Some important items were indistinguishable for color blind users so I updated the colors to provide nice contrast for them too. Also added icons and visual aids to make the text more accessible.

CHANGELOG

GUIDE CHANGES:

• Recreated the guide in HTML
• Updated the colors, fonts and styles to accomodate color blind users
• Optimized all the images to make them as small as possible without degradation (Achieved ~50% reduction in size)

MAJOR CHANGES:

• Fonts has its own section now
• Quick Menu and Profiles has its own section now
• Expanded Plugins section to include contrib and external plugins
• Rewritten Highlighting, Bookmarks and Notes section
  • "Highlight icon" in the File Browser
  • Bookmarks: filter by highlight style
  • Multiple highlights and notes
• Expanded Export section
  • Export multiple files
  • Export to clippings format
  • Export to memos format
  • See and choose export folder
• Added Keyboard shortcuts section for non-touch devices and Linux
• Added full list of actions that is available in Gesture Manager

ADDED INFO ABOUT:

• Partial rendering
• Translate current page
• Scrolling modes
• Creating a profile with current document settings
• Open with: Archive viewer
• Open with: Image viewer
• Patch manager
• Menu search
• Location history
• Setting to turn off flashing on pages with images
• Ability to change statistics calculation time
• Clearing PDF cache
• Switching the style to HTML5 to fix some problems
• Toggle status bar via gestures or Quick Menu
• Scrollable Quick Menu
• "Move to archive" availability in Gesture Manager
• Custom book cover setting
• Using "Exit screensaver" gesture as a pseudo lock screen
• Tap on time to show date
• Verbose logs procedure in How to report problems section

UPDATED IMAGES:

• File Browser
• Skim widget
• Book map menu

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

• NetworkManager: Decode SSID to UTF-8 (#10864) @wfdewith
• bump crengine: revamp CSS 'inherit' handling, other fixes (#10865) @poire-z
• Custom metadata (#10861, #10869, #10889, #10894, #10919) @hius07
• Device: Try harder to properly setup the charging LED on plug/unplug (#10855) @NiLuJe
• VirtualKeyboard: Revamp visibility handling (#10852) @NiLuJe
• PDF contrast: incorrect set by a gesture (#10798) @hius07
• copt deduplicate: smooth_scaling, nightmode_images (#10801) @hius07
• Exporter: custom metadata (#10874) @hius07
• Reset settings/cover/metadata separately (#10866) @hius07
• Various code optimizations @hius07
  • copt deduplicate: embedded_css, embedded_fonts (#10876)
  • copt deduplicate: line_spacing (#10768)
  • copt deduplicate: render_dpi, margins, rotation_mode (#10880)
  • copt deduplicate: font_size, visible_pages (#10882)
  • copt deduplicate: font settings (#10885)
  • copt/kopt options: deduplicate some defaults (#10893)
  • screen_rotation_menu_table: deduplicate (#10954)
  • md5: centralize and deduplicate (#11003)
• [doc] Building: add libtool-bin to Debian/Ubuntu prerequisites as a workaround for ancient libzmq (#10897) @Frenzie
• Actions for Go to first/last bookmark (#10899) @hius07
• Check for Noto Emoji font in UI fallback fonts (#10908) @wfdewith
• Device: Make sure input_no_key_repeat survives a suspend/resume cycle (#10904) @NiLuJe
• TextViewer: font size (#10911) @hius07
• Add Onyx Poke5 support (#10917) @hugleo
• NetworkMgr: Handle non-blocking turnOnWifi implementations better (#10863) @NiLuJe
• Revert "Kobo: Disable HW inversion on MTK (#10841)" (#10928) @NiLuJe
• screensaver_menu: radio buttons (#10931) @hius07
• ReaderRolling: Guard against races between scheduled tasks and CloseDocument (#10934) @NiLuJe
• TimeSync: Probe for root & ntpd/ntpdate dynamically (#10935) @NiLuJe
• tests: tag tests relying on a working internet access (#10939) @benoit-pierre
• [PocketBook] Add PB-Verse_(PB629) and PB-Verse Pro_(PB634) (#10938) @ElimGarak1
• sdl: ensure dialogs are displayed after window change events (#10929) @hrdl-github
• Status: setting status of current book in History and Collections (#10946) @hius07
• [plugin] CoverBrowser: improve title & authors layout (#10942) @benoit-pierre
• Coverbrowser: event for cache refreshing (#10956) @hius07
• readerhighlight: fix OCRed text dictionary lookups (#10967) @benoit-pierre
• New menu option and filemanager filter to hide finished books #7158 (#10895) @mytskine
• Kobo: Deal with some more frontlight edge cases on devices with the AW99703 PWM controller (#10971) @NiLuJe
• ReaderHandmade: support for custom TOC and hidden flows. BookMap and PageBrowser tweaks (#10982) @poire-z
• Finished books: freeze history timestamp and statistics (#10968, #10968) @hius07
• Add hash-based document metadata storage option (#10945) @ryanwwest
• File search, FileChooser and others (#10994) @hius07
• otamanager: fix OTA model name for Android x86_64 (#10997) @benoit-pierre
• util.htmlEntitiesToUtf8: add some more semi common entities (#10979) @yparitcher
• Minor code quality improvements (#10905) @mytskine
• Add new PocketBook PB-Basic Lux 4 (PB618) (#10987)
• Exporter: fix memos export, add flomo export (#10988)
• Device:Android: always call "_decideFrontlightState" in "setIntensityHW" (#10737)
• History: update on renaming/moving a folder (#10999)
• WakeupMgr: Forward rtc_dev & dodgy_rtc to the backend (#11010) @NiLuJe
• UIManager: Always send PowerOff & Reboot events (#11010) @NiLuJe
• Reader: re-enable File search, Folder shortcuts (#11028) @hius07
• webdav: do not allow trailing slash in start folder (#11026) @hius07
• Kindle: Initial Scribe support (#11047) @NiLuJe
• Kindle: Handle the PW5 SE properly (#11049, #11051, #11052) @NiLuJe

Full changelog — closed milestone issues

Installation instructions: Android • Cervantes • ChromeOS • Kindle • Kobo • PocketBook • ReMarkable • Desktop Linux • MacOS