You are currently reading the English (main) version of the KOReader User Guide. Also volunteers are translating this guide to other languages. We have many translations in progress, as you can see in the overall translation status below. But we only link to the languages which are translated above 50% for usability reasons.

To see all the languages currently being translated and to contribute to the translation efforts of the user guide, please visit the Weblate translation page of our project.

Overall translation status of the user guide

This guide is primarily designed for color screens. If you are using it for the first time, we highly recommend reading this on a computer, tablet or mobile. Because seeing user interface elements highlighted in color will make your life easier while learning how to use KOReader. Of course you can read this on your e-ink device too, but the experience will not be optimal.

You can use the search function of your browser to find a specific topic or keyword (generally Ctrl + F). If you have a suggestion or question related to this user guide, you can write to this GitHub discussion thread.

本指南中的部分文本根据不同类别标色：

我们在整个指南中还有用不同的方框来通知或警告您：

KOReader 是由世界各地的志愿者开发和支持的。你也可以通过以下方式成为这个项目的一部分：

• 修复 bug 和实现新特性
• 将程序翻译成您的语言或改进现有的翻译
• Helping others with your knowledge in the forums or on GitHub issues and discussions

Check Reach us section for the links.

Guide last update: 2025-03-25

Despite its minimalistic looks, KOReader is a very powerful and customizable application. This section is like a table of contents which is how-to oriented. So if you are a new user, this is the best place to start. Here you can read what KOReader can do and learn how to do it by following these  links to go to the mentioned sections.

• USB mass storage mode for supporting devices 
• Cloud storage (Dropbox/FTP/Webdav) with suitable accounts 
• KOReader can act as an SSH server, so you can use an SFTP application or your file manager to directly transfer files 
• With the Calibre plugin you can send books from your Calibre Library directly to your KOReader devices over wifi 
• With the News downloader plugin you can download RSS and Atom news entries to your device as HTML files 
• With the Wallabag plugin you can retrieve articles from your Wallabag account (a server based read-it-later service like Pocket) 

• Change fonts (including your own), font size, contrast, boldness, kerning, word spacing, word expansion, text alignment, line spacing, column layout, margins... 
• Use the included powerful style tweaks or write your own ones to change how your books are rendered precisely 
• Invert screen colors for night mode manually or automatically 
• Adjust your frontlight color warmth automatically 

• Highlight text with different styles and colors, place bookmarks 
• Two-tap mode for academic/longer highlights 
• Add notes using a customizable keyboard including diacritic modifiers 
• Take screenshots 
• 跟踪您的阅读统计数据，包括阅读进度, 时间范围和日历视图

• Export your notes and highlights to your device as text, markdown, HTML, JSON or Kindle clippings format 
• Synchronize to online services like Joplin, Readwise, Memos, Flomo and XMNote 

• Powerful File Browser where you can copy, move, rename, create, delete files and folders and perform bulk operations 
• See your library as you like with many detailed and mosaic views 
• Add your books to your Favorites for quick access or create your own Collections with sorting and filtering 

• Skim widget to quickly jump between pages, chapters, bookmarks 
• Unique Book map to see a bird’s eye map of your book including all your notes and highlights 
• Page browser to move through pages like a film reel 
• Bookmarks browser to browse your highlights and notes easily 
• Create an alternative table of contents automatically or manually if you don't like the one that comes with your book 
• Hide and exclude certain parts of your book like Appendix, Index, References etc. for more accurate page counts 

• Powerful gesture system with 200+ actions allows you to control every aspect of KOReader with a tap or swipe 
• If you have a keyboard (internal, wired or bluetooth) you can also assign keyboard shortcuts to these actions 
• Or create your own menus with your favorite actions with Quick Menu and access them with a tap or swipe 
• Create Profiles to control every aspect of KOReader and automate actions 

• 通过选择或输入文本(包括正则表达式)来搜索文档
• 在您的书签、标记和笔记中搜索
• 在 Wikipedia 或已安装的词典中查找文本，并通过长按来翻译它
• 一次性翻译整个页面为130多种语言
• With our poweful plugin system, you can even discuss the text with ChatGPT (after installing the plugin) 

• KOReader can update itself 
• 在设定的时间间隔后调暗或关闭屏幕背光
• Set your page refresh intervals for different reading conditions 
• 从许多选项中设置您自己的屏幕保护程序，如随机图像、书籍封面、阅读、进度等。
• Set battery charge limit alarms to prevent deep discharge/over charge 
• Set a memory usage alert (useful for devices for smaller memory) and optionally restart KOReader upon reaching this limit 

• 自动或手动裁剪页边距
• 重排文档以提取文本以便在小屏幕上更容易阅读
• Apply OCR to documents without text layers, like scanned old books 
• Different zoom types and page flow directions to read multi-column documents like scientific articles easily 
• Auto straighten tilted documents, like scanned old books 
• Save your highlights directly into PDFs which allows you to see them without KOReader 
• Special Panel zoom feature for reading mangas 
• Adjustable screen refresh settings for perfectly balancing between ghosting and speed 

• Add your own CSS style tweaks for books 
• User patches system which allows you to change the core behaviors of KOReader 
• Create a QR code from your clipboard to share text and links to other devices
• View HTML source of an EPUB document
• 在您的设备上创建和编辑文本文件
• 打开终端模拟器并在设备上运行命令
• 查看您的CPU、内存和电池使用统计数据

KOReader supports PDF, EPUB, DJVU, MOBI, CBZ, CBT, DOCX, RTF, HTML, TXT, XPS, FB2, PDB, CHM and MD files. It can also open ZIP archives and show image files.

有许多方法可以将文档传输到设备。请注意，您可能需要重新启动KOReader来索引传输的文档（如果您是Pocketbook/Android，则需要刷新目录）。

除了像使用内置阅读器应用程序一样传输文件之外，根据您的设备，还可以使用其他选项：

1. KOReader 中的 USB 大容量存储模式： 此模式适用于 KOBO 和某些 CERVANTES 设备。
2. Cloud storage (Dropbox/FTP/Webdav): To use this function you have to add accounts for a cloud storage server via menu shown below. Process is explained via info buttons in the menu while adding accounts:
   TOP MENU (in File Browser) / / Cloud storage
3. SSH/SFTP access: KOReader can act like an SSH server, which you can access from a computer to transfer files (available on Kobo, Kindle, Cervantes). You can use an SFTP application (like Filezilla) or access via your file manager if your operating system supports. Check our wiki for how-to and also see the warning box below.
4. Calibre transfer: With the Calibre plugin you can send documents from your Calibre Library directly to your KOReader devices via a wifi connection. Check our wiki for how-to.
5. News downloader: With this plugin you can download RSS and Atom news entries as HTML files. Check wiki for how-to.
6. Wallabag: With this plugin you can retrieve articles from Wallabag, a server based read-it-later service like Pocket. Check wiki page for more info.

Following methods are available for accessing your books:

• File Browser - Dedicated section is here: File Browser usage
• 收藏 -您可以在文件浏览器列表中长按书籍来添加书籍
• 历史 - 您打开的书籍列表
• Collections - Personalized book lists you created. Dedicated section is here: Collections

您可以从以下位置更改这些屏幕的外观：

如果您想更改这些屏幕上显示的项目数量，请查看此处：

您可以为每个对话框分配手势。例如，在阅读一本书时，您可以通过手势访问您的历史或收藏文件浏览器。

您可以通过左上角汉堡菜单按钮的文件名或图书元数据在历史屏幕中搜索图书。

您还可以通过以下方式将KOReader设置为从收藏夹或History文件浏览器:

In the image above, you can see the positions of the default tap zones of KOReader. To show the top menu or bottom menu you can tap the indicated zones. You can also swipe down the upper zone to show the top menu. On non-touch devices like Kindle 4 you can open the bottom menu by pressing the button that corresponds to the ENTER/OK action.

If you want top open both menus at the same time, you can set top menu zone to open both the top and bottom menu at the same time via this menu:

Corner tap zones can be used for many different type of gestures including TAP, DOUBLE TAP, TWO FINGER TAP and TAP and HOLD.

上一页 和 下一页区域还可同时使用 双击 手势。

Status bar zone can be tapped to cycle between the status bar items if only one item is visible. If all items are visible, tapping will show and hide the status bar.

• Changing the font*:
  TOP MENU / / Font
• 放大字体
  BOTTOM MENU /
• 字体加粗
  BOTTOM MENU /
• 反转屏幕颜色（黑底白字）
  TOP MENU / / Night Mode

You can also change other formatting options from the BOTTOM MENU to fine tune the appearance of your text. These are just quick tips to get you started of course. We have a full section dedicated to CUSTOMIZING TEXT APPEARANCE

您可以通过此菜单控制屏幕灯光。如果您有暖色灯光（普通白色 LED 灯+橙色 LED 灯），可以通过此对话框单独控制它们。您还可以为该对话框定义一个手势：

您可以通过该菜单选择书籍封面或自定义图片作为屏保：

你可以将 JPG/PNG 文件用作屏保（适当抖动的灰度图像效果最佳）。将文件从电脑传输到设备上的任意文件夹。然后通过此菜单选择此文件夹作为屏保文件夹：

Please refer to this Mobileread forum post for advanced information about preparing screensaver images.

If you are looking for information about keyboard shortcuts, click here to go that section. This heading only explains the keyboard usage.

• 轻触输入框外侧关闭键盘，轻触输入框再次显示键盘
• 向上轻扫键盘，输入该字母的大写字母（如果已进入大写模式，则输入小写字母）
• 您可以更改键盘的外观：
  TOP MENU / / Device / Keyboard / Keyboard settings
• 您可以选择多个布局：
  TOP MENU / / Device / Keyboard / Keyboard layout
• You can change between your selected layouts by tapping the icon on the keyboard

Koreader 键盘可以在长按键盘时输入额外的字符。最常用的额外字符如下所示。你可以点击并按住灰色方框中的键来获取周围的字符：

除了长按弹出窗口之外，你还可以通过按键输入这些额外的字符。在下面的示例中，您可以向上滑动a键以输入大写a,或者向其他方向滑动以输入显示的字符。请注意，所示示例包括用于演示的完整弹出窗口。不需要打开这个弹出框，直接在按键上滑动即可。一旦你习惯了额外字符的位置，你就可以用这种方式更快地输入它们。

如果此功能妨碍您的使用，您可以通过取消选中来禁用它:

Additionally there are some shortcuts for easier text manipulation. You can tap and hold these keys for extra actions:

• 左箭头 - 将光标移动到行首
• 右箭头 - 将光标移动到行尾

Also backspace key behaves different when you make swipe gestures on it:

• Tap: Delete a character
• Long-press: Delete the whole line
• Swipe left: Delete part of the word left of the cursor
• Swipe up: Delete the whole word

For more information, you can check the related wiki page.

KOReader also integrates the Chinese stroke keyboard for inputting simplified and traditional Chinese characters. You can find more info about it in our wiki.

This plugin allows you to adjust frontlight warmth in devices with natural (yellow/orange) light and set night mode (inverted screen colors – white text on black background) automatically according to a schedule. It can control them both or you can choose only warmth control or only night mode control mode, so you can adjust the other one manually.

This plugin comes enabled as default when you install KOReader. If for some reason it is not in the menu, you can enable it here:

您可以通过两种不同的方式自动调整屏幕前灯的色温：

Fixed schedule: In this mode your frontlight warmth changes according to the daily schedule you entered. This mode is static, it doesn’t account for daylight length. The schedule stays the same all around the year.

Sun's position: This option calculates Sun’s position in your location according to coordinates and altitude information you entered. Frontlight warmth is adjusted gradually according to this calculated Sun position data. This mode is dynamic. As the length of daylight changes around the year, plugin adjusts the schedule accordingly.

首先看一下这张图片，熟悉插件中使用的术语：

1. Go to the plugin menu:
   TOP MENU / / Screen / Auto Warmth and Night Mode
2. Tap Activate menu item and then tap According to the fixed schedule
3. Go back to previous menu and tap Fixed schedule settings menu item
4. Set your warmth transition schedule by setting times for various items here. Refer to the image above for an explanation of items.

1. Go to the plugin menu:
   TOP MENU / / Screen / Auto Warmth and Night Mode
2. Tap Activate menu item and then tap According to the sun's position
3. Go back to previous menu and tap Location settings menu item. Set your coordinates (necessary) and altitude (optional) correctly and give a name to your location.
4. Go back to previous menu and tap Warmth and night mode settings menu item
5. Set your warmth transition schedule by setting times for various items here. Refer to the image above for an explanation of items.

You can see your current schedule via Currently active parameters menu option.

在为不同的时间段设置暖光百分比时，您还可以将该时间段设置为夜间模式，这会在该时间段开始时反转屏幕颜色。如果您的最小亮度的前灯仍然太亮，或者您更喜欢黑暗的页面背景，您可以激活此功能。要启用此功能，请在下面的对话框中点击夜间模式复选框，然后点击 设置。

当您执行此操作时，此时间段旁边的菜单中将出现一个月亮图标。要禁用夜间模式，只需在该间隔中禁用夜间模式复选框。

这个功能在日落时打开你的前灯，在日出时根据你当前的活动参数关闭它。您可以通过手动打开/关闭前灯来覆盖此更改。在下一个日出/日落时，如果有必要，自动色温将再次切换它。你可以通过在这个插件中的菜单项中选择白天关闭前置灯来激活它。

如果你想让你的前灯色温迅速更改，而不是逐渐改变：

1. 按照上面的说明设置模式为固定调度
2. 调整设置如下图所示：

正如你在上面的这些设置中所看到的，昼夜转换之间只有一分钟的差异。因此，屏幕色温在一分钟内从 0 到 100（或相反）。您可以增加这个时间间隔，使转换持续时间更长。

KOReader 的用户界面非常简单，主要是黑白两色，因为渐变色和不同深浅的灰色在电子墨水屏幕上会导致闪烁和重影，从而降低阅读体验。

KOReader has 2 main interfaces: reading screen and file browser. We will explain reading screen here. File browser is explained under this section of the guide.

READING SCREEN has two menus:

• TOP MENU includes menu items related to the general usage of KOReader. You will access your books, KOReader preferences, plugins etc. here.
• BOTTOM MENU is focused on options for document formatting like font weight/size, line spacing etc. While adjusting your text appearance, you will mostly interact with the BOTTOM MENU.

Image above shows the elements you can see on your reader screen when reading a book:

1. Indicator icons: These icons inform you about certain ongoing processes and states. You will see them at the top left corner of your screen during certain operations. Normally they are smaller but here we show them bigger for clarity. Next heading explains these indicator icons in detail: Indicator icons
2. Status bar:This is a highly configurable area where you can see various information about your book and KOReader. Click here to go to the section: Click here for details: Status bar
3. Alternate Status bar: In addition to the default Status bar, we have an Alt status bar which appears at the top of the page if you enable it. Click here for details: Status bar
4. Reference page numbers: If the publisher of your book included the page numbers from the paper printed version of the book, you will see them like this. Click here for more info: Page numbering and reference page numbers
5. Highlight types: You can see the different highlight types here. Also you can make colored highlights if your device has a suitable screen. Click here to go to the section: Bookmarks, Highlighting and Notes
6. Note marker: Note marker icon shows up when you add a note to a highlight. We have different types of note markers. Click here for more info: Bookmarks, Highlighting and Notes

KOReader has some indicators to inform you about certain ongoing processes and states as you can see in the image above. You will see them at the top left corner of your screen during certain operations.

Partial rendering icons This group of icons belong to the partial rendering procedure and probably you will see these icons more frequently than the others. You see these icons when you change the settings on the bottom menu. This feature, allows you to preview the text appearance adjustments much quicker by only rendering the current chapter instead of the whole book. Also rotating your screen orientation is now much faster thanks to this feature. This feature is ENABLED by default. If necessary, it can be disabled per book (with a tap), or globally (with a long-tap) on: TOP MENU / / Document / Enable partial renderings After confirming your changes whole book has to be re-rendered so this is a multi-step procedure. These icons shows the stage of rendering as explained below:

	In this stage, document is partially rendered. Page count, footer info and many things are innacurate. You can see how the new settings look and adjust further. You can also turn pages, jump links in this state.
	在后台中正在进行完整的渲染。您仍然可以翻页、跳转链接、更改设置。
	完整渲染已完成，但尚未应用，因为 KOReader 正在等待您空闲以重新加载书本的其余部分（空闲=不与设备交互）。你仍然可以翻页，跳转链接，更改设置。
	您已经空闲了一段时间，所以 KOReader 现在正在重新加载整个文档。在这个步骤中，KOReader 会屏蔽交互。

Highlighting icon This icon shows up when you are in the Select and highlight mode. KOReader has an additional highlight mode which allows you to start a highlight and turn pages to make long highlights which can span multiple pages. You can read about this in the BOOKMARKS, HIGHLIGHTING AND NOTES section of this guide. When you start a highlight in this mode, this icon is shown at the corner to remind you that you are still in the highlighting mode. It disappears when you finish your highlight by selecting the end of the passage or when you cancel the highlight (by tapping again on the beginning of your highlight or on this highlighting icon).

Pokemon ball icon This icon shows up when you press for a long time on a word (intentionally or accidentally). KOReader has a normal long press menu. And an additional very long press menu when you hold your finger longer than 3 seconds. This icon means that you activated this very long press menu.

Flip mode icon This icon shows up when you tap the top left corner if: You are reading a PDF document And you are in a zoomed in view other than 100% (column, row or manual) or in the reflow mode This mode temporarily displays the full page without cropping, scaled to fit your screen. You can turn the pages in this mode. To exit this mode, tap on this icon.

Document types like epub, mobi, html naturally don't have fixed page numbers because they are reflowable documents. Which means, these documents can be adjusted according to the screen size and orientation of the device (unlike pdfs or djvu files for example, which have a fixed page size).

If you increase the font size of a reflowable document, your page count will increase too, because now less text will fit on a single page. This sometimes causes a problem because a highlight which you made on page 38 might be on page 42 after the font adjustment.

KOReader supports Reference page numbers feature which allows publishers to embed page numbers from printed books directly to the e-book version. When you enable this feature, KOReader doesn't calculate the page numbers itself. Instead, it shows you the embedded page numbers from the publisher. This means, the page number you see in your Status bar matches the print version of the book.

Benefits of reference page numbers:

• Reference page numbers enable accurate citations by matching the page numbers found in the printed versions.
• Reference page numbers can aid in navigation, especially for readers who are familiar with the print version of a book. It can help you find specific passages or quotes more easily in the digital version.
• Since digital books can be read on various devices and platforms, each with its own font size and display settings, shown page numbers can vary significantly. Reference page numbers provide a consistent point of reference when reading the same book on different devices like e-reader and phone at the same time.

You can enable this feature from:

If you also check the Show reference page labels in margin option from the same menu, this page numbers will be shown next to the text in a small font.

Please note that this menu appears only if there are embedded Reference page numbers in your book.

KOReader have two status bars, a Bottom status bar which is enabled by default. And we have an Alt status bar which appears at the top of the page if you enable it. This Alt status bar is available only in reflowable documents (epub, html, docx, rtf, txt…).

Bottom status bar is the newer one which is actively maintained. Alt status bar is a remnant from earlier versions of KOReader so we are not adding new features to it. But you can still enable this Alt status bar if you find it useful. You can enable it from:

You can configure the Alt status bar from this menu:

Instructions in the rest of this section are for the Bottom status bar.

You can configure the bottom status bar from this menu. Feel free to explore the SETTINGS sub-menu to customize your status bar as you like.

There are many items you can show on the status bar. But by default, only one is shown at a time and you have to tap on the status bar to cycle between them. If you want to show all items at once, enable it from here:

If you enabled the option above, you can't hide the status bar by tapping on it. If you want to hide it, you should assign a gesture here for toggling the status bar:

Sorting the status bar items:

There is a special status bar item named Custom text. This item can show your chosen text in the status bar. You can also use this feature to create a separator between the status bar items as you can see in the example below:

• 首先在此菜单中点击该选项，启用该选项
  TOP MENU / / Status Bar / Custom text: ‘KOReader’
• 然后再次长按它，打开其设置。在第一个框中输入“空格”字符，在第二个框中输入重复次数，这将决定分隔线的宽度。

You can choose another character as a separator. You can also move this item like other status bar items to change its order to adjust your groups.

Progress bar in the status bar normally shows your progress for the whole book. But it can also show your progress for the current chapter instead. This can be useful for example, if a book has lots of short chapters. In this case it might be hard to see your progress in the current chapter so chapter status bar can be more informative here. You can enable the feature from this menu:

Also you can assign a gesture to switch between normal and chapter progress bars. You can find this action under:

Here we will only give an overview of the items in the top menu structure to make you familiar with the menu. Detailed information is available under the related sections of this guide.

• NAVIGATION: This menu contains items that allows you to navigate the book you are currently reading. Table of contents, bookmarks, book map...
• TYPESETTING: This menu contains items that allows you to change the appearance of your book. Font settings, style tweaks...
• SETTINGS: This menu contains settings for KOReader and your device. E-ink, light, gesture settings...
• TOOLS: This menu contains plugins that can expand the functionality of KOReader.
• SEARCH: This menu contains items related to search and lookup. Text search, dictionary, translation, Wikipedia...
• FILE BROWSER: This button opens the file browser which is the interface for managing your library.
• MAIN: This menu contains tools for accessing your books like history, favorites, collections. Also book information, update and exit items are under this menu.

View mode: If you change to continuous mode you can scroll the document like a web page. This mode is more suitable for non e-ink screen types (LCD, OLED). In continuous mode you lose top and bottom margins so text may be cut on the first and last line of screen. To solve this problem you can enable Page overlap:

Render mode: This option determines how your document is rendered by KOReader. Default is WEB and generally you don’t need to change this setting. When a book (or saved web page) is very complicated (specified widths or margins, negative margins, floats etc.) and layout looks bad or overflow the screen, you can try other rendering modes.

Zoom (dpi): This setting can be thought of as a general zoom factor for the document (except font size). At 96 dpi (which is the default setting), images in the document are rendered at their original dimensions. Basically you will use this setting if you want to make images bigger without making the text bigger.

---

Word spacing and Word expansion settings are related and they determine how your text will look when it is justified. When you justify text, space is added between words so that both edges of each line are aligned with both margins. Since word counts of lines are not equal all the time, in justified alignment, text has to be compressed or expanded to fill the line.

Word spacing: How much the space characters in a line of text can be compressed to fit more words. This setting doesn’t affect words, it only changes the space between them.

Word expansion: If you have too much white space in a line, how much of that can be distributed into the words by expanding them. This setting affects the appearance of words. If you don’t want your words to expand, set this to none.

您可以尝试不同的设置，直到文本看起来令人满意，然后通过各自的对话框将它们设置为默认值。

---

Contrast and Font weight are two options that you can use to make your text bolder (or lighter). You can achieve the same appearance with either of these options but they use different methods to achieve it. Of course you can use them both at the same time.

The differences between them can be summarized as:

Font hinting adjusts your text for maximum readability according to your screen’s pixel grid. native uses font’s internal hinting instructions, auto uses FreeType’s hinting algorithm. auto is a safer choice because font files that you installed may have problematic hinting instructions. Also auto handles CJK text better. You can try different settings to see which one looks better on your device.

Font kerning adjusts the spacing between letters to achieve a visually pleasing result. Default is best option, which might be slower when opening files (depending on your device) but has better support for ligatures (see picture below for an example), joined Arabic glyphs and some other scripts. If your device is slow, you can try good which is faster and may still look correct with western latin-script text.

---

Alt status bar enables an alternative status bar which is available only in reflowable documents (EPUB, HTML, DOCX, RTF, TXT…). After enabling it here, you can configure alt status bar via:

Embedded style and embedded fonts determine if publisher’s styles and fonts embedded in the document will be used (or ignored) to render the document. These are general on/off switches. You can achieve more fine tuned tweaks for your document via:

Image scaling determines how images in your document are rendered. Best looks more pleasing but it is slower.

KOReader’s user interface and options can change depending on the file type you open. There are two main categories of documents:

1. Fixed layout documents (pdf, djvu, image files...)
2. Reflowable documents (epub, html, docx, rtf, txt…).

KOReader has lots of features so its menu system reflects this complexity. We have a Menu Search feature for finding menu items quickly. If you remember the name of a menu item but don't remember where it is, you can use this feature:

Also you can assign this feature to a gesture or add it to your Quick Menu for faster access.

On the bottom menu if you tap and hold an option’s name, you can see its explanation.

您可以通过以下方式更改界面语言： TOP MENU / / Language

如果你想改变用户界面的大小，有一个DPI设置： TOP MENU / / Screen / Screen DPI You can choose a value from the menu or select Custom dpi to enter a value for fine tuning: Higher DPI = Bigger Interface. Note that there is also a Zoom (dpi) setting in the bottom bar. That one is related to the documents only. You can find the explanation in the next section.

如果您长按选项或菜单项（字体粗细，行间距等），您可以将其值设置为默认值。新的值将只适用于从现在开始打开的书籍。以前打开的书将保留其设置。您可以将默认值标识为菜单中的星号（★）或黑色边框，如下所示：

You can close full screen dialogs (History, Table of Contents, Reading Statistics etc.) by swiping down. (Except Bookmarks window. You can use any multi swipe gesture to close this one)

You can take a screenshot by making a long diagonal swipe with your finger. Also touching opposing diagonal corners will take a screenshot. You can use this second gesture for example when viewing an image. Also if your device has a keyboard, you can take a screenshot with the Alt + Shift + G shortcut.

If you want to open a random page of a book, we have a Jump to a random page action which you can assign to any gesture. It is in the Reader category of the Gesture Manager.

在包含上述调整箭头按钮的对话框中，您可以点击并按住箭头按钮以更大的增量更改值。 You can close this type of dialog (non-full screen) by tapping outside of its window. You can move this type of dialog by holding its window title and dragging. You can make this type of dialog semi-transparent by tapping and holding the window title (when you want to see the text under it while adjusting a value).

Creating new folders - In situations when you need to choose a location (cloud storage, move to archive plugin, exporter plugin), KOReader presents you a screen that looks like our File Browser. If you want to create a new folder while choosing: First navigate to the folder from the Folder chooser screen Then long-press the Home icon shown at the upper-left corner of this screen

KOReader支持在 EPUB 和扫描的 PDF/DJVU 文档中进行词典查找。只需点击并按住一个单词就可以查看字典定义或翻译。 按住一个单词会弹出一个对话框，您还可以在文档中搜索所选内容以查找更多出现的内容，或在维基百科上查找。

如果你想查看当前日期，你可以点击顶部菜单中的时钟。

KOReader有三种类型的触摸滚动。您可以通过以下方式访问：

1. 经典滚动：此模式的工作原理与您的手机/平板电脑滚动完全相同。
2. 加速滚动：此模式允许您滚动比经典滚动更快。你也可以滚动几个页面，而不用抬起你的手指。滚动量与你开始滚动后移动手指的距离成正比。
3. On-release scrolling: This scrolling type is more suitable for e-ink screens. Because unlike other scrolling types, this mode doesn’t refresh your page continuously while scrolling. It works like classic scrolling but intermediate steps are not shown. So when you scroll with your finger and then release, page jumps to that position. This is especially useful to reposition and adjust the view if your book contains pictures or tables and you want to see all of it.

此有用的功能类似于浏览器中的 后退按钮。当您使用 略图小部件、书签列表、图书地图等跳转到图书的其他部分时。KOReader 会记住您以前的位置。例如，如果您遵循内部链接或引用，则这很有用。只需轻轻一点，您就可以回到您来时的位置。您可以从以下位置访问此功能：

Also you can go forward too, from the same menu. This feature is assigned to  multiswipe gesture. You can assign this to another gesture if you want (like tapping a corner) or add it to your Quick Menu.

KOReader 通常会在包含图像的页面上执行完全刷新（您可以观察到黑色闪烁）。原因是为了去除上一页的残留物和重影。但根据您的设备和个人偏好，这可能不是必需的。您可以在此处禁用此自动刷新行为：

Also you can disable black flashing of user interface from here if it disturbs you:

There are different ways of moving through your document in KOReader with their own strengths. You can use the:

• Skim Widget
• Book Map
• Page Browser

Skim Widget is a very functional navigation tool. You can use it to:

• Jump to any part of your book by directly tapping on the progress bar or entering the page number
• Navigate between chapters
• Navigate between bookmarks

How to open the Skim Widget:

• With a long-tap on the Status Bar area at the bottom of your screen
• From this menu:
  TOP MENU / / Skim document
• You can assign a gesture to it
• You can add it to your Quick Menu

First let's have a quick look at the diagram below. You will see that we have two different Skim Widgets. They have the same functions, only their size is different:

1. FULL-SIZE SKIM WIDGET: This is the default skim widget you will see when you install KOReader. It is bigger than the compact skim widget so buttons are more comfortable to press. This widget opens at the center of the screen.
2. COMPACT SKIM WIDGET: This is the slimmer version of the default skim widget. It can be more useful if you are making highlights for example. Since this widget is smaller and opens at the top or bottom of the screen, it doesn't obstruct the page as much as the default widget.

If you want to use the compact skim widget, you can do this by choosing Top or Bottom from this menu:

Now back to the diagram. You can see that on some buttons, there are two descriptions in different colors: blue and orange. It means that this button has two functions: a normal press action and a long-press action. If you press normally, it will perform the BLUE function. If you press longer, it will perform the ORANGE function.

Explanations of the numbered items (long-press action in bold):

1. Jump to the beginning of the previous chapter / Jump to the first page of the book
2. Jump to the previous bookmark / Jump to the first bookmark in the book
3. Bookmark current page / Open bookmarks dialog
4. Jump to the next bookmark / Jump to the last bookmark in the book
5. Jump to the beginning of the next chapter / Jump to the last page of the book
6. Jump backward (-) or forward (+) this many pages
7. This number shows the current page number. If you tap on it, a dialog opens which allows you to enter a page number or percentage to jump directly. If you long-press, it takes you back to the page where you opened the skim widget. This is useful for example if you want to check some other part of the book quickly and return to your reading where you left.
8. This is the progress bar. Thin lines are the chapter marks which shows the beginning of the chapters. You can tap on this progress bar to jump to that part of the book. Little arrows are session start arrows which marks the place where you started reading this book in the current session. This arrows reset when you switch between books.
9. This button in the compact skim widget works same as the long-press function of the item number 7. It takes you back to the page where you opened the skim widget. This is useful for example if you want to check some other part of the book quickly and return to your reading where you left.

KOReader 可以在浏览小部件和进度条上显示文档的章节边界。

如果你的文档有太多的标题级别，你的章节标记就会像上面的例子一样拥挤。您可以通过以下方式更改可见目录标记级别的深度：

您还可以将此缩减的目录用于：

• 章节标题（如果显示在状态栏）
• 章节导航
• 阅读剩余时间估计

这些选项在同一个菜单中。

如果文档没有目录，则可以启用备用目录。启用此设置时，KOReader 将从文档标题（如果可用）或 EPUB 中的单个HTML文件构建目录。长按此菜单项可获得更多信息：

关于 KOReader 中可用的目录工具的更多信息，请参阅本指南的相关部分：目录工具

书籍地图是 KOReader 的一个强大而独特的功能，对于获取图书概述非常有用。例如，如果你正在非线性地阅读一本书，跳过一些部分以后再阅读，那么很难跟踪你的进度。书籍地图可以让你一眼就看出你已经读过书的哪些部分。

此外，您还可以：

• 查看您在每个页面上花费的时间（如果启用了 阅读统计插件）
• 检查哪些页面有书签、高亮标记和备注
• 像浏览部件一样直接导航到书的任何部分

您可以通过菜单访问书籍地图，还可以分配手势以加快访问速度：

当您在阅读书籍时首次打开书籍地图时，它将处于网格视图模式，将所有章节都显示在一个屏幕上，以提供书籍内容的最佳初始概述。要获取有关使用情况的详细信息，请点击左上角的信息图标。您可以通过点击右上角的 X 或使用任何多滑动手势（上-下、左-右等）来关闭书籍地图。

1. Chapter boundaries
2. Black bars indicate read pages. Higher bars means more time spent in page.
3. Bookmark icon shows bookmarked pages as the name says.
4. Striped square icon shows pages with highlights.
5. Pencil icon shows pages with notes.
6. Numbers in a circle shows your previous locations. When you choose Go back to previous location from the menu, you will jump back here in order.
7. Triangle shows your current page.
8. Vertical scrollbar shows your current view level.
9. Vertical scrollbar shows your current page width level.

您可以通过更改以下选项自定义书籍地图：

- First try swiping LEFT and RIGHT along the bottom edge of the screen to change width of columns indicating pages and observe how it changes the scale of the map.

- 然后尝试沿屏幕左边缘 向上和 向下滑动以更改章节标题深度并切换到 平面视图 。请参阅下面的示例。

除了上面的默认网格视图 之外，您还可以在左侧看到平面视图，在右侧看到没有章节标题的网关视图 。请注意视图之间不断变化的左垂直滚动条。如果要切换回默认视图，可以长按左上角的信息图标。

当您点击书籍地图 屏幕上的菜单图标时，您会看到上面的菜单。菜单选项说明如下：

• 关于地图:书籍地图用法和图标描述的简短说明。
• 可用的手势:可用于更改书籍地图设置的手势，而不是使用此菜单。
• 点击页面浏览器：如果选中此选项，则当您点按画册地图中的页面时，将打开页面浏览器。这将显示所选区域的概览。如果禁用此选项，则在书籍地图中点击会直接将您带到该页面。但请记住，根据您的屏幕尺寸、触摸屏灵敏度、点击准确性等因素，您最终可能会进入相邻页面。
• 切换当前/初始视图： 如果您自定义了书籍地图视图，则点按此按钮将在默认视图和自定义视图之间切换。
• 切换网格/平面视图: 在单独的章节或连续的章节视图之间切换。
• 章节级别： 更改章节/子章节级别的深度。
• 页面槽宽度： 使每个页面槽更宽或更窄。
• 10页一标记:当你增加这个值时，首先它会每10页添加一个标记，然后它会使它们变大，最终它会在每5页添加一个标记。

Page Browser can be used to navigate between pages like in a photo album by showing thumbnails of the pages as a grid. You can open Page Browser by tapping on the Book Map or from the menu. You can also assign a gesture for easier access.

Usage of Page Browser is explained below. You can also tap on the top left corner hamburger menu button on this screen to see these explanations. A long-press on the same button adds/removes chapter titles from the bottom strip.

1. Swipe left / right over this top edge to increase / decrease the number of the columns.
2. Swipe up / down over this left edge to increase / decrease the number of the rows.
3. Swipe the pages area to move the viewed pages. Up / down to scroll one row (2 pages in the example), left / right to scroll one screen (4 pages in the example).
4. Tap any page to open that page in reading view.
5. On the bottom area, tapping on a page focuses the thumbnail view on that page. Swiping left / right will jump one stripe width.
6. Icons on the bottom area are same as the ones used in Book Map and explained under that section.

书籍地图和页面浏览器有一个不同的着色方案的 替代主题，你可以从他们的汉堡包菜单中激活。这个主题为章节标题使用交替的颜色，因此章节边界在书籍地图和页面浏览器中更加明显。但是在这个主题中使用灰色需要闪烁到黑色，所以它可能会分散一些用户的注意力。你可以两种都试试，用你喜欢的那个。

你遇到的一些电子书可能没有合适的目录（ToC）。根据本书的准备情况，您可能会遇到这些目录问题：

• 书中没有目录，所以你不能在章节之间跳转，也看不到剩余的阅读时间
• 有一个目录，但它不是很有用，因为它有错误或缺失的章节标题

KOReader有一些功能，可以在阅读目录部分有问题的书籍时使用。

请注意，备用目录 在固定版面文档（如 PDF、DJVU 等）上不可用，因为它需要 HTML 标签来创建目录。 自定义目录和 自定义隐藏流功能适用于所有文件类型。

第一个功能是 备用目录，你可以在以下位置找到它：

备用目录尝试从书籍中的标题（EPUB 中 HTML 文件中的 H1 到 H6 标签）创建目录。如果您的书不包含任何标题，它将尝试从文档片段（EPUB 书中的单个 HTML 文件）构建一个目录，该目录将指向每个文件的开头。

您可以从此菜单中选择要在目录中包含（或忽略）的标题级别：

自定义目录功能允许您从书籍的选定部分创建自己的目录。此目录只能包含一个级别，因此在使用此功能时不能有子章节。要创建自己的目录，请首先启用：

启用此功能后，新菜单项将添加到用户界面中，允许您选择章节。您可以从两个位置向目录添加章节：

1. 从突出显示中：阅读书籍时，选择文本，就像突出显示它一样，或长按单词。在弹出菜单中，您将看到开始目录章节项。当您按下它时，您将看到一个对话框，要求您输入章节标题。您选择的文本将已输入到对话框中。如有必要，编辑标题，然后点击创建。
2. 从页面浏览器: 通过打开页面浏览器

长按要成为章节开头的页面缩略图，然后在弹出菜单中选择启动目录章节 项。您将看到一个对话框，要求您输入章节标题。

创建完目录后，如果不想看到这些额外的按钮，可以通过取消选中来禁用它们：

创建此目录不会改变书中附带的原始目录。您可以从同一菜单中清除自定义目录（如果您想创建新的目录）。如果您想返回到原始目录，则可以以启用它的相同方式完全禁用该功能。请注意，如果在创建自定义目录以返回到原始目录后禁用此功能，则不会删除自定义目录。您仍然可以在原始目录和自定义目录之间切换。

有些书或文件可能包含很长的脚注或参考书目部分。就像一本250页长的科学书籍，但最后50页是附录，索引和参考文献。通常这些页面包含在进度条和阅读时间计算中，因为它们是书的一部分。但通常这些部分是作为参考而存在的，它们不会被完全阅读，所以您可能想要排除它们，以使您的剩余页数和时间估计更准确。或者你有一本选集，里面有一些你已经读过的故事。自定义隐藏流 KOReader的功能允许您排除书中的这些部分。

请查看该图像以了解该过程的概述。步骤将在图片后解释：

How to exclude a section by creating a hidden flow:

1. 转到要排除的部分的第一页
2. 通过 页面浏览器 打开:
   TOP MENU / / Page browser
3. 长按要作为排除部分开头的页面缩略图，然后从弹出菜单中选择在这里启动隐藏流项。
4. 您将看到从您的选择开始的页面现在有一个灰色的阴影背景。
5. 现在转到被排除的部分的最后一页。你可以从页面浏览器r或使用其他方式，如书籍地图，浏览小部件等导航。
6. 到达已排除部分的最后一页后，请再次打开页面浏览器（如果您尚未进入）。
7. 找到要隐藏部分的最后一页，然后长按下一页.。从弹出菜单中选择在此重新启动常规流。你会看到其余页面的背景将恢复正常颜色，表明隐藏流的结束和常规流的开始。

Working with the hidden sections:

当您如上所述创建隐藏的流部分时，KOReader 的行为将类似于您通过剪切来删除纸质书的一部分的情况：

• 翻页时将跳过这些隐藏的流部分。例如，假设您为第 10 章创建了一个隐藏流程。现在您已进入第 9 章的最后一页。当你翻页时，你会看到第 11 章。
• 页面编号将继续，就像这些隐藏的流部分不存在一样。
• 这些隐藏的部分将不会显示在进度条中（但请阅读下面的解释），并且不会在计算阅读时间被考虑。但是它们在浏览小部件中仍然是可见的。
• 直接链接到这些隐藏流部分中包含的页面仍然有效。此外，您还可以从目录、书籍地图、页面浏览器、浏览小部件访问这些部分。

正如我们上面所说的，隐藏流将被排除在进度条中。但是，如果您使用上面提到的任何方法跳转到一个隐藏部分，您的进度条将暂时成为这个隐藏部分的进度条。您可以将其想象为进度条正在缩小到隐藏的流程部分。如果您通过翻页退出这个隐藏部分，或者使用其他导航工具，您的进度条将再次返回显示整本书（您的自定义隐藏流再次不可见）。

Removing and cleaning up hidden sections:

您可以从页面浏览器中删除单个隐藏流部分，方法与创建它们的方法相同。您也可以使用菜单项一次清除所有这些选项：

当您通过将页面标记为开始隐藏流或重新开始常规流来创建隐藏流时，以前创建的一些隐藏流可能不再有效。例如，在您使开始隐藏流比现有的开始隐藏流早几页的情况下，现有的开始隐藏流将不再涉及。出于实用目的，这种重叠或过时的标签被记住。同样在前面的例子中，如果您在已经存在但不再涉及的开始隐藏流之前结束第二个隐藏流，那么这个停用的隐藏流将再次涉及。如果这些非活动标记干扰您的自定义流程，或者在您完成隐藏流程并对结果满意后，您可以清除所有这些非活动标记:

In some reader applications, when you change a setting let's say the font used for books, it changes globally. Which means, if you change the default font to Verdana, any books you open next including the ones you are already reading will be shown in this Verdana font.

KOReader's approach is different from this. We save appearance settings per book. This gives you the flexibility to change your settings for the current book without affecting others. For example if you have some fantasy books, you can change the font to a medieval looking one just for these books. Or you can set some books to open in landscape orientation or double column mode.

To change a setting globally, tap and hold an option or menu item (font weight, line spacing etc.), to set its value as default. This new value will only be applied to books opened from now on as we said above. Previously opened books will keep their settings. You can identify default values as a star (★) in the menu or as a black border around the indicators as seen below:

So when you adjust your document defaults like default line spacing or default contrast, this new value will only be used for the new documents you open after the change. Your already opened books will not change.

But what if you want them to change too? For example, if you change your default font, you will probably adjust font weight and line spacing to more suitable values for this new font. You are satisfied with how the text looks and now you want all your books to look like this. With this feature you don’t need to change these values manually in all your opened books.

通过选择以下选项，您可以轻松地将这些更改应用到已经打开的图书:

When you tap this option, your current book settings will change to the latest defaults you have set. Don’t worry, this will only change the appearance of the book. Your reading position, highlights, notes and bookmarks will be preserved.

当您根据自己的喜好调整书籍时，例如通过更改 行距、 字体对比度等。您可以一次将所有更改保存为 默认值。然后，如上所述，您可以使用 将文档设置重置为默认值选项将这些设置应用于其他书籍。

通过选择以下选项，可以将您的更改保存为默认值 :

This powerful feature allows you to save all the BOTTOM MENU settings + font type as a profile. This means you can have different group of settings for different conditions or book types which you can apply at once instead of changing the settings manually every time.

For example you can create:

• 双列配置带有两列小尺寸文本，横向和最小边距
• 夜间模式 配置：更大的无衬线字体 和高对比 提供在弱光下更清晰的文字
• 禁用样式 配置： 对结构混乱的书籍禁用内嵌样式和内嵌字体

根据自己的喜好调整设置后，您可以通过它们创建一个配置文件：

在创建了带有您设置的配置文件后，您有很多方式可以将其应用到另一本书中：

• 您可以从配置文件菜单应用配置文件
• You can assign a gesture to it
• 您可以在您的快捷菜单中显示它

Click here to go to the QUICK MENU AND PROFILES section of the guide.

KOReader supports fonts in most widely used TrueType (.ttf) and OpenType formats (.otf). Font files with these extensions can be directly copied to /koreader/fonts/ folder on your device. Check our wiki for more info.

When starting up, KOReader compiles the available fonts from the font metadata/info and classifies them according to family and weights. This means you can add different weights and variants of a font and KOReader will try to use the most suitable one. Since it takes font family information from metadata, font names are not important when copying to your device. Installed fonts will be available after restarting KOReader.

Here are some example fonts which look good on an e-ink screen. You can find more of them on the Google Fonts website:

衬线:

• Spectral
• Vollkorn
• EB Garamond

无衬线:

• Varela Round
• Wix Madefor Text
• Maven Pro (User guide font you are currently reading)

等宽:

If you are planning to use your own monospace font, probably you already have a favorite one, so we are not offering any examples here. But you can find and compare many monospace fonts at programmingfonts.org

If your book includes parts with Monospace fonts (like in programming books), Monospace text might look disproportional even if it is technically at the same size as the rest of the book. This is caused by differing font metrics. KOReader has an option that allows you to adjust the relative Monospace font size to fix this difference:

在这里，您可以通过调整其按默认大小的百分比缩放来增加或减少等宽字体的大小。

在基于HTML/CSS的文档（如epub）中，图书可以根据字体系列而不是特定的字体名称来指定使用字体。这些家族可以是衬线体、无衬线体、等宽字体、草书、梦幻、表情符号、仿宋和公式。例如，在一本书中，普通文本可以显示为无衬线体，而对话则显示为衬线体字体。KOReader通常对所有这些家族使用默认字体，除了等宽和公式（这由文本节点的样式决定，例如'font-family: serif'）。如果你想让这些家族看起来不同，你可以在这里为它们指定特定的字体：

To change a family font for the current book just tap on the desired font name. If you want to set this for all your books, long-tap to set it as a default (★). If a book abuses this font family feature to the point where your default font is hardly used, you can disable that family font for this book by unchecking the association.

如果您经常在字体之间切换（如：编程书籍使用等宽字体，小说使用衬线字体），有一种解决方法比每次进入菜单更容易。您可以为字体和所有与字体相关的设置（如行距、对比度、粗体）创建配置文件，并将这些配置文件添加到快速菜单中。因此，只需一个手势，您就可以打开字体选择菜单并更改字体，如下图所示：

点击本指南的 快捷菜单和配置了解如何执行此操作。

!!! ADVANCED

Style tweaks feature of KOReader allows you to modify how your book is rendered by KOReader. We won't go through a full CSS course here. We just want to show you the basics so when you see a style tweak, you will at least have a rough idea what it does.

We can describe an EPUB document as a HTML file + some CSS rules. These CSS rules determine how different parts of the book (headings, bold text, quotes etc.) will be shown on a reader app. With style tweaks, you can change how your book will be rendered by adding new rules and/or overriding the rules written by the publisher that is embedded in your book.

Let's see this on an example style tweak:

img { width: 10px !important; height: 10px !important }

In plain language this rule says: "Ignore their original size and make all the images in this book 10 pixels wide and 10 pixels high." So if you add this style tweak to KOReader, all the images in your book will be shown tiny.

Now lets explain this tweak item by item:

• img - This is a CSS selector that targets all img (image) elements in the book.
• { width: 10px !important; height: 10px !important; } - This is the declaration block. It contains the styles which will be applied to the selected img elements.
• width: 10px !important; - This first part sets the width of the targeted img elements to 10 pixels. The !important declaration is an override switch which ensures that your width value takes precedence over any other existing width declaration applied to these images.
• height: 10px !important; - This part sets the height of the targeted img elements to 10 pixels. Again, the The !important declaration is an override switch which ensures that your width value takes precedence over any other existing height declaration applied to these images.

In summary, this CSS rule is designed to set a fixed width and height of 10 pixels for all img elements in your book, ignoring their original style.

These are some useful style tweaks that you can use directly or modify according to your liking. Next heading explains how to use them in KOReader.

• Add a separator line above each heading in a book:

  H1, H2, H3, H4 { border-top: 2px solid black; }

• Add some margin above the headings:

  H1, H2, H3, H4 { margin-top: 2em !important; }

• Or if the book have too much margin above the headings, remove them:

  H1, H2, H3, H4 { margin-top: 0 !important; }

• Add a small gap between paragraphs to make the text more readable:

  p + p { margin-top: 0.5em !important; margin-bottom: 0.5em !important; }

• Disable all images in an EPUB:

  img { display: none !important; }

• Make images very small instead of disabling them:

  img { width: 10px !important; height: 10px !important }

• Make the code block sections in computer science books tidier and more readable (Here you can see an example):

  pre,code { font-size: 0.6em !important; line-height: 1.8em !important; background-color: #eee !important; margin: 1em 0 !important; padding: 1em 0 !important; }

Ok, now we have seen what style tweaks are. But how can we use them? There are three types of style tweaks in KOReader:

This heading is new, and the screenshot above and below. Anything to add?

These tweaks are included in KOReader. They are the easiest to use since you just enable them from the menu to use them. You don't need to write any CSS code:

They come in many categories. To apply a tweak to the current book only, tick the checkbox. If you want to get more information about this tweak or enable it for all the books, long-press on its name. A dialog will appear:

1. This area shows the name and description of the tweak
2. This box shows the CSS code of the tweak. You can tap on this area to copy the code to the clipboard. Then you can paste and modify this code in your Book-specific tweak as explained under the next heading.
3. Show in action list button allows you to toggle this tweak with a gesture or add it to a Quick Menu. See the heading named "How to use tweaks efficiently" below for more info.
4. Use on all books button activate this tweak for all your books. A star (★) will appear next to its name in the menu, indicating that this tweak will be applied to all books. You can disable this with the same steps.

As you can guess from its name, this type of tweaks are only active for the book which you created them in. This feature is more useful for testing your tweaks or if you need to fix something on the current book and you know that you won't need it on other books. After creating this type of tweak, if you decide that you will need it on other books too (i.e. from the same publisher), you can convert it to a user style tweak, which we will explain next.

To create a book specific tweak, use the integrated editor which you can find here:

These group of tweaks are different from the previous ones in the way they are created. Also unlike the previous type, they are not limited to a single book. They can be applied globally to all of your books.

Procedure is roughly like this, which we will explain in detail:

1. Create your user tweak file
2. Transfer it to your device
3. Enable your tweak from the menu

1. Creating the user tweak file:

A user style tweak is actually a normal text file with a .css extension. You can create this file:

• On your computer
• On your device if it has a text editor (like Android OS based devices)
• In KOReader's integrated text editor which you can find in plugins

You can copy / paste the examples we mentioned above to your file.

2. Transferring the file to your device:

After creating the file(s) which contain your CSS rules, save or transfer them to the styletweaks folder under your KOReader installation. Give the files descriptive names because filename will be the title of the tweak in the KOReader menu system. You can use underscores "_" in your filenames, they will be treated as spaces in the menu. You need to restart KOReader after transferring your files so it can load them.

2. Enabling the tweak:

After the restart, open a book and go to this menu:

Now you should see your tweak in the list with a checkbox next to it. To apply your tweak to the current book only, tick the checkbox. If you want this tweak to be enabled for all the books, long-press on its name. A dialog will appear. Tap the menu item Use on all books. A star (★) will appear next to its name in the menu, indicating that this tweak will be applied to all books. You can disable this with the same steps. See below for an example:

In the image above, I have 3 style tweak files in the styletweaks folder under my KOReader installation. First one is disabled because checkbox is empty. Second one is enabled for this book only since checkbox is marked but there is no star. Third one is enabled for all the books (★).

You might notice that there is also a right triangle icon next to the first tweak. This means that this tweak can be activated using gestures. This will explained in the next heading.

When creating your user style tweaks you can make multiple tweak files, each modifying some part of the book like in the example image above. You can have one file for the headings, others to modify paragraphs, links etc. This modular system allows you to enable tweaks depending on your document.

As we said above, you can toggle user style tweaks from this menu location:

Also we have easier ways to toggle your style tweaks than going to the menu every time.

1. You can assign a gesture to a tweak

To do this, first we have to add our user style tweak to the list of gesture actions:

• Go to the user style tweaks menu and long-press on your style tweak
• In the dialog press the button Show in action list
• A right triangle icon will appear next to your style tweak in the menu

You can see it in the example image above, next to the Adjust margins style tweak. Now this style tweak is added to the actions list. You can find it under Gesture Manager > Reflowable documents category. It will be at the end of the list.

2. You can add a tweak to your Quick Menu

To add a tweak to your Quick Menu, first it has to be added to the actions list as described in the heading above. Then you can follow the instructions under the Quick Menu section of this guide.

You can even combine both methods and create a special Quick Menu for your style tweaks and then assign it to a gesture. This way, with a simple gesture you can access all your style tweaks and activate them as needed.

Note that in some books, titles might not be in <H1> or <H2> elements, but in something like <p class="tit123">. You can find which selectors are used for a part of text by checking the source. To achieve this, select the text around the element which you are interested in, and choose View HTML from the dialog. In the example above, your style tweak would look like this:

P.tit123 { border-top: 2px solid black; }

instead of this:

H1 { border-top: 2px solid black; }

KOReader gives you options to interact with your book like you can do with a real book. Many settings of the bookmark window can be changed here:

BOOKMARKS:

You can add (and remove) a bookmark by pressing the upper right corner. This is the equivalent of folding the corner of a page on a real book and shows a similar icon when you enable it.

HIGHLIGHTS:

You can highlight text in 4 different styles. In the image below, you can see a normal paragraph followed by different styles of highlights. Lighten (with gray background), Underline, Strikeout and Invert.

你可以同时使用所有这些样式，就像它们是不同颜色的标注一样。或者你可以决定你最喜欢的风格，通过长按这个菜单并将其设置为默认：

Also if you have a device with a color screen, you can create highlights in different colors:

Some tips for color highlights:

• You can change the color of an existing highlight by tapping on it and choosing Color from the popup menu.
• You can combine the colors with different highlight styles like Underline and Strikethrough to create a powerful highlighting system. For example you can use a red strikethrough style for removals or orange underline style for important points etc.

1. In the highlights menu you can long-press on a highlight type to set it as default (★)
2. After selecting a color, you can long-press on the color name in this menu to set that color as default (★)
3. You can press the Apply current style and color to all highlights option to make all the highlights in the current book same. Be careful, there is no undo!

NOTES:

You can also add notes to your highlights. Just tap on a highlight and choose Add note from the popup menu. You can also choose a Note marker that shows which highlights contain a note. There are three styles: Underline, Side line and Side mark (which is the pencil icon shown on the right side of the picture below):

要启用此功能，请选择 笔记标注 样式，转到：

KOReader 针对不同的用例有两种标注显示模式：

常规模式类似于在手机/平板电脑上用手指选择文本，如果你的标注显示短于一页，则更合适。

1. 长按开始单词
2. 把你的手指移到要标注的文字的末尾
3. 松开手指

当您到达页面边界时，KOReader将为您翻页并继续标注（仅在EPUB/HTML文档中）。您可以通过以下方式禁用此功能：

选择并标注模式更适合突出显示跨页的较长段落。如果你的手有触摸屏敏感问题或运动控制问题，它可能会更好。因为在这个标注模式下你不需要在屏幕上拖拽手指。

How to highlight:

1. 在起始词上长按（如果如上所述启用了字典查找，则拖动），将显示弹出菜单。
2. 点击 选择, 现在你处于标注模式。当您处于这种模式时，您将在屏幕的左上角看到一个指示器（您可以点击它以获取更多信息）。您可以通过再次点击开始标注来取消标注。在这种模式下，你可以用轻击/滑动来翻页，并自由浏览文档（目录，略读等）。
3. 长按（如果如上所述启用了字典查找功能，则可以拖拽）最后一个单词作为标注显示，菜单将再次显示。
4. 点击标注完成标注。

This dialog normally opens at the center of the screen. If you want this dialog to open closer to your highlight location, you can change the center option here to gesture position (located on the second page of this menu):

标注时，KOReader 会尝试在您的选择周围包含相关的标点符号。例如，如果您突出显示一个句子的第一个单词到最后一个单词，KOReader 会自动将该句子两端的标点符号添加到您的标注中。

但是，如果您从句子中间开始标注，则末尾的句点将不包括在内，因为 KOReader 假定您想要进行部分标注。所以，如果你想把标点符号添加到你的标注中，一定要选择整个句子。您也可以稍后通过长按编辑标注按钮来添加这些标记。

当你点击一个已经标注的文本(无笔记)，你会看到这个弹出菜单。 删除和 添加笔记项都很清楚。底行菜单项用于扩展或收缩标注。

当你点击一个已经添加了笔记的标注文本时，你会看到这个弹出菜单。点击 编辑标注 打开上面的菜单，您可以在其中编辑标注和包含笔记:

On your Bookmarks page you can filter the view to see only one type of bookmark by pressing the menu icon ( ) You can also filter by highlight style:

In addition to adding a note, KOReader also allows you to edit the highlighted text itself that is shown in your Bookmarks list. In some situations this might be more useful than adding a note to a highlight. For example imagine that you are reviewing a text. You want to highlight a sentence which contains many dates and one of the dates is wrong. When you want add a note to point to this mistake, you need to specify in your note, which one is wrong. But if you edit the text of a highlight, you can directly write "(this date needs to be checked)" next to the problematic date.

Note that this editing doesn't change the book content or the highlighted passage on the page. You will still see the same highlighted sentence in the reader. Your edit will be visible in the Bookmarks list. And when you export your highlights later, edited text will be the one that is exported.

To edit a highlight text, you can:

1. Tap on the highlight
2. Tap Details from the popup menu
3. Tap Edit text from the details dialog

Also you can do it from the Bookmarks window:

1. Go to the Bookmarks list via menu or gesture
2. Long press on the highlight you want to edit
3. Press Edit text in the menu
4. Change the text in the dialog and press the Save button

If you want to revert an edited text to the original highlight, follow the steps above and at the step 3, instead of Edit text, press the Reset text button.

Normally when you open the Bookmarks list, only the content of your highlights are shown. If you added a note to a highlight, you will only see a pencil icon in the Bookmarks list. You can long-press on an item in this list to show (and edit) the added note. If you want to see the note text too in your Bookmarks list you can set it from here:

You can choose to show:

• Only highlight text (default behavior)
• Both highlight text and the note
• Note if there is one, otherwise highlight text

阅读完一本书后，您可以将其移动到特定的文件夹中，以进行存档或处理。启用移动到归档插件，并在插件的设置存档文件夹（设置归档文件夹）。在此之后，您可以使用以下方法将本书移动到归档文件夹中：

• 移动到归档插件菜单
• 用手势或
• 使用快速菜单项

KOReader 提供了不同的方式，从您的阅读器设备导出您的标注和笔记：

这个多功能插件可以将您的标注导出到本地文件或在线服务。

Local export

You can export your highlights to your device in these file formats:

• Text (.txt)
• HTML (.html)
• Markdown (.md)
• Kindle Clippings (.txt)
• JSON (.json)

您可以从以下方式选择您首选的导出格式：

您可以看到导出位置（如果需要，也可以更改它）：

Online services

You can also export to these services over the network:

• Joplin - a note taking application
• Readwise - an online bookmarks/highlights application
• Memos - a self-hosted open source memo hub
• Flomo - an online note taking service
• XMNote - an Android bookmark organizer in Chinese language

You can find detailed setup instructions for these services on our related wiki page.

在选择格式之后，您可以从同一插件菜单中导出当前图书或图书库中的所有书籍的注释。

如果您想只导出您的书库中部分书籍的标注，您可以从文件浏览器中这样做：

1. 在 文件浏览器中选择要导出的书籍
2. 点击右上角的菜单按钮（显示为复选标记）
3. 从显示的菜单中选择导出标注

KoHighlights is an external program that you can install on your computer. It can access your book notes and highlights when you plug your reader to your computer. Check the GitHub project page for download and instructions.

Calibre is an external program that you can install on your computer. You can import highlights into your Calibre database with its KOReader Sync plugin. You can install the mentioned plugin within the Calibre application. Check the project page for download and instructions.

KOReader provides you many ways to read a PDF/DJVU document which is optimized for bigger page sizes (generally A4 or Letter) on your smaller screen device:

1. You can enable Reflow

Reflow tries to extract the text portion from your document (if it is available) and format it as a single column. Results are generally satisfactory. You can also set this as a default by tapping and holding on it.

2. You can enable Zoom To Content

With this option KOReader tries to crop margins from your document so text can look bigger on your screen. You can set fit to width in the same menu which will try to fit only page width instead of whole page, so your text will look bigger.

3. You can try to use your device in Landscape orientation

这将使你的屏幕更宽，这样你的文档可能看起来足够大，阅读舒适。

4. You can zoom to 100 percent size and instead scroll the screen to read different parts

This is especially helpful with comic books. First enable column mode from this menu item:

然后从同一菜单中为文档选择适当的阅读方向：

• 例如，如果您正在阅读一篇有两栏的文章，您会向下滚动至页面末尾阅读左栏，然后转到右上方继续阅读右栏：
  
  
• Or if you are reading a comic book, you will want to go “right / down left / right” in a zigzag pattern:
  
• 对于日本漫画书（从右到左的板块顺序）来说，可能正好相反：
  

在此模式下，您还可以从同一菜单中调整水平/垂直重叠和列数，使文字更适合屏幕显示。请随意尝试这些设置。

Contrast setting adjusts black levels in your document. Be aware that same contrast value applies to both text and images in your document. If you set it very high, your images may become too dark.

Dewatermark removes watermarks from the rendered document. It can also be used to remove gray backgrounds. This feature can convert a grayscale or color document to black & white to produce more contrast for easier reading.

Render quality (only active in Reflow mode) sets the quality of text and image extraction processing and output. High is more pleasing but it can be much slower (several seconds for page turn) than default depending on your document. If your PDF/DJVU files are slow, this is the first setting you should check.

---

Document language sets the language that will be used by the OCR engine.

Forced OCR as the name says, forces the use of OCR even if the document has a text layer.

Writing direction (only active in Reflow mode) sets the direction of original document. Set this to RTL for languages like Arabic and Hebrew.

Document columns (only active in Reflow mode) sets the number of text columns in the original document.

---

Auto straighten feature can straighten the pages of a problematic document, for example pages of a PDF which are scanned with an angle. It is available in PDF, DJVU, CBZ/CBT documents and image files. To enable, choose the maximum tilt angle which KOReader will try to correct. If it doesn’t correct you might have to choose a bigger angle. Note that this feature might slow down your reader depending on several factors.

For saving your highlights, you can use the Export highlights feature of KOReader which is explained in a previous section.

If you are making your highlights on a PDF document, KOReader can also save them directly to the PDF file. This can be useful in certain situations because with this method, your highlights become a part of the PDF file. This means you can see them on other applications or platforms without installing KOReader. For example if you are sending a file with highlights to another user, they don't have to install KOReader to see your highlights. You can just send the PDF file with your highlights saved into it and they can open and see them with a compatible PDF reader.

Which PDF readers can show these highlights?

PDF readers generally depend on some standard libraries to render PDF files. Two of the most known PDF libraries are MuPDF and Poppler libraries. KOReader uses the MuPDF library, so the highlights written to PDFs in KOReader are not currently visible on PDF readers which uses the Poppler library. You can find a compatibility list below. ✅ means you can see your KOReader highlights in this application, ❌ means you can't see them. And ⚠️ means the application needs some plugin to show them. List is ordered alphabetically within categories.

Since making highlights for later usage can involve significant effort, if you are planning to use this feature, you should understand how it works in order to avoid frustrating situations.

QUICK SUMMARY: If you want to be able to delete or export your PDF highlights later, you have to copy the .sdr folder associated with your book when you backup or copy your book to other devices. Without this folder, KOReader can still show the saved highlights but it can't know where they are in the file, so it can't modify them. Please continue reading for more information about this.

How normal highlights work in KOReader

When you make a highlight in KOReader, whether the document is an EPUB or PDF, this highlight is written into a settings file. For example if you are reading Alice in Wonderland.epub you will have a folder named Alice in Wonderland.sdr in the same folder as your book. Your highlights will be kept in a file under this .sdr folder. Which means, if you delete this .sdr folder which is associated with your book, you will lose your highlights.

How PDF highlights work in KOReader

PDF highlights feature works a bit different than the description above. As we mentioned before, when you save your PDF highlights, they will be directly written into the PDF file, which means they become a part of the file itself. That's why you can send this PDF to another user and they can see the highlights with a compatible PDF reader. They won't need your .sdr folder which contains a record of your highlights because now the highlights are embedded directly into the PDF file.

Let's explain the problem which can arise when you are using this feature, on an example. Imagine that you are reading a PDF book on your e-reader with KOReader:

1. You are making highlights and Save highlights to PDF option is enabled, so as you make these highlights, KOReader saves them to your PDF file.
2. You want to continue reading the book on your phone with KOReader, so you copy this PDF file from your e-reader to your phone (but you didn't copy the .sdr folder, only the PDF file).
3. When you open the book on your phone with KOReader, you will see that your highlights are still there.

Now the situation on both of your devices looks identical. Both your e-reader and phone KOReader shows the PDF file with the same highlights. But it only looks identical, actually there is a big difference.

KOReader on your e-reader has the knowledge of which highlights in this PDF file are made by KOReader because it has the .sdr folder. But KOReader on your phone doesn't have this knowledge. It only has the PDF file.

Difference arises when you try to delete the pdf highlights or export them. Your e-reader can both delete these PDF highlights and export them. But your phone KOReader can't, because as we said, it doesn't have the .sdr folder of your book so the highlights in the book look like a part of the original book from its point of view.

So in short, if you want to be able to delete or export your PDF highlights later, you have to copy the .sdr folder associated with your book when you backup or copy your book to other devices.

OCR (Optical Character Recognition) is the process of extracting text from images. In KOReader context, it is generally used for extracting text from scanned book pages in PDF files. KOReader relies on Tesseract Open Source OCR Engine for this task.

To use this feature you need to:

1. 安装Tesseract 语言数据到 KOReader
2. 将新安装的语言添加到 koreader/defaults.lua 配置文件中(仅当您的语言不是英语或中文时才需要)

Comic books generally need more frequent page refreshes than the pure text content. For normal text, you can set your page refresh interval to high numbers without problem. But images can leave more residue and cause ghosting, especially depending on the panel of your e-reader.

KOReader allows you to assign any gesture to switch to different refresh rates. For example you can set swipe up left edge for every page refresh when reading comics and set swipe down left edge for every x page refresh for text only books. So when you open a comic, you can switch to more frequent refresh with a simple tap or swipe (or vice versa).

This action is under:

这个功能使得在较小的屏幕上阅读漫画书更加容易。您可以在阅读PDF、DJVU、CBZ或CBT文档时通过以下方式启用它:

When this option is enabled, KOReader tries to find the boundaries of rectangular panels on the screen. If you long-press on a panel, KOReader zooms in and shows just that panel.

As you can guess, this feature works best with comics that has clean panel boundaries. Also there is no page turn in this mode to jump to the next panel due to this boundary problem. You have to close the zoomed in panel and long-press on the next one. To do this, just swipe down this zoomed in panel. Also you can use any multiswipe gesture (any combination of up, down, left, right) to exit this view.

Procedure can be seen below:

如果您想将此功能用于其他文件类型，如EPUB、FB2、HTML或图像文件，您应该使用不同的引擎打开文件：在 文件浏览器中长按文件名， 点击打开方式…并选择 MuPDF.

当您到达一本书的最后一页时，KOReader 会显示一个对话框。在此对话框中，有一个打开下一个文件操作，该操作将打开与当前书籍位于同一目录中的下一个文件。因此，您可以将系列放在单独的目录中，然后一个接一个地读取它们，而无需返回 File 浏览器。

打开下一个文件时，KOReader 会跳过您标记为已阅读的文件。例如，当您有一个包含漫画文件的文件夹并且您已经阅读了其中的一些文件时，此功能非常有用。您可以从上面显示的阅读完成对话框将文件标记为已完成。您也可以从 File Browser 中长按文件来标记它。将它们复制到您的设备后，您可以：

• 在 KOReader 中打开 文件浏览器
• 长按已读完的书籍，然后点击 标记为已阅读

现在，您只需点击本书末尾的打开下一个文件，即可读取所有文件。KOReader 将跳过您已经阅读过的那些书籍。

如果你喜欢在你的电子墨水设备上阅读漫画书，有一些技巧可以让你的体验更好。如果您不满意漫画在设备上的外观，那么准备自己的漫画文件是最好的解决方案。

File types like MOBI and EPUB are not suitable for handling primarily image content (e.g., manga/comics). MOBI support in KOReader is minimal to nonexistent, and EPUB’s text rendering priorities can cause problems when showing full-page images. For further technical details, please visit this GitHub issue.

您最好的选择是构建一个在 KOReader 中效果更好的 CBZ 文件。扩展名为 .cbz 的文件是 zip 文件（无压缩），是图像的集合。它保存多个图像（通常是 .png 或 .jpeg 文件），这些图像组织成漫画的页面。KOReader 还可以打开 CBT 文件，这些文件类似于 CBZ 文件，但使用 TAR 存档格式。

将漫画转换为 CBZ 的最简单方法是从各种网站获取漫画作为图像，然后使用 Kindle Comic Converter (https://github.com/ciromattia/kcc)。进行转换。有一些有用的设置，例如将两页拆分自动旋转为横向和应用抖动，以便 eink 渲染的渐变平滑抖动，而不会出现锯齿状图层。

通过将图像大小调整为与您的电子阅读器屏幕大小完全一致，可以获得最佳效果。特定于屏幕的 CBZ 以设备的确切屏幕大小为目标，可防止在读取期间重新缩放。KOReader 在阅读时将图像缩小到屏幕大小，但不建议这样做，因为 KOReader 在缩放之前会添加抖动通道，这会导致质量损失。

但是，如果您想在多个设备上使用手工制作的 CBZ，或者您想保留高分辨率以备将来使用，那么您最好的选择可能是将 CBZ 用于您的最高分辨率设备。或者选择任意的 “高” 分辨率，可能是与源匹配的分辨率。300 PPI 或更高（最高 450 甚至 600），当然，除非来源更低。如果我们假设屏幕尺寸为 8 英寸，则 1500×2000 是一个很好的目标分辨率。对于较大的图像，您应该在您的设备上试用它，看看它是否可以处理它。尤其是内存不足的旧 Kindle 可能会遇到 3000×4000 等大小。如果要自动执行该过程，则可能值得考虑创建较低和较高质量的版本（例如，200/400 或 300/600 DPI）。

以下是处理一个漫画文件的示例过程：

• 从https://github.com/ciromattia/kcc下载Kindle Comic Converter (KCC)
• 从您选择的来源下载漫画 (如 HakuNeko)
• 解压缩漫画文件。现在应该有一个只包含图像的目录（或包含图像的子目录，没有压缩包）
• 使用KCC处理这个目录。 每个目录将生成一个单独的 CBZ 文件。 因此，如果希望一次生成多个卷，请一次选择多个目录

KCC的一些有用设置:

页面分隔: 此功能检测双页，并允许您将其旋转或剪切为两页。

提高分辨率: 放大小于目标分辨率的图像。

如果您想以更身临其境的方式欣赏您的漫画，请确保在创建 CBZ 文件时在 KCC 中选择与设备屏幕分辨率完全相同的分辨率。此外，您可以在 KOReader 中阅读漫画时隐藏底部进度条。因此，您将拥有无障碍的漫画沉浸式全屏视图。

!!! ADVANCED

使用KCC 创建 CBZ 文件后，您可以对图像应用抖动。这样，墨水屏渲染的渐变将平滑抖动，而不会出现锯齿状图层。此步骤将生成经过微调的漫画卷，在 KOReader 中看起来更好。

你可以使用 ImageMagick 处理你的图片。 ImageMagick是一个功能强大的开源软件套件，用于显示、创建、转换、修改和编辑光栅图像。您可以下载 ImageMagick，并从命令行使用它一次处理多个图像。

1. 解压缩您使用 KCC 创建的准备好的 CBZ 文件，
2. Download the following file dither_pack.zip (located on Yandex Disk) which contains two batch files (.BAT) and a GIF color template.
3. 将这三个文件提取到要处理的图像旁边
4. 编辑 _magick_manga_ditherN_resize.bat ，然后将 Resolution 更改为您的设备分辨率 (在两个 BAT 文件中).

   警告 下一步是将目录中的所有图像替换为处理后的图像。因此，如果您想保留原件，请确保在其他目录中有它们的副本。

5. 运行_magick_manga_ditherN_resize.bat 调整图像大小和抖动。
6. 假设你已安装了 7-Zip ， 运行_batch_archive.bat要将所有处理后的图像打包到 CBZ 压缩包。

!!! ADVANCED

You can make KOReader turn pages from Left to Right, so that swipes and tap zones are swapped. To enable this, add the following lines:

["/storage/emulated/0/Books/manga"] = {
["inverse_reading_order"] = true,
["kopt_zoom_direction"] = 0,
},

to this file:

/koreader/settings/directory_defaults.lua

其中 /storage/emulated/0/Books/manga 是包含漫画的目录的绝对路径。在此更改后，当您从上述目录打开文件时，您的滑动和点击区域将被交换。

You will see the file browser interface when you run KOReader for the first time. It is one of the two main interfaces of KOReader. You will do all your file and folder operations here. You can access it from the reading screen by:

By default, file browser shows your HOME folder, which is your main library folder. You can change this by long-pressing on any folder. You can change file browsers many options like how books are displayed or sorted via the TOP MENU by swiping down from the top part of the screen.

下面将对图片中的圈点项目进行说明：

重置：此选项允许您重置文档的某些属性，如阅读进度、书签、自定义封面图像等，您可以在以下对话框中选择这些属性。

WARNING Be very careful when using the reset dialog and double check which items are marked, otherwise you can reset everything related to your book accidentally.

打开方式：KOReader 有不同的引擎来呈现不同的文件类型。在某些情况下，您可以在不同的引擎中打开文件以获取其他功能。请参阅下面的查看存档文件和查看图像文件部分。

忽略封面：如果出于某种原因，您想禁用这本书的封面（可能封面错误或封面在电子墨水屏幕上不太可读），您可以选择此选项。

忽略元数据：如果您的图书元数据不正确，名称字段可能会显示无用的信息。选择此选项以显示文件名而不是元数据。

刷新缓存的书籍信息：当您将书籍添加到库中时，KOReader会缓存书籍的元数据和书籍封面。如果您在复制到设备后对书籍进行了一些更改，则可能需要更新此信息。如果您看到错误的封面或元数据，可以使用此菜单项刷新书籍信息。

File browser allows you to perform some operations (like copying, moving, deleting, exporting highlights) on many files at the same time. For this procedure, first you have to select the files. Currently there are three different ways of selecting files for bulk operations in the file browser:

- In the first method, long press on a file name and choose Select from the popup dialog. This will activate the Selection mode. Now you can tap on other files to add them to the selection. When you finish selecting your files, tap on the checkmark icon at the top right corner of your screen. You can choose what to do with these files from the dialog. Or exit the selection mode from the same dialog.

- In the second method, press the + (plus) icon at the top right corner and choose Select files from the dialog. This will activate the Selection mode and rest is the same as the first method above.

- In the third method, you can choose your files based on a File search. This is useful if you need to perform an operation on many files distributed in different folders. For example you want to move all files in your collection authored by Tolkien, to a new folder. Steps for this action will be:

1. From the Top menu press on the Search tab (with the magnifier icon) and choose File search.
2. Check Include subfolders option if you want to search inside the folders too. You can check Also search in book metadata if you want KOReader to look in book's metadata. Otherwise KOReader will only look at the file names for the word you entered.
3. You can start the search from your library Home folder or your Current folder by pressing on the respective button.
4. After search is finished, you will see a file list (if your search term is found of course). Now you can tap on the Hamburger icon at the top left corner of the screen to enter the Selection mode.
5. Tap on all the files you want to perform operations on and tap on the Checkmark icon at the top left corner of your screen. You will see a dialog which contains Select in file browser. Select this option.
6. Now you will be back at the File browser and the files you selected in the Search dialog will also be selected here.
7. Tap on the Checkmark icon at the top right corner of your screen. Now you can choose what to do with these files from the dialog.

KOReader允许您将最喜欢的文件夹添加到快速访问的文件夹快捷方式菜单中。例如，如果你有一个Archive文件夹在你的图书馆Home>Articles>Scientific>Archived下，你可以为这个Archived文件夹分配一个文件夹快捷方式，即使在看书的时候也可以快速访问它。

Adding a folder shortcut:

有两种方法可以将文件夹添加到文件夹快捷方式列表中：

1. 当您在文件浏览器中时，点击右上角的+（加号）菜单按钮，然后点击添加到文件夹快捷方式 这将添加您当前所在的文件夹
2. 在文件浏览器中，长按文件夹名称可打开上下文菜单。点击"添加到文件夹快捷方式"项，然后为此快捷方式输入一个描述性名称 这将添加您选择的文件夹

文件夹快捷方式列表中的文件夹将在文件浏览器中有一个星号（★）。

您可以以相同的方式从快捷方式中删除文件夹，方法是长按文件夹并选择从文件夹中删除快捷方式。

Viewing your folder shortcuts:

您可以在阅读书籍时从文件浏览器 或阅读屏幕 打开文件夹快捷方式。

• 从文件浏览器:右上角+(加号)菜单，然后选择 文件夹快捷方式或指定手势。
• 从阅读屏幕:通过向其分配手势。

它位于手势管理器的文件浏览器部分下。您可以在本指南的相关部分了解如何设置手势。

If you have books in .txt format (which is more common in Chinese and Cyrillic languages), you can try enabling the Auto-detect TXT files layout feature. In some cases it can improve the rendering and make the text more "book like". When enabled, the rendering engine will use heuristics (text wrapped under some max line length, single or double blank lines marking paragraphs, indentation or centered text considered heading...) to guess how to better render the text and will try to create a table of contents.

You can enable this feature here (which is visible only if you are reading a .txt file):

Note that this feature might mess up ASCII art drawings and space character based formatting. If your book has these kind of features, it might be better to use the default mode in which, the text file is rendered as is in a monospace font.

KOReader can read files stored/compressed in ZIP files. You can open ZIP, CBZ and EPUB (as they are ZIP archives too) files with the archive viewer to have a look at the contained files:

1. In File Browser long-press the file name
2. Tap Open with…
3. 点击存档查看器

A ZIP file can contain many types of documents like html, txt or images. KOReader can open your ZIP file properly only if you give it a hint for the type of file in the ZIP archive. If you give your file only a .zip extension, KOReader will assume that this archive contains images and try to open it like a CBZ file.

默认情况: yourfilename.zip - 假定为图像的 zip 文件 (并使用 MuPDF 引擎打开)

如果您的 zip 文件包含以下类型之一（而不仅仅是图像），请相应地命名它：

• FictionBook - yourfilename.fb2.zip
• HTML - yourfilename.htm.zip / yourfilename.html.zip
• 文本日志文件 - yourfilename.log.zip
• Markdown - yourfilename.md.zip
• 富文本格式 - yourfilename.rtf.zip
• 纯文本 - yourfilename.txt.zip

如果文档不是这样命名的，则可能使用了错误的读取器/格式引擎，并且您将看到该文件的无读取器引擎或无效的文件 的消息。您可以按照上面的说明重命名该文件，或者长按文件名，然后选择打开方式… 以选择正确的引擎。

您可以使用图像查看器打开图像文件，而不是像书本一样打开。这样打开的文件不会显示在您的历史记录中，并且具有更好的缩放和旋转支持。

1. In File Browser long-press the file name
2. Tap Open with…
3. 点击图像查看器

KOReader provides two options for reading Markdown documents.

1. You can open the document directly like a book by tapping on it. This mode doesn't provide formatting. So your .md file will look like as it is opened in a text editor.
2. You can convert your Markdown document to HTML. This action will render a HTML file from your Markdown document with the correct formatting and a Table of Contents created from the headings.

To convert a .md file, long press on it in the File Browser and tap Convert from the popup menu. A new file with the same name but HTML extension will be created in the same directory. Be aware that conversion might take a while depending on your Markdown file and device speed.

您还可以为KOReader无法自动识别的文件类型设置文件关联。要将文件与KOReader提供程序之一相关联，请首先在文件浏览器中长按您的文件，然后选择一个程序引擎来处理此文件。您可以选择：

• 始终对此文件使用此引擎仅将此提供程序与此特定文件相关联
• Or check Always use this engine for file type to associate this provider with all the files that has same extension as this one
• From the same dialog, you can see the associations you made by tapping on View defaults for file types

KOReader's Collections feature can help you with arranging your library more efficiently. As a very simple definition, collections are user created lists of your books. For example you can create two collections named Fiction and Non-Fiction to arrange your books accordingly. Of course you can also use folders to do this but using collections gives you more flexibility.

Some advantages of collections compared to the folder based organization:

• Adding a book to a collection doesn't move the book file. So your books can be located in different folders but they can appear in the same collection.
• One book can be in many collections, which is not possible with folders. For example you can have a Science Fiction collection and War Fiction collection. A book can be added to both of these collections at the same time.
• You can trigger profiles with collections. This will be explained below if you are not familiar with the profiles feature of KOReader. (Of course you can trigger profiles with folders too but collections doesn't require you to move your books in order to use temporary profiles for example.)

You can create collections to mirror any kind of categorization. Some example ideas:

• Genres: Fiction, non-fiction, memoir...
• Book status: Currently reading, want to read, next, did not finish...
• Series: Lord of the Rings, Harry Potter...
• Document type: Books, scientific articles, web articles...

You can create collections from the Collections dialog located here:

You can access this dialog from the reader view or from the File Browser. When you open this menu, it will show you a list of your collections. By default you will see Favorites there as a collection item which includes the books you have already added to your Favorites list.

• Adding a new collection: Use the hamburger menu located at the top left corner of this screen > New collection
• Removing a collection: Long tap on the collection name > Remove collection
• Renaming a collection: Long tap on the collection name > Rename collection
• Changing the order of your collections: Use the hamburger menu located at the top left corner of this screen > Arrange collection

There are three different places in KOReader where you can add books to your collections:

1. From the File Browser and History screen

You can add a book to your collections from the File browser or History screen. From the History screen you can add books one at a time. Long press on the book and choose Collections.... Then you can choose which collection(s) you want to add this book to.

If you are adding several books, you can do this from the File browser. For multiple books this is the procedure:

1. Long press on a book
2. Choose Select from the popup menu
3. Select other books
4. Tap the checkmark (✔️) icon at the top-right corner
5. Tap Collections

For adding a single book, just long-press on it in the File browser and choose Collections from the popup menu.

2. From the Collections menu

This method allows you to add single and multiple books to your Collections. Biggest difference from the File browser method is that you can add whole folders and their subfolders to your collections at once. This is very useful if your books are already arranged in folders. For example if all your science fiction books are in a single folder, you can create a collection named Science fiction and add this folder at once.

In the image above, Box 1 shows the book adding options. You can reach this menu from the collections screen's hamburger menu:

• Add all books from a folder: As its name says, this options allows you to select a folder to add all the books in it to this collection. Note that this option doesn't add the books in subfolders of the chosen folder. For example if you select your Fiction folder and you have folders named Science Fiction and War Fiction under it, they won't be added with this option.
• Add all books from a folder and its subfolders: This is the option that will add all the subfolders of your chosen folder. Be careful with this option because it will go down all the way while adding the books. So if you have many levels of nested folders, there might be too many books than you thought.
• Add a book to collection: This is the basic option that will allow you to add a single book.

You can remove a book from collections from the File browser, History screen or the Collections screen. In the File browser and History screens, long press on the book and choose Collections.... You will see a checkmark next to the collections that you added this book to. Uncheck the ones by tapping on it to remove the book from that collection. Also from the Collections screen, you can long press on a book and choose Remove from collection.

Collections can be very crowded but KOReader allows you to find your books easily by providing many filtering options. If you look at the image above, you can see the filtering options in Box 2 and Box 3. Box 2 allows you to filter by book status (new, reading, finished, on hold) and Box 3 allows you to filter by book metadata (author, series, language, keywords). And also you can combine these two groups of filters like this example: "Show me the new books in this collection which are written by Isaac Asimov (Filter by authors -> Isaac Asimov) that I haven't started yet (Filter by status -> New)."

You can update the book metadata by long-pressing on the book in File browser and choosing Book information from the menu. In the popup window you can long-press on any field to change the metadata like author or keywords. You can also use Calibre for this task, a third-party application which makes managing your book metadata much easier.

There are two types of search you can perform in collections: You can search for a phrase in the book titles and metadata or you can also search inside the book texts. You can open the search dialog from:

If you want to perform a search in the book texts, please keep these points in mind:

• This type of search is only available if you open the collections from the file browser. It is not available from the reading screen.
• This search can be slow (around 2 seconds per book in the collection). So if you have a crowded collection, it might take a long time.

Search function depends on where you are in the collections window. If you are at the root level where you can see all your collections, search will be performed on all collections. If you want to search only in a specific collection, you have to tap and enter the collection. This is especially important if you are also searching in the book texts because it is a slow operation.

When you perform a search, results will be automatically saved as a new collection.

After creating your collections and adding books to them, you will probably want to keep them in sync with some folders. For example imagine that you created a Science Fiction collection. And you also have a SF folder in your library where you put your science fiction books. If you want to make the science fiction collection update itself when you add a new file to this folder, you can do it with connected folders feature of the collections.

With this feature you can connect one or more folders to your collection. After that, KOReader will (re)scan the folders to add or remove books from your collections in these conditions:

• When connecting a folder to a collection
• When including subfolders of a connected folder
• When showing the collection
• On program start

How to connect a folder to your collection:

1. Go to the Collections screen that is seen in the image above.
2. Long-press on the collection name which you want to connect folders (1).
3. Select Connect folders from the pop-up menu (2).
4. List of connected folders screen will open.
5. Add a folder by pressing the PLUS icon at the top left corner of that screen, which will open the Folder chooser screen.
6. Repeat the last item if you want to connect more folders.

Collections with connected folders will have a folder icon as you can see from the image above (3).

You might want to include subfolders of a folder too for synchronization. In the step 4 above, when you open the List of connected folders screen, you can long-press on a folder to include/exclude subfolders from the popup menu.

How to disconnect a folder from your collection:

1. Go to the Collections screen that is seen in the image above.
2. Long-press on the collection name which you want to connect folders (1).
3. Select Connect folders from the pop-up menu (2).
4. List of connected folders screen will open.
5. Long-press on the folder which you want to disconnect and choose Disconnect folder from the popup menu.

Your collections can be used with the profiles feature of KOReader. If you don't know about profiles yet, here is a description from our Profiles section:

A profile is basically a set of actions that can be triggered with a single gesture (like a macro).

As an example, imagine that when reading some type of books, you always:

• Rotate the screen to landscape orientation
• Increase the font size and contrast and
• Turn the screen light on

With the profiles plugin, you can do all these at once with a single action.

You can run a profile manually but real power of profiles can be unleashed with its auto-execute feature. Using this feature, you can trigger a profile depending on some conditions. Here is the link to the relevant section of the guide: Profile auto-execution. For now we will just explain one trigger condition here: Collections.

Basically you can create some profiles and set them to auto-execute if an opened book is in some specific collection. Some useful examples:

• You can add all your manga to a Manga collection and make a profile to switch the page turn direction to Right-To-Left and to invert page turn taps and swipes when you open a manga book from this collection.
• You can add your comic books to a collection, which can trigger a profile to decrease the screen refresh interval to every page to avoid ghosting.
• You can add your problematic PDFs to a collection, so when you open them Auto OCR or Reflow mode is activated with a profile.

KOReader can reflow PDF documents (this option can be found in the bottom menu while reading a fixed-layout document like PDF) to make them suitable for the small screens of e-readers. But for best results, you may want to convert your documents into more flexible EPUB format.

用于为移动阅读设备转换或优化文档的最广泛使用的应用程序是Calibre （针对EPUB， Kindle）和K2pdfopt（针对PDF ）。

Calibre can convert your documents between many formats. It also has a built-in editor that allows you to edit e-books (and fix problems) in the most popular e-book formats, EPUB and Kindle.

K2pdfopt optimizes PDF/DJVU files for mobile e-readers and smartphones. It works well on multi-column PDF/DJVU files and can re-flow text even on scanned PDF files. It can also be used as a general PDF copying/cropping/re-sizing/OCR-ing manipulation tool.

OCRmyPDF is a command line application which can add an OCR text layer to scanned PDF files (containing only images without text), allowing them to be searched or copy-pasted. It can especially be useful for reading old scanned books. It can also optimize the images for a smaller file size.

SingleFile is a browser extension for Mozilla Firefox, Google Chrome and Microsoft Edge. This extension allows saving a web page as a single .html file with all the resources (images, stylesheets, scripts) embedded.

!!! ADVANCED

KOReader stores settings and extra information related to your books in the same directory as your book file. We call this metadata and it includes:

• Visual settings for the book
• Book reading progress
• Highlights, bookmarks and notes

In a recent change, we added new ways of storing this metadata to solve certain problems related to synchronization between devices. Currently there are three different methods to store the metadata and each method has its own benefits/negatives.

You can change this setting from this menu:

This is the default method used on a new installation of KOReader. In this method, when you copy Alice in Wonderland.epub to your device and open it for the first time, a folder named Alice in Wonderland.sdr will be created in the same directory. This directory contains the files for your settings, annotations and book progress for this book.

Benefits

• You can manually backup and restore the settings for each book.
• When you perform directory synchronization or backups with a system like Syncthing or Dropbox, your settings will be synchronized alongside your books.
• You can rename the parent directories where your book resides, this doesn't confuse KOReader.

Negatives

• If you reorganize your library by moving/renaming the book files or their accompanying .sdr folder outside of KOReader file browser, you will lose metadata of those books without any warning.
• These .sdr folders will be visible when you browse your library directories with another file browser or from your computer, which may clutter your view.

This method is essentially same as the default one above. The difference is, in this method, all .sdr folders of your books will be under a single directory which is under the KOReader main directory structure, instead of your library directory, next to the book files.

Benefits

• Book .sdr folders will only be visible to and used by KOReader. They won't clutter your view of your library directories when you browse your library with another file browser or from your computer.

Negatives

• If you reorganize your library by moving/renaming the moving/renaming library directories, book files or their accompanying .sdr folder outside of KOReader file browser, you will lose metadata of those books without any warning.
• Since your book metadata will not be in your library folders, any synchronization or backups of your library will not include them.

This method is similar to the previous one as the .sdr folders will be under an internal directory. But this method is developed to address the shortcomings of the previous method. Because, normally if you rename a book outside KOReader (with the native file manager/reader of the device or from a connected computer), its .sdr folder name will no longer match and your metadata for that book will be lost. If you are only using the KOReader File Browser for file operations, this is automatically handled so there are no repercussions.

In this HASHED method, .sdr folders are not identified by the filepath/filename of the book. Instead, a partial MD5 hash will be used to link the books to their settings. This hash is used as a unique ID for the book and it is calculated based on the contents of the book file. Also same hash is used for naming its .sdr folder.

Benefits

• Book .sdr folders will only be visible to and used by KOReader. They won't clutter your view of your library directories when you browse your library directories with another file browser or from your computer.
• You can rename, move, and copy your books with another file browser or from your computer. KOReader will still recognize the books after these operations.
• In this method, KOReader associates the same .sdr folder with all copies of the book, even if these copies are on different devices. For example if you are using Syncthing, this method enables you to sync your /hashdocsettings folder alongside your book files, across many devices that all have KOReader installed. Despite the different relative paths of those books on each device, you can still get your annotations and progress synchronized across your devices. This isn't possible with other methods.

Negatives

• Any operations that modify the file directly (such as writing highlights into PDFs or downloading from Calibre) will change the file so its MD5 ID will change (unlike renaming or moving which is safe with this method). In this case KOReader wouldn't be able to recognize the book so these books will lose their metadata.
• Calculating file IDs may slow down File browser navigation when browsing larger directories.

有许多类型的手势可以用来控制KOReader。有些手势在屏幕上可以使用的位置和支持的方向上有限制。这些限制说明如下。

	点击/双击 用一个手指单次或两次点击 WORKS: Anywhere on the screen
	点按 用单个手指点击并按住 WORKS: Only on four corners
	两指触摸 使用两个手指同时触摸 WORKS: Only on four corners
	展开和捏紧 Same as zooming in and out on a phone or tablet. WORKS: Anywhere on the screen 信息 根据你的设备，这个手势可能不太可靠。如果是这种情况，请选择另一种手势类型。
	ONE FINGER SWIPE 使用一个手指进行滑动 工作区: 屏幕边缘(水平或垂直) 的任意位置，除边框 (对角线)
	两指滑动 两个手指同时滑动 WORKS: Anywhere on the screen
	MULTISWIPE 在不抬起手指的情况下，一个接一个地进行多次滑动。比如画字母U（下-右-上） WORKS: Anywhere on the screen
	Econceptive图标来自 Noun Project

This table shows the gestures that comes with KOReader. You can change these gestures according to your preferences via:

这是您可以使用 手势管理菜单分配给手势的每个操作的列表。您可以使用浏览器的搜索功能（通常为 Ctrl+F）在此处搜索操作。这些操作也可以在您自己的快速菜单中使用。请查看指南中的相关部分以获取更多信息。

If you have a device with a keyboard like Kindle 2 and Kindle 3, including Bluetooth keyboards and emulators, you can use the keyboard keys, device buttons and shortcuts to control KOReader. Kindle 4 is supported too, which lacks a full keyboard but still has enough buttons to make it functional in this context. On these devices, KOReader will enable an extra menu named Keyboard Shortcuts which you can access here:

This menu is very similar to the Gesture Manager interface. In this menu:

• You can see the shortcuts that are available on your device
• You can see the predefined actions for some shortcuts
• You can assign actions to the available shortcuts

All of the actions in the Gesture Manager is also available for keyboard shortcut assignment. Which means you can control nearly all the functions of KOReader with these shortcuts.

In the table below, you can see the default key and shortcut assignments:

Quick Menu is a recent feature of KOReader which allows you to have a quickly accessible personalized menu as in the example image below. You can assign this menu to a gesture and access it with a single swipe. You can even have a menu longer than your screen, it is scrollable.

基本上，可以分配手势的任何操作都可以添加到快速菜单中。其优点是：

1. 你不需要记住每个动作的许多手势。
2. 一些不常见的动作可能不值得分配一个手势，但在菜单系统中查找它可能会非常麻烦。您可以将这种很少使用的操作添加到此菜单中。
3. 如果您正在为亲戚或朋友安装KOReader，您可以将他们最喜欢的操作添加到此菜单中，以便他们在使用KOReader时甚至不需要进入菜单系统。

快速菜单示例：

There are two methods of creating a Quick Menu: Easy and Advanced. If you need only one menu, Easy method should be enough for you. If you want to show different menus with different gestures you need to use Advanced method. Another advantage of Advanced method is easier gesture reassignment. If you want to change the gesture for your menu, you can easily move it to another gesture with the Advanced method menu. If you want to use another gesture while using the Easy method, you have to re-create your menu under the new gesture.

1. 转到手势管理菜单:
   TOP MENU / / Taps and Gestures / Gesture Manager
2. 决定一个打开菜单的手势并点击它。
3. 从手势配置菜单中选择您想要在菜单中看到的动作。当然，你可以一次选择很多动作。
4. 选择完所有的动作后，你会告诉KOReader把这个手势当成菜单。您可以通过在第二页上启用显示为快速菜单项来实现这一点，如下图所示。
5. 您可以使用 排序选项对菜单项进行排序。

现在你可以用你选择的手势启动你的菜单。如果要更改菜单项，可以打开手势页面并添加/删除项。

This Quick Menu is actually a Profile which appears on your screen as a menu. So first you have to learn about Profiles. If you already know how to use them, you can continue reading, otherwise jump to the Profiles heading (next section), create a Profile with some items and come back here.

Before continuing, we assume that you already created a Profile as instructed in the previous paragraph. Now we will turn our Profile into a Quick Menu.

1. Go to your newly created Profile and enable Show in action list (shown in the image below). This will make your Profile visible in the Gesture Manager. Also enable Show as Quick Menu (also in the image below) so your profile will be shown as a menu instead of being silently executed.

2. Now we need a way to access our menu. Go to the Gesture Manager and choose a gesture from the list to assign to our menu. Let’s say we want to tap the corner of the screen to show menu. Now tap on Tap corner then choose Bottom left. Now tap on General and go to the second page. You will find your profile as Profile x where x is the name you gave to this Profile. Tap on its checkbox to assign your profile to this gesture.

完成所有步骤后，现在当您点击左下角时，应该会看到您的菜单。您可以通过转到其 配置文件页面来编辑菜单，您可以在其中添加或删除项目。此外，那里还有一个排序项，因此您可以更改菜单项的顺序。

如前所述，快速菜单实际上是一个配置文件。这意味着您可以有多个菜单。如果需要，可以创建另一个配置文件，并按照相同的步骤创建另一菜单。

通常，在快速菜单中选择项目后，菜单会从屏幕上消失。有时，您可能希望在选择项目后保持菜单打开。这允许您像以下示例一样调整设置：

• 增量修改，如亮度增加/减少、增大/减小字体、上一页/下一页或章节等。
• 您可以连续激活(但不是同时激活)的一组选项，比如打开wifi，然后启动SSH服务器

如果您有基于手势管理器(简单模式)的快捷菜单，您可以从以下菜单中启用此选项:

或者，如果您有基于配置文件的 –（高级方法）快速菜单：

Normally Quick Menu opens centered at the middle of the screen. If you are using your e-reader with one hand, you can activate a setting which will open your menu at the gesture position. This way, menu will be closer to your finger and easier to access. To use this feature enable this option:

A profile is basically a collection of actions that can be triggered with a single gesture (like a macro).

As an example, imagine that when reading some type of books, you always:

• Rotate the screen to landscape orientation
• Increase the font size and contrast and
• Turn the screen light on

With the profiles plugin, you can do all these at once with a single action.

要创建配置文件，首先确保配置文件插件已激活。如果您在下面看不到它：

然后必须从以下位置打开：

在 配置文件菜单中，轻触 新建 ，并为配置文件提供描述性名称。现在，您应该可以在菜单中看到新的配置文件。轻触它，您将看到左侧的屏幕。您还可以从此菜单中删除、重命名或复制配置文件。

当您点击编辑操作菜单项时，您将看到右侧的菜单。这与手势选择菜单相同，并且在许多类别中都有动作。这意味着您可以使用配置文件执行任何手势动作。

现在，您可以从所有这些类别中选择多个项目。激活此配置文件时，将执行您在此处选择的操作。

有许多方法可以激活配置文件：

1. 您还可以在 配置文件菜单中 长按配置文件名称激活配置文件
2. 您可以使用手势激活配置文件。为此，必须从配置文件菜单中启用在操作列表中显示。现在，您可以通过以下方式选择它：
   TOP MENU / / Taps and gestures / Gesture manager / “ANY GESTURE” / General / Profile “Your profile name”
3. You can also activate a profile automatically depending on some conditions. See the next heading to learn how to use this powerful feature.

You can run a profile manually as explained above but real power of profiles can be unleashed with its auto-execute feature. Using this feature, you can trigger a profile depending on some conditions and sub-conditions:

Trigger	Sub-conditions
On KOReader start Run this profile every time KOReader starts. Note that this is only possible when KOReader is starting with the File browser or Last file.	-
On wake-up Run this profile every time device wakes up	-
On rotation Run this profile when screen rotates to the selected rotation(s). Examples: Change to double column layout when device rotates to landscape. Activate night mode when device rotates upside down.	Left 90° (landscape) 0° (normal) Right 90° (landscape) 180° (upside down)
On showing folder Run this profile when you enter this folder in file browser. You can use this trigger to change the display mode of file browser. For example when you enter a certain folder you can change the display mode from mosaic to detailed view.	If folder path contains a certain text If folder path doesn't contain a certain text
On book opening This trigger is executed when you open a book (optionally) combined with specific sub-conditions. First 4 sub-conditions are OR matching, so any one of them is enough to trigger the profile execution.	Combined with device orientation Combined with book metadata Combined with book file path Combined with collections book is included in Combined with book is being opened for the first time
On book closing This option is same as above but it triggers when you close a book. You can use this for example enabling/disabling reading statistics when you open certain documents to exclude them from your stats.	Combined with device orientation Combined with book metadata Combined with book file path Combined with collections book is included in Combined with book is being opened for the first time

Profile examples:

Here are some profile examples from our devs to give you ideas about using this powerful feature of KOReader. Examples also include auto-execute conditions and collections features:

• Enable two columns mode when you turn your device to landscape orientation.
• Enable night mode when you turn your device upside down.
• Add all your manga to a collection. Then create a profile which switches the page turn direction to Right-To-Left and inverts the page turn taps and swipes when you open a manga book from this collection.
• Add your comic books to a collection, which can trigger a profile to decrease the screen refresh interval to every page to avoid ghosting.
• Trigger a profile to adjust typeface, font size and set two-column mode when opening a file for the first time from the Periodicals folder.
• Add your problematic PDFs to a collection, so when you open them Auto OCR or Reflow mode is activated with a profile.
• Switch display mode (covers, detailed list etc.) of file browser when you enter certain folders.
• Toggle off reading statistics when opening a book from a Reference Books collection. Toggle statistics back on when closing the book.
• If you expose the style tweaks in the gesture manager, you can create a profile to enable or disable them based on certain conditions. For example you can trigger a "disable publisher styles AND apply my user style tweaks" profile based on the book's location/collection or by a keyword in the metadata of the book. See the style tweaks section of the guide for more info.

!!! ADVANCED

在KOReader中，我们有一组操作/设置，该组可以通过两种方式创建：

1. 作为配置文件（解释为 高级方法，并存储在 settings/profiles.lua中）
2. 作为分配给手势的动作列表（解释为 简单模式），并存储在settings/gestures.lua)

该集合也可以以两种不同的方式执行：

1. 触发时按（排序）顺序应用每个操作（作为配置文件）
2. 将其显示为 快捷菜单

添加/删除集合的操作和启用/排序快速菜单是通过相同的 操作菜单完成的。唯一的区别是，手势管理器中的动作菜单还有两个项目（直通），这就是为什么显示为快速菜单和排序项目在第二页上。

Plugins are small KOReader programs that are similar to browser add-ons which extends the capabilities of the base program. KOReader has 3 categories of plugins:

内部插件是核心程序的一部分。

• 可以从KOReader插件菜单直接访问它们。
• They don’t need installation. You can enable them from the menu.
• They are checked by our developers so they are considered safe.
• They are automatically updated when you update KOReader.

您可以通过以下方式启用/禁用它们：

!!! ADVANCED

该组包含非官方插件，这些插件不是KOReader核心逻辑的一部分。

• They have to be installed manually and then activated from the plugins menu.
• They should be updated manually.
• 当它们被添加到我们的存储库中时，我们的开发人员会对它们进行检查，因此它们被认为是安全的。

You can access them from this page. Generally they are installed by downloading the plugin’s directory from the page above and copying it under koreader/plugins folder on your device. But please check the plugin’s page for other possible instructions.

!!! ADVANCED

这些插件是独立于KOReader团队开发的。

• They have to be installed manually and then activated from the plugins menu.
• They should be updated manually.
• 我们的开发人员没有对它们进行检查，因此请注意使用它们可能存在风险。

Some notable examples of these external plugins with links to their GitHub pages:

• AskGPT plugin: You can ask questions to ChatGPT about parts of your book. You can also use this plugin to simplify, explain, discuss or translate text to other languages.
• Assistant: AI Helper plugin: A fork of the plugin above with more advanced features like multiple AI providers and built-in/custom prompts.
• Anki plugin: KOReader plugin enabling Anki (an open-source flashcard software) card generations for words looked up in the internal dictionary.
• Zotero plugin: This addon allows you to browse your Zotero (an open-source reference management software) collections from KOReader.
• Syncthing plugin: This addon allows you to run Syncthing peer-to-peer file synchronization program on KOReader (tested only on Kobo devices but might work on other devices according to the author). This makes it possible to sync files between your e-reader and computer/phone automatically.

Also you can click this link to open a search page on Github to discover more KOReader plugin projects.

自动前灯 - 根据环境光线水平自动切换前灯（仅适用于Kindle Voyage和Oasis）

自动色温和夜间模式 - 允许您在具有自然（黄色/橙色）光的设备中调整前灯色温，并根据时间表自动设置夜间模式

自动省电 - 在指定的不活动时间后，将设备置于待机、暂停或关闭状态

自动休眠 - 在选定的闲置时间段后休眠设备（适用于除 Android 操作系统以外的所有电子墨水设备）

自动翻页 - 在设定时间后自动翻页

后台运行 - 为其他插件提供服务： 允许任务在后台定期运行。

电池统计信息 - 收集并显示设备的电池使用统计信息

书籍快捷方式 - 允许为手势添加图书快捷方式

Calibre - You can send documents from your Calibre library directly to your KOReader devices via WiFi connection. Check our wiki page for how-to.

封面浏览器 - 允许文件浏览器和历史记录采用封面显示模式

封面图像 - 将当前图书的封面图像保存为文件（适用于 Android/PocketBook/reMarkable 设备）

导出标注 - 将标注内容和笔记导出到本地文件或 Joplin（一款笔记应用程序）

闪卡训练 - 使用间隔重复法（SM2）展示您库中的高亮闪卡

手势 - 为 KOReader 提供手势支持

HTTP Inspector - Allows you to control your device from another device over wifi - See below for more info

日语支持 - KOReader 的日语支持，扩展了内置词典和选择系统

保持唤醒 - 保持设备唤醒状态，防止 WiFi 自动断开连接

移至存档 - 将当前文档移至存档文件夹

News Downloader - Retrieves RSS and Atom news entries and saves them as HTML files. Check our wiki page for how-to.

OPDS - 允许您从在线目录下载图书

感知扩展器 - 允许使用周边视觉更快速地阅读。查看 YouTube 视频，了解其工作原理：: 如何在 20 分钟内将阅读速度提高三倍（蒂姆-费里斯）

配置文件 - 允许结合多种设置来创建可切换的配置文件

Progress sync - Synchronize your reading progress across different KOReader devices. Check our wiki page for how-to.

从剪贴板生成 QR - 从剪贴板内容生成 QR 码

读取计时器 - 倒计时器可在用户定义的时间后显示信息

阅读统计 - 计算阅读时段统计和阅读速度，用于估算章节/书籍剩余时间

SSH - Allows access to your device over SSH protocol. You can access via FTP applications or even your file manager if it supports. Check our wiki page for how-to.

系统统计 - 您可以通过该插件查看 CPU/内存/处理器信息：

终端模拟器 - 在设备上启动 shell（命令提示符），可运行完整的终端应用程序

文本编辑器 - 用于创建和编辑纯文本文件的基本文本编辑器

时间同步 - 与 NTP 服务器同步设备时间

调整文档设置 - 允许在加载文档前根据外部因素调整文档设置

Wallabag - Downloads the latest articles from a Wallabag server as individual EPUB files. Check our wiki page for more info.

!!! ADVANCED

This plugin allows you to control your device from another device over wifi. It works by running a simple HTTP server on your device which serves a page containing KOReader controls. You can access this page over your network and control your reader device. But be aware of these points when using this plugin:

• This is an experimental plugin so use this at your own risk
• This plugin is enabled by default, but the server is NOT started by default. You can start it manually or set it to auto start.
• You should run this plugin only on trusted networks, as it is highly insecure (no HTTPS, no access restriction, no authentication)

You can read an example use case for this plugin on the MobileRead forum

!!! ADVANCED

用户修补程序是用Lua语言编写的小文件。他们可以更改KOReader的功能，而无需永久修改您的安装。它们可以由开发人员、其他用户编写，也可以由您自己编写（如果您对KOReader内部构件有必要的广泛了解）。

You can find a current list of User patches in our wiki and in the GitHub issues list marked with the User patch available tag. You can see them by following this link.

1. 在设备上的koreader目录下创建名为patches的目录（在 Android 系统中，该文件夹位于 SD 卡上）
2. 下载补丁文件，并将扩展名为.lua的补丁文件放在此patches目录中
3. 重启 KOReader

按照说明创建修补程序目录时，在重新启动KOReader后，名为补丁管理的新插件将在插件菜单中可用。使用此插件，您可以查看用户修补程序的列表和状态，并启用/禁用它们。您可以点击关于修补程序管理器菜单项以查看更多信息。

补丁的执行顺序由补丁名称中数字的第一个数字确定。例如: 2-TOC-title-patch.lua 如果有多个补丁以相同的数字开头，则执行顺序为自然顺序(1<10<11<12<13<…<109<…<10010)。 如果您只是下载已经制作的修补程序，则不需要更改文件名。

名称以以下字符开头：

• 0 - 最早执行，并且仅在更新后执行一次
• 1 - 在KOReader的每次启动时都很早就执行 (但在0之后，如果适用)
• 2 - 在每次启动KOReader时，在UIManager就绪后执行
• 3-7 - 保留
• 8 - 在退出之前和设置保存之前执行
• 9 - 退出前执行

如果用户修补程序有问题，可以通过删除修补程序文件恢复到以前的配置。

If you need to switch between two documents (when comparing them for example), there is a quicker way than going through the File Browser. KOReader can open the last document with a gesture ( multiswipe). If you define a gesture’s action as Open previous document, you can switch between two documents quickly similar to the Alt+Tab feature on the desktop computers. You can find this feature under:

Also you can use the History dialog to switch between documents quickly. The history screen can be opened with the  multiswipe gesture. You can also define any other gesture for this of course.

您可以通过此菜单更改图书封面:

有些书没有合适的封面。或者他们可能把封面放在第二页，所以不能很好地显示出来。或者封面不适合墨水屏（太亮或太暗）。或者你更喜欢从书中设置一些图像作为封面。

在这种情况下，你可以快速截图并将其设置为当前书籍的封面。截图手势默认为长对角线滑动。同时触摸相对的对角也可以截图。您可以在查看图像时使用第二个快捷方式。截图后，你可以在对话框中选择设置为书籍封面。

你可以在这里删除这个自定义的书封面：

在书籍信息页面，长按封面图片 项并选择 重置.

你也可以使用重置对话框，重置书籍的封面 ，你可以在 文件浏览器中长按文件名来访问。

如果您的文档中有链接，而您在翻页或使用其他手势时不小心点击了它们，您可以通过此菜单项点击来关闭通过点击跟踪链接：

禁用此设置后，要跟踪某个链接，您必须长按该链接，然后从弹出菜单中选择跟踪链接。如果您有相反的问题，并且希望点击链接更容易，可以从同一菜单中启用 扩大链接点击区域。

在读取统计数据时，您可以更改用于计算的起始日期。例如，如果你在午夜后阅读，并希望你的阅读时间计算在今天而不是第二天，这是很有用的。这只适用于日期时间轴视图，也可适用于日历视图；它不适用于任何其他统计报告。您可以将此时间设置为：

KOReader 可以通过Wi-Fi 进行自动更新。您可以通过此菜单项触发更新检查:

我们在KOReader中没有直接的选择。但是有一个解决方法来实现这种锁屏功能。您可以设置KOReader保持屏幕保护程序在屏幕上，直到您输入一个选定的手势。要实现这一点:

1. 选择任何手势 (包括具有自定义多滑动作的复杂手势)，并通过以下方式将其设置为 “解锁” 手势:
   TOP MENU / / Taps and gestures / Gesture manager / "your selected gesture" / Device / Exit screensaver
2. 然后启用此选项:
   TOP MENU / / Screen / Screensaver / Settings / Keep the screensaver on screen after wakeup / Until 'Exit screensaver' gesture

如果您的设备闲置一段时间，KOReader可以调暗您的前灯进行省电。您可以通过以下方式打开和调整此功能:

如果您想知道当前页面上显示了多少行或单词，您可以在以下位置看到它:

锂离子电池在其充电水平的极限处会经历更多的退化。为了最大限度地减少这种退化并延长电池寿命，您可以将最低放电水平限制为20%，最高充电水平限制为80%(如电动汽车和一些较新的手机)。这意味着当电池电量下降到20%时，你就开始给你的设备充电，当电池电量达到80%时，你就拔掉电源插头(如果你特别小心的话，还可以达到25%-75%)。

当电量达到您定义的限制时，KOReader会发出警告:

您可以通过此菜单项查看详细的电池使用统计数据:

您可以通过此菜单项查看系统信息，如CPU/磁盘空间/内存使用情况:

在旧的Kindle设备中，我们的一些用户报告了由于内存有限而导致的崩溃。如果您在一个会话中打开许多文件，KOReader内存使用量可能会增加。尤其是PDF增加了这个数量。您可以在状态栏中添加内存指示器，如果该值变高，则重新启动KOReader，以避免崩溃或重新启动。

您还可以通过以下方式将KOReader配置为在内存使用量达到阈值时自动重启:

If you can't find a solution to your problem in this guide, you can open an issue about it on the project's GitHub page or make a post in the KOReader section of the Mobileread forum. Please see the last section of this guide for details.

KOReader has two different versions:

• STABLE This version is the main one that you can find on the Releases page of the project GitHub. It is named like this: "KOReader 2024.11" which means this specific version is released on November 2024. This is generally a monthly release, but sometimes can take longer.
• NIGHTLY These versions are the daily compiled versions of KOReader with optimizations and fixes continuously added. Nightly releases are intended for a narrow group of testers and developers, so they might be less stable.

Normally if you are an average user, stable version is the one you should use. But in some specific cases you might need to use a nightly version:

• Your device is very new (a recently released Kobo model for example) and KOReader support has just been added in a recent nightly.
• There is a bug or problem specific to your device that is fixed already but not released yet. And you don't want to wait for the stable version to have this fix.
• After updating KOReader, you notice that a feature which you were using is removed. You don't want to lose this feature, so you can install a nightly version that still has this feature. Of course you can also go back to the previous stable release but nightly would be newer so might have more features and fixes.

This section was just a general introduction to the topic. For detailed information and asking for help about nightly versions, you can visit the discussion page: FAQ: How to track latest nightly builds

在极少数情况下，如果您想备份和恢复 KOReader 的所有设置，您可以备份 KOReader 安装目录下的这些文件夹和文件。然后，您就可以在重新安装后覆盖它们，恢复您的设置：

This might be caused by the Write highlights into PDF feature of KOReader if you enabled it. Saving PDF highlights will change your file so your synchronization will fail. If you are planning to use both features, in the Progress Sync plugin's settings, change the Document matching method to Filename instead of the default Binary matching:

KOReader经过优化，即使在电子书阅读器有限的硬件上也能快速运行。一般来说，几千页的书可以在几秒钟内打开，翻页是立即的。在这里，我们将谈谈如果你的书在打开，翻页或调整外观时感觉很慢的原因。

如果有问题的书是一个PDF:

• PDF文件本身可能对您的设备内存来说太大了。
• PDF文件可能包含非常大的图像文件。即使在具有普通文本层（可以选择并高亮显示）的文档中，也可能嵌入另一个图像层（通常是对页面的扫描）。这会减慢打开和翻页的速度，因为这些大图像必须重新缩放以适应屏幕，这个过程可能会占用CPU资源。
• PDF文件可能有很多需要精确定位的单独元素，就像一个有很多图像和文本框的杂志页面。在这种情况下，KOReader必须计算和绘制所有这些元素，这可能需要时间。
• 自动校直功能（允许您调整页面的倾斜）也可能减慢您的阅读器。
• 如果在重排处于启用状态时将渲染质量设置为高，则文本将更令人愉悦，但可能会比默认慢得多（每次翻页可能需要几秒钟），具体取决于您的文档。
  BOTTOM MENU / / Render Quality

如果有问题的书是EPUB:

• EPUB文件基本上由文本和图像组成，有一些规则来确定这些项目在屏幕上是如何格式化的。在理想情况下，这是一个相当简单的过程，所以EPUB文件在KOReader中通常很快。但是一些EPUB书籍添加了大量的格式化规则，KOReader必须进行许多计算才能显示哪怕是一个句子。这将减慢打开书、翻页和更改字重或行距等外观属性的速度。
  信息 KOReader 不支持固定布局 EPUB。 它们会打开，但会呈现为可排版的EPUB，可能看起来不美观或不可读。
• EPUB文件是包含HTML文件的ZIP归档文件。有些书可以是一个单独的HTML文件，而另一些书可能由多个HTML文件组成，比如书的每一章都是一个单独的HTML文件。如果你的书只是一个HTML文件，部分呈现是不能工作的。所以外观的变化将比分割章节的书慢，因为对于每次变化，KOReader仍然需要计算整本书，而不是只计算当前章节。
• 另一种罕见的慢速情况是当内容被包装在HTML表标签中。KOReader必须在每次翻页时渲染/绘制每个单元格，所以如果一个单元格（包含许多段落）跨越50页，这将使翻页相当慢。请参阅下面的解决方案。

如果一切都很慢：

如果你的书只有一些是慢的，上面提到的原因通常是有效的。如果你所有的书都很慢，你的问题可能与设备有关：

• 非常慢的CPU或低内存。
• 你的闪存（存放你的书的地方）性能可能会下降，这通常是由于设备的老化。
• 存储空间即将用完。
• 如果您使用的是基于Android的设备，您的Android操作系统可能会干扰KOReader的操作，或者某些后台进程可能会占用您的系统资源。

解决方案:

不幸的是，对于糟糕的PDF文件，没有太好的解决方案。一般来说，有问题的 PDF 和 EPUB 的最佳解决方案是试图找到一个更好的版本。或者，如果有其他文件类型可供下载，比如 EPUB 而不是 PDF（或相反），您可以尝试这种格式。

以下解决方案适用于EPUB文件，可能需要高级知识：

• 您可以在底部菜单中将内嵌样式设置为关，以查看忽略所有文档样式表是否会使其更快（当然，您可能会丢失任何漂亮的格式，但您会知道罪魁祸首是什么）。
• 如果您有HTML和CSS知识，您可以直接从KOReader查看HTML和CSS文件，并自行判断其质量或不必要的复杂性。为此，您可以长按某些文本并在弹出菜单中选择查看 HTML。
• 如果你有上面问题部分提到的“内容封装在表格中” 的问题，你可以添加这个表格 table, tr, td { display:block; }，从而将书籍特有的样式调整为：
  TOP MENU / / Style tweaks / Book-specific tweak
• Calibre是电子书编辑器，它可以检查EPUB文件的问题，并有工具来解决一些问题。

  You can download Calibre from here.

  You can see the instructions for the Check book tool of Calibre here.

• EPUBCheck application can check the validity of the EPUB files and detect many types of errors. You can read an example issue, where the problem is detected with EPUBCheck here.

  You can download the command line version from here.

  Or download a graphical user interface version from here.

提出 issue:

If you are opening an issue about this problem, it is important for us to inspect the problematic file. You can share the file directly by dragging and dropping it on your GitHub message after compressing it as a ZIP file. If your book is an EPUB and you don’t want to share the file due to copyright or privacy issues, there is a plugin for Calibre named ScrambleEbook which you can access the download and instructions from this Mobileread forum page.

这个插件将读取一个未受DRM保护的电子书文件(EPUB/KEPUB/AZW3)并创建一个用随机字符替换文本的副本。您可以在您的问题主题中与我们分享这个混乱的版本。这本书的文本将不可读，也不会有任何版权侵犯，但我们仍然可以使用此文件进行诊断。

You can see this procedure in a real issue involving a very problematic EPUB file here.

Those small numbers are called Reference Page Numbers. In short, they are the real page numbers from the printed version of your book. For more information please click here Reading Screen to go to the relevant section.

可能你点击了屏幕底部的状态栏触摸区。你可以通过点击同一个区域来恢复它。

这可能发生在握手或设备触摸屏问题等情况下。如果遇到这个问题，可以尝试增加触摸间隔。通过增加此间隔，您可以告诉KOReader忽略同一位置的快速点击。

如果您的两次连续点击相隔一段距离，则不适用。因此，您仍然可以通过用两个手指交替快速点击来快速浏览页面。

在Android设备中，由于Android系统的限制，KOReader无法写入外部存储。如果您想更改您的截图保存位置，请小心选择您的设备的内部存储。

即使KOReader设置为每页后全刷新，翻页后仍可能会看到一些重影/残留。这是电子墨水屏幕技术的一个局限性，可以在最新一代的设备上观察到，尤其是在阅读混合内容(文本+图像)文档时。作为一种解决方法，如果这些残影妨碍了您默认的（短对角线滑动 手势），您可以在翻页后手动刷新一次以消除这些残影)。

Sleep covers generally use a magnet embedded in the cover which enables wake up and sleep events via triggering a sensor in your device. This sensor can sometimes be mentioned as a Hall sensor or Hall effect sensor. In some cases like misaligned or weak magnets, this triggering can be problematic. If you are having problems with your device waking up because of your cover, you can disable this feature via this menu:

如果出现标题、标题或分隔符错位，或文本缩进出乎意料的情况，请尝试切换文档的样式。从epub.css 切换到 html5.css。 之所以会出现这类问题，是因为一些出版商认为他们的图书只能在基于网络浏览器引擎的阅读器上阅读，因此他们懒得 “重新设置 ”样式。

• 默认的HTML/EPUB (epub.css)是我们面向图书的样式表，文本对齐方式为 text-align: justify, text-indent on P. 它更适合无风格的书籍，也可能让有风格的书籍更易读。
• You can try switching to HTML5 (html5.css) if your book has indentation problems as mentioned above. This style provides a base stylesheet like web browsers do when rendering: text-align: left, no text-indent on P, spacing between P. But it doesn’t look pretty when publishers haven’t done any styling.

KOReader会缓存您的书籍封面，以便更快地显示它们。在正常情况下，该缓存不会变得太大。如果删除大量书籍或重命名目录，则可能需要清理书籍封面缓存数据库以回收一些空间。您可以从此菜单中执行此操作：

当您阅读PDF/DJVU文档时，KOReader会保存您阅读的最后一页的缓存。因此，当你重新打开这本书时，它会更快。但如果您长时间使用KOReader并阅读许多PDF/DJVU文档，则该缓存可能会变得很大。这些缓存文件保存在KOReader安装目录下的缓存文件夹下。要清除此缓存并回收空间，请转到：

KOReader uses GitHub as its project base. You can report problems or suggestions on our GitHub page. You just need a GitHub account which is free. Click this link to open our GitHub Issues page.

在 Issues 页面点击New Issue 按钮。 但在此之前，我们建议使用搜索栏查看是否已有关于同一主题的问题。您还可以查看其他已打开的问题，了解相关流程。

单击 New Issue 按钮后，您将看到两个选项：

单击相应的选项，然后按照页面上的说明报告您的问题或建议。

如果您要报告一个错误，详细调试日志对确定问题非常有帮助。您可以通过以下方式启用它们：

您还可以在同一对话框中找到 KOReader 的版本号和设备类型，以便进行报告。

If you have a suggestion or question related to this User Guide you can write to the GitHub discussion thread