-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
2282 lines (1670 loc) · 117 KB
/
index.html
File metadata and controls
2282 lines (1670 loc) · 117 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>User Guide Check</title>
<link rel="icon" type="image/x-icon" href="favicon.ico">
<!-- ANCHOR CSS -->
<style>
@media (max-width: 430px) { /* Or whatever breakpoint you need */
img:not(.img_inline) { /* Target all img tags that DO NOT have the class .inline */
width: 100% !important; /* Overrides the inline style */
height: auto !important; /* Maintain aspect ratio. Good practice! */
}
.warning {
margin-left: 0% !important;
margin-right: 0% !important;
}
.info {
margin-left: 0% !important;
margin-right: 0% !important;
}
.tip {
margin-left: 0% !important;
margin-right: 0% !important;
}
}
html{
font-size: 1em;
}
body {
font-family: 'snpro', Arial, sans-serif;
background-color: var(--bg-color);
color: var(--text-color);
transition: background-color 0.5s;
font-synthesis: none;
}
/* LIGHT THEME COLORS */
:root {
--bg-color: #FDF6E3;
--container-color: #FFFCFD;
--text-color: #393218;
--red-color: #EF5350;
--green-color: #8BCB15;
--blue-color: #1D91FD;
--orange-color: #F59E0B;
--link-color: #26A69A;
--external-color: #b720d1;
}
/* DARK THEME COLORS */
body.dark {
--bg-color: #0E0801;
--container-color: #1e1c19;
--text-color: #D9CBA5;
--red-color: #ff615b;
--green-color: #CDDC39;
--blue-color: #4FC3F7;
--orange-color: #FFB300;
--link-color: #56d8c9;
--external-color: #ff61c5;
--image-filter: invert(1);
}
/* MAIN DIV */
.outer-container {
max-width: 80ch;
margin: 0 auto;
background-color: var(--container-color);
padding-left: 3%;
padding-right: 3%;
padding-bottom: 3%;
box-shadow: 0 0 8px -2px var(--text-color);
transition: background-color 0.5s;
border-radius: 8px;
}
/* TWO COLUMN DIV - USED INSIDE OUTER*/
.double-container {
display: grid;
grid-template-columns: 1fr 1fr;
gap: 10px;
}
.centering-div {
width: fit-content;
margin: 0 auto;
}
a {
font-weight: bold;
text-decoration: none;
color: var(--link-color);
border-bottom: solid 1px var(--link-color);
}
a:hover {
background-color: var(--link-color);
color: var(--container-color);
}
p {
line-height: 180%;
color: var(--text-color);
text-align: justify;
text-indent: 1.6rem;
margin-top: 0.5rem;
margin-bottom: 0.5rem;
}
hr {
border: 0;
height: 2px;
background-image: linear-gradient(to right, #00000000, #faaf3f, #00000000);
margin-top: 3rem;
margin-bottom: 3rem;
}
ul {
margin-top: 0.2rem; margin-bottom: 1.4rem; margin-left: 0rem;
padding-left: 0;
padding-left: 2.7rem;
list-style: disc;
}
ol {
margin-top: 0.2rem; margin-bottom: 1.4rem; margin-left: 0rem;
padding-left: 0;
padding-left: 2.9rem;
}
li {
text-indent: 0rem;
line-height: 180%;
color: var(--text-color);
text-align: justify;
margin-top: 0.4rem;
margin-bottom: 0.4rem;
list-style-position: outside;
}
li::marker {
font-weight: bold;
}
/* GENERAL IMAGES */
img {
display: block;
height: auto;
margin-left: auto;
margin-right: auto;
margin-top: 2%;
margin-bottom: 3%;
box-shadow: 0 4px 7px rgba(0, 0, 0, 0.35);
max-width: 100%;
border-radius: 8px;
background: var(--container-color);
}
.dark img {
filter: brightness(0.6) contrast(1.4) sepia(0.3);
}
/* INLINE IMAGES */
.img_inline {
height: auto;
display: inline;
margin-top: 0;
margin-bottom: 0;
box-shadow: none;
background: #FFF;
border-radius: 50%;
}
.grid-table {
border-collapse: collapse;
width: 85%;
margin-top: 1rem;
margin-left: 0rem;
}
.grid-table td {
height: 1.4rem;
text-align: center;
padding: 0.5rem 0.5rem 0.5rem 0.5rem;
border-bottom: 1px solid var(--orange-color);
}
/* STANDARD FONT */
@font-face {
font-family: 'snpro';
src: url('pictures/SNPro-Regular.otf') format('opentype');
font-weight: normal;
font-style: normal;
font-display: swap;
}
/* STANDARD FONT - BOLD WEIGHT */
@font-face {
font-family: 'snpro';
font-style: normal;
font-weight: 700;
src: url('pictures/SNPro-Bold.otf') format('opentype');
}
/* STANDARD FONT - BOLD WEIGHT */
@font-face {
font-family: 'microns';
font-style: normal;
font-weight: normal;
src: url('pictures/microns.otf') format('opentype');
}
/* MAIN CHAPTER HEADINGS - CENTERED */
.L1-Chapter-heading {
font-weight: bold;
font-size:1.8rem;
line-height: 3rem;
text-align: center;
color: var(--orange-color);
background-color: var(--container-color);
padding-top: 0.5rem;
padding-bottom: 0.5rem;
margin-top: 5rem;
margin-bottom: 1rem;
box-shadow: -1px 2px 5px -2px var(--text-color) inset;
border-radius: 12px;
break-before: page;
}
/* .L1-Chapter-heading::before {
font-family: microns;
content: "";
color: var(--orange-color);
padding-right: 0.4rem;
} */
/* SUB HEADINGS - CENTERED */
.L2-Sub-heading {
font-weight: bold;
font-size: 1.5rem;
text-align: center;
line-height: 2.4rem;
margin-top: 2.4rem;
color: var(--orange-color);
}
/* SMALL HEADINGS - LEFT ALIGNED */
.L3-Smaller-heading {
font-weight: bold;
font-size: 1.2rem;
color: var(--orange-color);
margin-top: 2rem;
}
/* TIP, NOTE, WARNING BOX LABELS */
.label_red {
font-weight: bold;
color: #FFF;
background-color: var(--red-color);
border-radius: 4px;
padding: 0.3rem;
}
.label_blue {
font-weight: bold;
color: #FFF;
background-color: var(--blue-color);
border-radius: 4px;
padding: 0.3rem;
}
.label_green {
font-weight: bold;
color: #FFF;
background-color: var(--green-color);
border-radius: 4px;
padding: 0.3rem;
}
.label_orange {
font-weight: bold;
color: #FFF;
background-color: var(--orange-color);
border-radius: 4px;
padding: 0.3rem;
}
/* COLORED TEXTS */
/* USER INTERFACE ELEMENTS OF KOREADER - BLUE */
.ui {
font-weight: bold;
color: var(--blue-color);
}
/* EXTERNAL LINKS AND SERVICES - PURPLE */
.external {
font-weight: bold;
color: var(--external-color);
}
/* MENU PATHS OF ACTIONS - GREEN */
.menu-breadcrumbs {
font-weight: bold;
font-size: 1rem;
line-height: 1.6rem;
letter-spacing: 0rem;
color: var(--green-color);
text-align: center;
margin-top: 0.4rem;
margin-bottom: 1rem;
}
.menu-breadcrumbs::before {
font-family: microns;
content: "";
color: var(--green-color);
padding-right: 0.1rem;
display: inline-block;
}
/* TIP, NOTE, WARNING BOXES */
.warning {
border: 0px solid var(--red-color);
border-radius: 8px;
box-shadow: 0 1px 4px 0px var(--red-color);
color: var(--text-color);
font-size: 0.9rem;
line-height: 180%;
margin-top: 1.2rem;
margin-bottom: 1.2rem;
margin-left: 15%;
margin-right: 15%;
padding: 1% 1.8% 1% 1.8%;
text-align: justify;
text-indent: 0em;
}
.info {
border: 0px solid var(--blue-color);
border-radius: 8px;
box-shadow: 0 1px 4px 0px var(--blue-color);
color: var(--text-color);
font-size: 0.9rem;
line-height: 180%;
margin-top: 1.2rem;
margin-bottom: 1.2rem;
margin-left: 15%;
margin-right: 15%;
padding: 1% 1.8% 1% 1.8%;
text-align: justify;
text-indent: 0em;
}
.tip {
border: 0px solid var(--green-color);
border-radius: 8px;
box-shadow: 0 1px 4px 0px var(--green-color);
color: var(--text-color);
font-size: 0.9rem;
line-height: 180%;
margin-top: 1.2rem;
margin-bottom: 1.2rem;
margin-left: 15%;
margin-right: 15%;
padding: 1% 1.8% 1% 1.8%;
text-align: justify;
text-indent: 0em;
}
/* TOC styles*/
.TOC-heading {
font-weight: bold;
font-size:2rem;
line-height: 3rem;
text-align: center;
color: var(--orange-color);
break-before: page;
}
.toc {
list-style: none;
padding: 0;
margin: 0;
}
.toc a {
text-decoration: none;
color: var(--text-color);
border-bottom: none;
/* display: block; Make links fill the entire li area */
}
.toc a:hover {
background-color: var(--orange-color);
color: var(--container-color);
border-bottom: none;
}
.toc ul {
list-style: none;
padding-left: 0.8em;
margin: 0rem;
}
/* Styling for 2nd level */
.toc ul ul {
padding-left: 2.6em;
}
/* Main level square bullet */
.toc > li > a::before {
content: "";
display: inline-block;
margin-right: 0.5em;
vertical-align: middle;
background-color: var(--orange-color);
width: 1.1rem;
height: 1.1rem;
}
.toc > li > a {
color: var(--orange-color);
margin-top: 0rem;
font-size: 1.2rem;
font-weight: bold;
display: inline-flex;
align-items: center;
text-align: left;
}
/* More space after the main section headers */
.toc > li {
margin-top: 0rem;
margin-bottom: 2.6rem;
line-height: 100%;
}
/* Adding a little space before a nested list */
.toc li > ul {
margin-left: 1rem;
margin-top: 0.6rem;
}
/* GO TO THE ToC BUTTON */
#myBtn {
display: none; /* Hidden by default */
position: fixed;
top: 1%;
right: 3%;
z-index: 99;
border: none;
outline: none;
color: var(--red-color);
cursor: pointer;
padding: 4px;
border-radius: 10px;
font-size: 1rem;
text-shadow: 0px 0px 1px #FA5750;
text-indent: 0em;
box-shadow: 0 2px 3px var(--red-color), 0 1px 2px #0000003d;
}
#myBtn:hover {
background-color: var(--red-color);
}
/* DARK MODE SWITCH */
.switch {
position: fixed;
top: 1%;
left: 3%;
display: inline-block;
width: 64px;
height: 32px;
}
.switch input {
opacity: 0;
width: 0;
height: 0;
}
.switch input:checked + .slider {
background-color: var(--bg-color);
}
.switch input:checked + .slider:before {
transform: translateX(30px);
background-color: transparent;
border-radius: 50%;
border-top-color: transparent;
border-left-color: transparent;
border-right-color: transparent;
box-shadow: inset -7px -3px 0 #fff700;
}
.switch .slider {
position: absolute;
cursor: pointer;
top: 0;
left: 0;
right: 0;
bottom: 0;
background-color: var(--bg-color);
transition: 0.4s;
border-radius: 16px;
box-shadow: 0px 4px 3px -2px var(--text-color) inset;
}
.switch .slider:before {
position: absolute;
content: "";
height: 24px;
width: 24px;
left: 4px;
bottom: 4px;
transition: 0.4s;
border-radius: 50%;
text-align: center;
line-height: 16px;
box-shadow: inset -7px -3px 0 #584d4d;
}
/* YELLOW MARK GRADIENT
background-image: linear-gradient(
100deg,
hsl(58deg 87% 94%) 0%,
hsl(57deg 91% 87%) 5%,
hsl(57deg 94% 78%) 30%,
hsl(57deg 94% 78%) 65%,
hsl(57deg 91% 87%) 95%,
hsl(58deg 87% 94%) 100%
);
} */
.yellow-mark {
border-radius: 0.4em 1em 0.6em;
padding: 2px 6px;
margin: -3px -6px;
color: #322814;
padding: 6px;
font-weight: bold;
color: #322814;
text-shadow: 0px 0px 1px var(--bold-shadow-color);
line-height: 2rem;
background-image: linear-gradient(
100deg,
hsl(58deg 87% 94%) 0%,
hsl(57deg 91% 87%) 5%,
hsl(57deg 94% 78%) 30%,
hsl(57deg 94% 78%) 65%,
hsl(57deg 91% 87%) 95%,
hsl(58deg 87% 94%) 100%
);
}
.green-mark {
border-radius: 0.4em 1em 0.6em;
padding: 2px 6px;
margin: -3px -6px;
color: #322814;
background-image: linear-gradient(
100deg,
hsl(93deg 100% 96%) 0%,
hsl(82deg 99% 83%) 10%,
hsl(80deg 96% 75%) 39%,
hsl(80deg 96% 75%) 59%,
hsl(82deg 99% 83%) 85%,
hsl(93deg 100% 96%) 100%
);
}
.highlight {
background-image: url('highlight8.svg');
background-size: 100% 100%;
background-repeat: no-repeat;
padding: 6px;
font-weight: bold;
color: #322814;
text-shadow: 0px 0px 1px var(--bold-shadow-color);
font-size: 1.1rem;
line-height: 2rem;
}
/* .mark {
font-family: fontawesome;
background-image: url('highlight8.svg');
background-size: 100% 100%;
background-repeat: no-repeat;
padding: 4px;
margin: 4px;
color: #322814;
font-size: 1.4rem;
line-height: 1rem;
}
*/
</style>
</head>
<body>
<script>
document.addEventListener('DOMContentLoaded', function() {
const themeSwitcher = document.getElementById('theme-switcher');
// Load saved theme preference
const savedTheme = localStorage.getItem('theme');
if (savedTheme === 'dark') {
document.body.classList.add('dark');
themeSwitcher.checked = true;
}
// Detect OS preference if no saved preference
// else if (window.matchMedia("(prefers-color-scheme: dark)").matches) {
// document.body.classList.add('dark');
// themeSwitcher.checked = true;
// }
// Handle toggle switch
themeSwitcher.addEventListener('change', function() {
document.body.classList.toggle('dark');
localStorage.setItem('theme', this.checked ? 'dark' : 'light');
});
});
</script>
<div class="outer-container">
<label class="switch">
<input type="checkbox" id="theme-switcher">
<span class="slider round"></span>
</label>
<br>
<br>
<!--
Key improvements and explanations:
list-style: none;: This is crucial to remove the bullet points from the list.
padding: 0; margin: 0;: Resets default list padding and margins, giving you more control over spacing. This is also best practice.
text-decoration: none;: Removes the underline from the links.
color: #333;: Sets a default link color. Replace #333 with your preferred color value.
display: block;: This is important. It makes the entire <li> clickable, not just the text.
padding: 0.2em 0;: Adds vertical padding to the links, making them easier to click.
margin-bottom: 0.5em;: Adds space between list items. Adjust this value to your liking.
hover effect: Provides visual feedback when hovering over a link. Change the color to your desired hover color.
Nested List Styling (.toc ul): Handles the indentation of nested lists (sub-sections). Adjust padding-left to control the indentation amount.
Top-Level Section Styling (.toc > li > a): This CSS targets only the direct children <li> elements of the .toc list and applies styles to their links (<a>). This is useful for making the main section titles stand out (bold, larger font, etc.). The > selector is a child selector.
More spacing: Added for more visual separation between sections, and nested lists.
-->
<div class="L2-Sub-heading">Guide 25.03 Update Check - CORRECTIONS</div>
<br>
<br>
<!-- <p><span class="highlight">Dear devs, sections are fixed according to your suggestions. Changed parts are marked like this sentence if it is a bigger change or in green highlight as in the example below if it is a partial change:</span></p>
<p><span class="green-mark"><b>I HAVE BEEN MODIFIED, PLEASE CHECK ME !!!</b></span></p>
<br> -->
<p>You can click on your name below to directly go to your section:</p>
<ul>
<!-- <li><a href="#mergen3107">mergen3107</a></li>
<li><a href="#ryanwwest">ryanwwest</a></li>
<li><a href="#commodore64user">Commodore64User</a></li>
<li><a href="#poirez">poire-z</a></li> -->
<li><a href="#hius07">hius07</a></li>
<!-- <li><a href="#frenzie">Frenzie</a></li> -->
</ul>
<!-- ANCHOR @mergen3107 -->
<div class="L1-Chapter-heading" id="mergen3107">@ mergen3107</div>
<!-- <div class="L2-Sub-heading">Nightly versions</div>
<p>KOReader has two different versions:</p>
<ul>
<li><span class="label_green">STABLE</span> This version is the main one that you can find on the <b>Releases</b> page of the project GitHub. It is named like this: <b>"KOReader 2024.11"</b> which means this specific version is released on <b>November 2024</b>. This is generally a <b>monthly</b> release, but sometimes can take longer.</li>
<li><span class="label_red">NIGHTLY</span><b></b> These versions are the <b>daily</b> 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.</li>
</ul>
<p>Normally if you are an average user, <b>stable</b> version is the one you should use. But in some specific cases you might need to use a <b>nightly</b> version:</p>
<ul>
<li><span class="green-mark">Your device is very new (a recently released Kobo model for example) and KOReader support has just been added in a recent nightly.</span></li>
<li>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 <b>stable</b> version to have this fix.</li>
<li><span class="green-mark">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 <b>stable</b> release but <b>nightly</b> would be newer so might have more features and fixes.</span></li>
</ul>
<p>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: <a href="https://github.com/koreader/koreader/issues/11068">FAQ: How to track latest nightly builds</a></p>
<div class=tip><p style="text-indent: 0rem;"><span class="label_green">TIP</span> If you are using KOReader on an Android device, you can use the <b>Work Profile</b> feature of the Android OS to test the Nightly versions without affecting your main KOReader installation. Open source applications like <b>Shelter</b> and <b>Island</b> can help you with this.</p></div> -->
<!-- ANCHOR ryanwwest -->
<div class="L1-Chapter-heading" id="ryanwwest">@ ryanwwest</div>
<!-- <div class="L2-Sub-heading">Library organization and individual book settings</div>
<p>KOReader stores settings and extra information related to your books in the same directory as your book file. We call this <b>metadata</b> and it includes:</p>
<ul>
<li>Visual settings for the book</li>
<li>Book reading progress</li>
<li>Highlights, bookmarks and notes</li>
</ul>
<p>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.</p>
<p>You can change this setting from this menu:</p>
<div class="menu-breadcrumbs">TOP MENU / <img class="img_inline" src="pictures/gear.svg" style="width:26px;"> / Document / Book metadata location</div>
<div class=warning><p style="text-indent: 0rem;"><span class="label_red">WARNING</span> We strongly advise reading the section below to understand the differences and how each method works before making any changes. Otherwise there is a risk of losing your book settings, progress and annotations.</p></div>
<div class="L3-Smaller-heading">1. Individual metadata folders next to the book files</div>
<div class="menu-breadcrumbs">TOP MENU / <img class="img_inline" src="pictures/gear.svg" style="width:26px;"> / Document / Book metadata location: book folder</div>
<p>This is the <b>default</b> method used on a new installation of KOReader. In this method, when you copy <b>Alice in Wonderland.epub</b> to your device and open it for the first time, a folder named <span class=ui>Alice in Wonderland.sdr</span> will be created in the same directory. This directory contains the files for your settings, annotations and book progress for this book.</p>
<p><b><span class="label_green">Benefits</span></b></p>
<ul>
<li>You can manually backup and restore the settings for each book.</li>
<li>When you perform directory synchronization or backups with a system like <b>Syncthing</b> or <b>Dropbox</b>, your settings will be synchronized alongside your books.</li>
<li>You can rename the parent directories where your book resides, this doesn't confuse KOReader.</li>
</ul>
<p><b><span class="label_red">Negatives</span></b></p>
<ul>
<li>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.</li>
<li>These <b>.sdr</b> folders will be visible when you browse your library directories with another file browser or from your computer, which may clutter your view.</li>
</ul>
<div class="L3-Smaller-heading">2. Metadata directories under a single KOReader directory</div>
<div class="menu-breadcrumbs">TOP MENU / <img class="img_inline" src="pictures/gear.svg" style="width:26px;"> / Document / Book metadata location: .../koreader/docsettings</div>
<p>This method is essentially same as the default one above. The difference is, in this method, all <b>.sdr</b> folders of your books will be under a single directory <b>which is under the KOReader main directory structure</b>, instead of your library directory, next to the book files.</p>
<p><b><span class="label_green">Benefits</span></b></p>
<ul>
<li>Book <b>.sdr</b> 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.</li>
</ul>
<p><b><span class="label_red">Negatives</span></b></p>
<ul>
<li>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.</li>
<li>Since your book metadata will not be in your library folders, any synchronization or backups of your library will not include them.</li>
</ul>
<div class="L3-Smaller-heading">3. Individual HASHED metadata directories under a single KOReader directory</div>
<div class="menu-breadcrumbs">TOP MENU / <img class="img_inline" src="pictures/gear.svg" style="width:26px;"> / Document / Book metadata location: .../koreader/hashdocsettings</div>
<p>This method is similar to the previous one as the <b>.sdr</b> 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 <b>.sdr</b> folder name will no longer match and your metadata for that book will be lost. <b>If you are only using the KOReader File Browser for file operations, this is automatically handled so there are no repercussions.</b></p>
<p>In this <b>HASHED</b> method, <b>.sdr</b> folders are not identified by the filepath/filename of the book. Instead, a partial <b>MD5 hash</b> 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 <b>contents of the book file</b>. Also same hash is used for naming its .sdr folder.</p>
<p><b><span class="label_green">Benefits</span></b></p>
<ul>
<li>Book <b>.sdr</b> 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.</li>
<li>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.</li>
<li>In this method, KOReader associates the same <b>.sdr</b> folder with all copies of the book, even if these copies are on different devices. For example if you are using <b>Syncthing</b>, this method enables you to sync your <span class=ui>/hashdocsettings</span> 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.</li>
</ul>
<p><b><span class="label_red">Negatives</span></b></p>
<ul>
<li>Any operations that modify the file directly (such as writing highlights into PDFs or downloading from <b>Calibre</b>) will change the file so its <b>MD5 ID will change</b> (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.</li>
<li>Calculating file IDs may slow down <span class=ui>File browser</span> navigation when browsing larger directories.</li>
</ul> -->
<!-- ANCHOR Commodore64User -->
<div class="L1-Chapter-heading" id="commodore64user">@ Commodore64User</div>
<!-- <div class="L2-Sub-heading" id="keyboardshortcuts">Keyboard Shortcuts</div>
<p>If you have a device with a keyboard like <b>Kindle 2</b> and <b>Kindle 3</b>, including Bluetooth keyboards and emulators, you can use the keyboard buttons and shortcuts to control KOReader. <b>Kindle 4</b> is supported too, which lacks a full keyboard but still has enough keys to make it functional in this context. On these devices, KOReader will enable an extra menu named <span class=ui>Keyboard Shortcuts</span> which you can access here:</p>
<div class="menu-breadcrumbs">TOP MENU / <img class="img_inline" src="pictures/gear.svg" style="width:26px;"> / Navigation / Physical buttons / Keyboard shortcuts</div>
<p>This menu is very similar to the <span class=ui>Gesture Manager</span> interface. In this menu:</p>
<ul>
<li>You can see the shortcuts that are available on your device</li>
<li>You can see the predefined actions for some shortcuts</li>
<li>You can assign actions to the available shortcuts</li>
</ul>
<p>All of the actions in the <span class=ui>Gesture Manager</span> is also available for keyboard shortcut assignment. Which means you can control nearly all the functions of KOReader with these shortcuts.</p>
<p>In the table below, you can see the default key and shortcut assignments:</p>
<div class=info><p style="text-indent: 0rem;"><span class="label_blue">INFO</span> Universal <span class=ui>screenshot</span> key is <b>Alt + Shift + G</b>. It is available on all screens, modes and platforms. On Kindle 4, it is <b>Keyboard + Menu</b>.</p></div>
<div class=info><p style="text-indent: 0rem;"><span class="label_blue">INFO</span> If you have a Kindle 4, <b>SHIFT</b> key in the table below is mapped to your <b>KEYBOARD</b> button. So <b>Shift + (UP/DOWN/LEFT/RIGHT)</b> shortcuts are mapped to <b>Keyboard button + (UP/DOWN/LEFT/RIGHT)</b> on your Kindle 4.</p></div>
<div class="centering-div">
<table class="grid-table" style="width: 65%; margin-left: auto; margin-right: auto; table-layout: fixed; border: none;">
<tr>
<td><div class="L3-Smaller-heading">File browser mode</div></td><td></td>
</tr>
<tr>
<td>Open top menu</td>
<td><b>F1</b></td>
</tr>
<tr>
<td>Navigate to home</td>
<td><b>Home</b></td>
</tr>
<tr>
<td>Move in file list</td>
<td><b>Up / Down</b></td>
</tr>
<tr>
<td>Open selected book</td>
<td><b>Enter</b></td>
</tr>
<tr>
<td>Exit application</td>
<td><b>Esc</b></td>
</tr>
<tr>
<td><div class="L3-Smaller-heading">Reading mode</div></td><td></td>
</tr>
<tr>
<td>Open top menu</td>
<td><b>F1</b></td>
</tr>
<tr>
<td>Open bottom menu</td>
<td><b>Enter</b></td>
</tr>
<tr>
<td>Back/exit application</td>
<td><b>Esc</b></td>
</tr>
<tr>
<td>Bookmarks</td>
<td><b>Shift + Left</b></td>
</tr>
<tr>
<td>Toggle bookmark</td>
<td><b>Shift + Right</b></td>
</tr>
<tr>
<td>Dictionary lookup</td>
<td><b>Ctrl + D (Alt + D on Kindles)</b></td>
</tr>
<tr>
<td>Wikipedia lookup</td>
<td><b>Ctrl + W</b></td>
</tr>
<tr>
<td>Fulltext search</td>
<td><b>Ctrl + S</b></td>
</tr>
<tr>
<td>File search lookup</td>
<td><b>Ctrl + F</b></td>
</tr>
<tr>
<td><div class="L3-Smaller-heading">Links</div></td><td></td>
</tr>
<tr>
<td>Select next page link</td>
<td><b>Tab</b></td>
</tr>
<tr>
<td>Select previous page link</td>
<td><b>Shift+Tab</b></td>
</tr>
<tr>
<td>Open selected page link</td>
<td><b>Enter</b></td>
</tr>
<tr>
<td><div class="L3-Smaller-heading">Image viewer (long-press on image)</div></td><td></td>
</tr>
<tr>
<td>Zoom in</td>
<td><b>Page Down</b></td>
</tr>
<tr>
<td>Zoom out</td>
<td><b>Page Up</b></td>
</tr>
<tr>
<td><div class="L3-Smaller-heading">Highlighting</div></td><td></td>
</tr>