Skip to content

Commit

Permalink
User guide: wellformedness fixes for Weblate
Browse files Browse the repository at this point in the history 
Required for <koreader/koreader#11147 (comment)>.

Turns out most of what <#38> was complaining about was relevant after all.
  • Loading branch information
@Frenzie
Frenzie committed Dec 3, 2023
1 parent e228136 commit 2cf012f
Showing 1 changed file with 41 additions and 42 deletions.
83 changes: 41 additions & 42 deletions user_guide/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -447,38 +447,44 @@
<div class="standard-text" style="line-height: 2.3rem;">
<ul>
<li><a href="#whatcanyoudo">WHAT CAN YOU DO WITH KOREADER ?</a></li>
<li><a href="#userinterface">USER INTERFACE</a></li>
<li><a href="#userinterface">USER INTERFACE</a>
<ul>
<li><a href="#readingscreen">Reading Screen</a></li>
<li><a href="#filebrowser">File Browser</a></li>
<li><a href="#uitips">User Interface Tips</a></li>
<li><a href="#bottomexplained">Bottom Menu Items Explained</a></li>
</ul>
</li>

<li><a href="#basicreading">BASIC READING INFO</a></li>
<li><a href="#basicreading">BASIC READING INFO</a>
<ul>
<li><a href="#keyboard">Keyboard Usage And Tips</a></li>
<li><a href="#autowarmth">Auto Warmth And Night Mode</a></li>
<li><a href="#fonts">Fonts</a></li>
</ul>
</li>


<li><a href="#moving">MOVING THROUGH YOUR BOOK</a></li>
<li><a href="#moving">MOVING THROUGH YOUR BOOK</a>
<ul>
<li><a href="#skimwidget">Skim Widget</a></li>
<li><a href="#bookmap">Book Map</a></li>
<li><a href="#pagebrowser">Page Browser</a></li>
</ul>
</li>

<li><a href="#bookmarks">BOOKMARKS, HIGHLIGHTING AND NOTES</a></li>
<li><a href="#bookmarks">BOOKMARKS, HIGHLIGHTING AND NOTES</a>
<ul><li><a href="#exportinghighlights">Exporting your highlights</a></li></ul>
</li>

<li><a href="#pdfs">READING PDFS</a></li>
<li><a href="#pdfs">READING PDFS</a>
<ul>
<li><a href="#readingpdfs">Reading large PDFs on a small screen</a></li>
<li><a href="#pdfbottom">Explanations Of Pdf Specific Bottom Menu Items</a></li>
<li><a href="#ocr">OCR (Optical Character Recognition)</a></li>
<li><a href="#panelzoom">Panel Zoom (manga/comic)</a></li>
</ul>
</li>
</ul>
</div>
</div>
Expand All @@ -487,32 +493,36 @@
<div>
<div class="standard-text" style="line-height: 2.3rem;">
<ul>
<li><a href="#gestures">GESTURES AND KEYBOARD SHORTCUTS</a></li>
<li><a href="#gestures">GESTURES AND KEYBOARD SHORTCUTS</a>
<ul>
<li><a href="#predefinedgestures">Predefined Gestures</a></li>
<li><a href="#gesturecategories">Gesture Categories</a></li>
<li><a href="#keyboardshortcuts">Keyboard Shortcuts</a></li>
</ul>
</li>

<li><a href="#qmandprofiles">QUICK MENU AND PROFILES</a></li>
<li><a href="#qmandprofiles">QUICK MENU AND PROFILES</a>
<ul>
<li><a href="#quickmenu">Quick Menu</a></li>
<li><a href="#profiles">Profiles</a></li>
</ul>
</li>

<li><a href="#plugins">PLUGINS AND USER PATCHES</a></li>
<li><a href="#plugins">PLUGINS AND USER PATCHES</a>
<ul>
<li><a href="#plugintypes">Plugin types</a></li>
<li><a href="#pluginslist">List of internal plugins</a></li>
</ul>
</li>

<li><a href="#preparing">PREPARING AND TRANSFERRING YOUR DOCUMENTS</a></li>
<li><a href="#preparing">PREPARING AND TRANSFERRING YOUR DOCUMENTS</a>
<ul>
<li><a href="#transferring">Transferring books to your reader</a></li>
<li><a href="#optimizing">Optimizing EPUB/PDF documents for your mobile reader device</a></li>
<li><a href="#zipfiles">ZIP file support</a></li>
<li><a href="#manga">Optimizing manga for your mobile reader device</a></li>
</ul>
</li>

<li><a href="#tips">TIPS</a></li>

Expand Down Expand Up @@ -587,7 +597,7 @@
<li>Create a menu with your favorite actions with <b>Quick Menu</b></li>
<li>Dim or turn off your <b>screen light</b> after a set interval</li>
<li>Adjust frontlight/backlight level and <b>warmth</b> manually or automatically</li>
<li>Set your own <b>screensaver</b> from many options like random images, book cover, reading </li>progress etc.
<li>Set your own <b>screensaver</b> from many options like random images, book cover, reading, progress etc.</li>
<li>Set battery <b>charge limit alarms</b> to prevent deep discharge/over charge</li>
<li>Set a memory usage alert (useful for devices for smaller memory) and optionally restart KOReader upon reaching this limit</li>
</ul>
Expand Down Expand Up @@ -666,7 +676,7 @@
<div class="standard-text">By default, <span class=ui>FILE BROWSER</span> shows your <span class=ui>HOME</span> which is your main library folder which you can change by <b>tapping and holding on any folder</b>. You can change its many options like how books are displayed or sorted via the <span class=ui>TOP MENU</span> by swiping down from the top part of the screen.
<p>Circled items in the image are explained below:</p>
<p><span class=ui>RESET:</span> This option basically resets your book by deleting its configuration file. </p>
<p><div class=warning><span class="icon_red"></span> If you select this option, you will lose all your notes and highlights in this book.</div></p>
<p class=warning><span class="icon_red"></span> If you select this option, you will lose all your notes and highlights in this book.</p>
<p><span class=ui>OPEN WITH:</span> KOReader has different engines for rendering different file types. In some cases you can open a file in a different engine to get some other features. See <b>Viewing archive files</b> and <b>Viewing image files</b> sections just below.</p>
<p><span class=ui>IGNORE COVER:</span> If for some reason you want to disable the cover for this book (it may have wrong cover or cover is not very readable on the e-ink screen) you can select this.</p>
<p><span class=ui>IGNORE METADATA:</span> If your book metadata is not correct, name field may show useless information. Select this option to show the file name instead of metadata.</p>
Expand All @@ -690,7 +700,7 @@
<ol>
<li>In <span class=ui>File Browser</span> long-press the file name</li>
<li>Tap <span class=ui>Open with…</span></li>
<li>Tap <span class=ui>Image viewer</li></span>
<li>Tap <span class=ui>Image viewer</span></li>
</ol>
</div>

Expand Down Expand Up @@ -872,7 +882,6 @@
<span class=ui>WORD EXPANSION:</span> 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 <span class=ui>NONE</span>.</p>

<p>You can experiment with different settings until the text looks pleasing to you, then set them as defaults via their respective dialogs.</p>
</p>
</div>

<hr>
Expand Down Expand Up @@ -1230,15 +1239,13 @@

<img src="pictures/skim_widget_chapter_mark_levels.png" style="width:400px;">

<p>
You can also use this reduced ToC for:
<ul>
<p>You can also use this reduced ToC for:</p>
<ul>
<li>chapter titles (if it is shown on <span class=ui>Status Bar</span>)</li>
<li>chapter navigation</li>
<li>reading time left estimates</li>
These options are in the same menu.
</ul>
</p>
</ul>
<p>These options are in the same menu.</p>
<p>If your document doesn’t have a Table of Contents, you can enable <span class=ui>ALTERNATIVE TABLE OF CONTENTS</span>. When this setting is enabled, KOReader will build a ToC from document headings (if available) or from individual HTML files in the EPUB. Long-tap the menu item for extra info:
</p>

Expand Down Expand Up @@ -1611,8 +1618,7 @@

<div class="standard-text">
<img src="pictures/gesture_tap.png" style="width:100px;">
<span class=ui>
<p>TAP / DOUBLE TAP</p></span>
<p class=ui>TAP / DOUBLE TAP</p>
<p>Single or double tap with <b>ONE</b> finger</p>
<p><b>WORKS:</b> Anywhere on the screen</p>
</div>
Expand All @@ -1621,8 +1627,7 @@

<div class="standard-text">
<img src="pictures/gesture_tapandhold.png" style="width:100px;">
<span class=ui>
<p>TAP AND HOLD</p></span>
<p class=ui>TAP AND HOLD</p>
<p>Single tap and hold with <b>ONE</b> finger</p>
<p><b>WORKS:</b> Only on four corners</p>
</div>
Expand All @@ -1631,8 +1636,7 @@

<div class="standard-text">
<img src="pictures/gesture_twofingertap.png" style="width:100px;">
<span class=ui>
<p>TWO FINGER TAP</p></span>
<p class=ui>TWO FINGER TAP</p>
<p>Single tap with <b>TWO</b> fingers at the same time</p>
<p><b>WORKS:</b> Only on four corners</p>
</div>
Expand All @@ -1641,8 +1645,7 @@

<div class="standard-text">
<img src="pictures/gesture_pinch.png" style="width:100px;">
<span class=ui>
<p>SPREAD AND PINCH</p></span>
<p class=ui>SPREAD AND PINCH</p>
<p>Same gesture as zooming in and out on a mobile phone, tablet etc.</p>
<p><b>WORKS:</b> Anywhere on the screen</p>
<div class=warning><span class="icon_red"></span> This gesture may work less reliably depending on your device. If that’s the case please choose another gesture type.</div>
Expand All @@ -1653,8 +1656,7 @@

<div class="standard-text">
<img src="pictures/gesture_swipe.png" style="width:100px;">
<span class=ui>
<p>ONE FINGER SWIPE</p></span>
<p class=ui>ONE FINGER SWIPE</p>
<p>Swiping motion with <b>ONE</b> finger</p>
<p><b>WORKS:</b> Screen edges (HORIZONTAL and VERTICAL) Anywhere except edges (DIAGONAL) </p>
</div>
Expand All @@ -1663,8 +1665,7 @@

<div class="standard-text">
<img src="pictures/gesture_twofingerswipe.png" style="width:100px;">
<span class=ui>
<p>TWO FINGER SWIPE</p></span>
<p class=ui>TWO FINGER SWIPE</p>
<p>Swiping motion with <b>TWO</b> fingers at the same time</p>
<p><b>WORKS:</b> Anywhere on the screen</p>
</div>
Expand All @@ -1673,8 +1674,7 @@

<div class="standard-text">
<img src="pictures/gesture_multiswipe.png" style="width:100px;">
<span class=ui>
<p>MULTISWIPE</p></span>
<p class=ui>MULTISWIPE</p>
<p>More than one swipe done after each other without lifting your finger.
For example like drawing the letter <b>U</b> (DOWN-RIGHT-UP)</p>
<p><b>WORKS:</b> Anywhere on the screen</p>
Expand Down Expand Up @@ -2305,7 +2305,8 @@
<p> <b> Read timer </b> - A countdown timer to display a message after a user defined time </p>
<p> <b> Reading statistics </b> - Calculates reading sessions statistics and reading speed for use in chapter/book remaining time estimations </p>
<p> <b> SSH </b> - Allows access to your device over SSH protocol. You can access via FTP applications or even your file manager if it supports. Check the wiki page for how-to: <a href="https://github.com/koreader/koreader/wiki/SSH">https://github.com/koreader/koreader/wiki/SSH</a> </p>
<p> <b> System statistics </b> - You can see your CPU/RAM/BATTERY info via this plugin under: <div class="menu-breadcrumbs"><span class="icon_green"></span> TOP MENU → <img class="img_inline" src="pictures/top_hamburger.svg" style="width:26px;"> → Help → System statistics</div> </p>
<p> <b> System statistics </b> - You can see your CPU/RAM/BATTERY info via this plugin under:</p>
<div class="menu-breadcrumbs"><span class="icon_green"></span> TOP MENU → <img class="img_inline" src="pictures/top_hamburger.svg" style="width:26px;"> → Help → System statistics</div>
<p> <b> Terminal emulator </b> - Starts a shell (command prompt) on your device that can run full terminal apps </p>
<p> <b> Text editor </b> - A basic text editor to create and edit plain text files </p>
<p> <b> Time sync </b> - Synchronizes the device time with NTP servers </p>
Expand Down Expand Up @@ -2342,7 +2343,7 @@

<p><span class="link_to_heading">Naming the patch</span></p>

<p>Execution order of a patch is determined by the first digit of the number in the patch name. For example: <span class=ui>2-TOC-title-patch.lua</span> If there are several patches starting with the same digit, the execution order is the natural order <b>(1<10<11<12<13<...<109<...<10010)</b>. If you are just downloading an already made patch you don’t need to change the file name.</p>
<p>Execution order of a patch is determined by the first digit of the number in the patch name. For example: <span class=ui>2-TOC-title-patch.lua</span> If there are several patches starting with the same digit, the execution order is the natural order <b>(1&lt;10&lt;11&lt;12&lt;13&lt;…&lt;109&lt;…&lt;10010)</b>. If you are just downloading an already made patch you don’t need to change the file name.</p>
<p> Names starting with:</p>

<ul>
Expand Down Expand Up @@ -2424,14 +2425,14 @@
<div class="standard-text">
If you like reading manga books on your e-ink device there are some tips that can make your experience better. Preparing your own manga files is the best solution if you're not satisfied with how comics look on your device.

<p><div class="link_to_heading">File type</div></p>
<div class="link_to_heading">File type</div>
<p>File types like MOBI and EPUB are not suitable for handling primarily image content (e.g., manga/comics). <b>MOBI</b> support in KOReader is minimal to nonexistent, and <b>EPUB’s</b> text rendering priorities can cause problems when showing full-page images (for further technical details: <a href="https://github.com/koreader/koreader/issues/9163#issuecomment-1146637205">https://github.com/koreader/koreader/issues/9163#issuecomment-1146637205</a>).</p>

<p>Your best option is building a <b>CBZ</b> file which works better in KOReader. A file with <b>.cbz</b> extension is a zip file (with no compression) that is a collection of images. It saves multiple images, commonly <b>.png</b> or <b>.jpeg</b> files, organized into pages of the comic. KOReader can also open <b>CBT</b> files, which are similar to <b>CBZ</b> files but use <b>TAR</b> archive format.</p>

<p>Easiest way to convert a manga to <b>CBZ</b> is to get the manga as images from various websites, then convert them using <span class=external>Kindle Comic Converter</span> (<a href="https://github.com/ciromattia/kcc">https://github.com/ciromattia/kcc</a>). There are some useful settings like <b>auto-rotating two-page splits to landscape and applying dithering</b> so that eink-rendered gradients are smoothly dithered without jagged layers.</p>

<p><div class="link_to_heading">Resolution</div></p>
<div class="link_to_heading">Resolution</div>
<p>The best results can be achieved by resizing your images to exactly your e-reader screen size. A screen-specific <b>CBZ</b> which targets the exact screen size of the device, prevents rescaling during reading. KOReader downscales your images to your screen size while reading but this is not recommended because KOReader adds a dithering pass before scaling and this causes loss of quality.</p>

<p>But if you want to use your hand made <b>CBZ</b> on more than one device or you want to preserve high resolution for future proofing, your best option might be to make the <b>CBZ</b> for your highest resolution device. Or pick an arbitrary "high" resolution, possibly one that matches the source. <b>300 PPI</b> or better (up to <b>450</b> or even <b>600</b>), unless the source is lower of course. If we assume a screen size of <b>8", 1500×2000</b> is a good target resolution. For bigger images, you should try it on your device and see whether it can deal with it. Especially old Kindles with low memory can struggle with sizes like <b>3000×4000</b> for example. If you're automating the process, it might be worth considering creating both a lower and higher quality version (e.g., at <b>200/400</b> or <b>300/600</b> DPI).</p>
Expand Down Expand Up @@ -2479,8 +2480,7 @@
<a href="https://disk.yandex.com/d/glEebjmPYYp7og">https://disk.yandex.com/d/glEebjmPYYp7og</a></li>
<li>Extract these three files next to your images that will be processed</li>
<li>Edit the <b>_magick_manga_ditherN_resize.bat</b> and change the resolution to your device resolution (in both places in the <b>BAT</b> file).
<p> <div class=warning><span class="icon_red"></span> Next step will replace all the images in the directory with the processed ones. So make sure that you have a copy of them in some other directory if you want to keep the originals.</p>
</div>
<p class=warning><span class="icon_red"></span> Next step will replace all the images in the directory with the processed ones. So make sure that you have a copy of them in some other directory if you want to keep the originals.</p>
</li>
<li>Run <b>_magick_manga_ditherN_resize.bat</b> to resize and dither the images.</li>
<li>Assuming you have <b>7-Zip</b> installed, run <b>_batch_archive.bat</b> to pack all the processed images into a <b>CBZ</b> archive.</li>
Expand Down Expand Up @@ -2674,7 +2674,7 @@
<b>Folders:</b>
<ul>
<li>settings</li>
<li>styletweaks</p>
<li>styletweaks</li>
</ul>
</div>

Expand Down Expand Up @@ -2748,11 +2748,10 @@




</div>
<!-- OUTER DIV-->
</div>


<!--
<a href=""></a>
<div class="standard-text">
Expand Down

0 comments on commit 2cf012f

Please sign in to comment.