Adds ReaderPageMap, to optionally show source pages numbers #6004

poire-z · 2020-03-26T13:21:12Z

bump crengine: support for EPUB3 nav toc and page maps
Includes koreader/crengine#336

Fix lvRect:isRectInside(rc) with 0-width or 0-height rect - closes Bookmarks don't work correctly in some rare cases #5991
TOC: parse EPUB3 nav toc, fallback to spine when no toc - closes FR: Support EPUB3 navigation document #4915
Parse and cache various hardcopy page list maps
epub.css: hide EPUB3 content
cre.cpp: add a few PageMap helper functions.

Adds ReaderPageMap which will add a new menu (under TOC and Bookmarks) that will allow:

to list source page numbers (like a TOC)
to show visible page labels in the right margin
to use these source page numbers in the footer, the TOC, the GoTo and SkimTo widgets, and to use the source page number in the standard bookmark and highlight initial text.
(and to unwontfix and close Epub page numbers #4521)

It will not be often used (less than 5% of my publishers' EPUB have a page map/list), and most people will probably disable it when it appears, as it's rarely useful. It's just nice to have (for when you see in a book "See note page 48" and that references the hardcopy book, with no internal link to that note in the EPUB).

So, we'll get this (only when there is a pagemap in the book):

An option to use the source/hardcopy page number in the footer, TOC, Bookmark names, Goto and SkimTo widgets:

and one to show the page labels in the margin:

Opinions and suggestions welcome on the wording in the screenshots above for this feature and these page maps/lists I used "Source pages" because I'm not sure it's always reference to hardcopy paper book pages, but I dunno...

(still need to include the bump for koreader/koreader-base#1070)

Also include:
BookInfo: add File date, handle zip sub-suffix (.fb2.zip) , as mentionned in #5956 (comment)

Also include koreader/koreader-base#1068: Update OpenSSL to 1.1.1e Update OpenSSH to 8.2p1

This change is

Frenzie

Cross-ref to #4245, #3833.

Frenzie · 2020-03-26T13:29:41Z

frontend/apps/reader/modules/readerpagemap.lua

+                hold_callback = function(touchmenu_instance)
+                    local use_page_labels = G_reader_settings:isTrue("pagemap_use_page_labels")
+                    UIManager:show(MultiConfirmBox:new{
+                        text = use_page_labels and _("The default (★) for newly opened books that have a page map is to use these page labels instead of the renderer page numbers.\n\nWould you like to change it?")


Not ecstatic about "renderer page numbers" but atm I can't think of a good alternative.

Yeah, this one was hard.
I wanted to have the buttons "Renderer pages" | "Source pages (★)" but these got truncated...
So, we could end up with a sentence and Disable | Enable.

poire-z · 2020-03-26T17:57:16Z

So, no particular thought against calling that/them "Source pages" ?

Frenzie · 2020-03-26T18:04:24Z

Oh, I don't like that one bit. :-P

What about something along the lines of basic page numbers and advanced page numbers?

NiLuJe · 2020-03-26T18:14:54Z

Reference page number?

Or, let's finally call it what it actually is instead of a stupid skeuomorphism: screen number vs. page number?

poire-z · 2020-03-26T18:29:43Z

Or, let's finally call it what it actually is instead of a stupid skeuomorphism: screen number vs. page number?

No, our page numbers are page numbers - renderer page numbers.
And most books won't have that menu - and we won't switch all the naming to mention "screen page numbers" :)
So, it's these source/reference/hardcopy page numbers that need the qualification/adjective.

basic page numbers and advanced page numbers

None of each is either basic or advanced. These "source page numbers", althought sometimes useful, are more bothering (jumps, gaps, multiples consecutive on the same screen page...)

Reference page number?

That could work I guess.

NiLuJe · 2020-03-26T18:34:34Z

No, our page numbers are page numbers - renderer page numbers.

But isn't a renderer page number technically one screen's height?

poire-z · 2020-03-26T18:58:27Z

Yes, technically, in page mode, we show one page per screen :) (even more technically, and out of this context, pages can be smaller than a screen height, with page breaks between chapters - so, when switching to scroll mode, you can have 2 or 3 renderer pages in the screen view).

Just insisting I'd like to keep these ones called simply "page numbers" :)

poire-z · 2020-03-26T19:34:41Z

Better ?:

(And where "page" should be plural, "pages" or not? Reference pages label?)

NiLuJe · 2020-03-26T19:36:57Z

Plural mark on the rightmost noun of a compound is correct ;).

EDIT: Here, there's technically always one label per page, so we're concerned with labels, not pages.

poire-z · 2020-03-26T19:38:57Z

What about "Reference page list" vs "Reference pages list" ?

NiLuJe · 2020-03-26T19:44:09Z

It's a single list of reference page numbers? (I'd tend to prefer adding an explicit 'number' mentioned somewhere there, so Reference page numbers list?)

poire-z · 2020-03-26T19:55:39Z

The Use reference page numbers is a bit obtuse... It's supposed to mean "use reference page numbers instead of renderer page numbers where it might make sense" :) and it's not super perfectly implemented (in the SkimTo widget, it will show the ref page number as the number, it will allow you to input it in the GoTo input (including page numbers in latin like xvii - but taping on +10 or -1 will skip you 10 or -1 rendered pages... but well, I'll fix that when someone complain :)

Frenzie · 2020-03-26T20:25:05Z

None of each is either basic or advanced. These "source page numbers", althought sometimes useful, are more bothering (jumps, gaps, multiples consecutive on the same screen page...)

By basic I mean 1-99 without Latin, letters or whatever. As such we have some slight miscommunication here in that you can have "advanced" page numbers perfectly fine without jumps or gaps.

Anyway, I said along the lines of for a reason. ^_^ I don't literally mean the word advanced. I mean the general concept or association of advanced, complete, proper, thorough, paper-like, etc.

Or, let's finally call it what it actually is instead of a stupid skeuomorphism: screen number vs. page number?

In paged media the distinction isn't between screens and pages but in the fact that page 1 doesn't start till page 20, before that it's page i-ixx, a-p, or whatever. That's basically my angle here. Dumb/basic Arabic page numbers vs labeled page numbers. Ideally the phrasing is compatible with both labeled paper-like page numbers in EPUB and labeled DjVu/PDF page names/numbers.

We can also do it (partially) without words, something like

Page number format: 1-99
Page number format: labeled

Frenzie · 2020-03-26T20:26:48Z

Screenshot from LibreOffice (not quite applicable, maybe Adobe Reader has a relevant setting):

poire-z · 2020-03-26T20:36:33Z

But you can have source/reference page numbers that are also 1-99, starting at 1 without any roman numbers, contiguous, increasing with no gap.
Distinguising them by how they look feels artificial. Better by where they come from (renderer vs reference/source/publisher).

(You cross ref'ed the issues with PDF & DJVU page numbers - but I have no idea how/if the code I added could be of use with them - probably simpler as for them, there is a one-to-one mapping between renderer pages vs reference/source page numbers.)

Frenzie · 2020-03-26T20:39:37Z

But you can have source/reference page numbers that are also 1-99, starting at 1 without any roman numbers, contiguous, increasing with no gap.

What are they called on Kindle or Kobo?

mergen3107 · 2020-03-26T20:48:55Z

In Kindle there are three types of positions.

“Locations” are proprietary Amazon-calculated values, basically like a cumulative sum of all characters on a “page” (current screen). Location step depends on font size
“Pages” are present only if supporting apnx file is provided for this book. This is just “conversion” of how many locations should be in a print version of this book.
“html-positions” which a raw data extracted from the book, but they are only visible in logs, not available for users

Frenzie · 2020-03-26T21:04:43Z

@poire-z

But you can have source/reference page numbers that are also 1-99, starting at 1 without any roman numbers, contiguous, increasing with no gap.

PS In DjVu/PDF it's often as simple as the cover not being included in numbering.

@mergen3107
Thanks! Sounds like there's nothing of interest to be gained there. ;-)

poire-z · 2020-03-26T21:30:29Z

What are they called on Kindle or Kobo?

No idea :)

But in the various mobiread links given in #4521:
https://wiki.mobileread.com/wiki/NCX 1 for 1 mapping to the actual page numbers in the physical book
https://wiki.mobileread.com/wiki/Adobe_Digital_Editions#Page-map mapping between the hardcopy book page numbers and the eBook
https://www.mobileread.com/forums/showthread.php?t=243222 the start of the real page in the matching printed book.
https://wiki.mobileread.com/wiki/Page_numbers Absolute page numbers (I don't like it :) The page numbers to be used in eBooks could be aligned with paper book versions of the same book for easy referencing

I'm fine with "Reference", which is a little less absolute than "Absolute" :)

Frenzie · 2020-03-26T22:17:31Z

I think "page labels" might be clearer than "reference page numbers," but maybe I'm just saying that because of PDF.

frontend/apps/filemanager/filemanagerbookinfo.lua

Frenzie · 2020-03-27T07:56:11Z

frontend/apps/reader/modules/readerpagemap.lua

+        text = _("Reference pages"),
+        sub_item_table ={
+            {
+                text = _("Reference source info"),


I think we might want to throw in some @translators notes. A reference source just sounds like a dictionary or something.

OK, added 2 - feels a bit excessive to add more... Hopefully, translators will meet all of them near each others and will know what it's about.

bump crengine: support for EPUB3 nav toc and page maps Includes: - Fix lvRect:isRectInside(rc) with 0-width or 0-height rect - TOC: parse EPUB3 nav toc, fallback to spine when no toc - Parse and cache various hardcopy page list maps - epub.css: hide EPUB3 <span epub:type="pagebreak"> content cre.cpp: add a few PageMap helper functions. Adds ReaderPageMap which will add a new menu (under TOC and Bookmarks) that will allow: - to list source page numbers (like a TOC) - to show visible page labels in the right margin - to use these source page numbers in the footer, the TOC, the GoTo and SkimTo widgets, and to use the source page number in the standard bookmark and highlight initial text.

Frenzie

lgtm

Frenzie added this to the 2020.04 milestone Mar 26, 2020

Frenzie reviewed Mar 26, 2020

View reviewed changes

poire-z force-pushed the bump_crengine_pagemap branch 3 times, most recently from ceb0ecf to 08304e4 Compare March 26, 2020 16:29

Frenzie added the enhancement label Mar 26, 2020

Frenzie reviewed Mar 26, 2020

View reviewed changes

frontend/apps/filemanager/filemanagerbookinfo.lua Outdated Show resolved Hide resolved

poire-z added 2 commits March 27, 2020 00:34

BookInfo: add File date, handle zip sub-suffix (.fb2.zip)

3164911

TextBoxWidget: fix infinite loop when very small width

8e1a2e8

poire-z force-pushed the bump_crengine_pagemap branch from 08304e4 to 974a3f1 Compare March 26, 2020 23:42

Frenzie reviewed Mar 27, 2020

View reviewed changes

poire-z force-pushed the bump_crengine_pagemap branch from 974a3f1 to b7c3051 Compare March 27, 2020 10:01

Frenzie approved these changes Mar 27, 2020

View reviewed changes

poire-z merged commit 026140f into koreader:master Mar 27, 2020

poire-z deleted the bump_crengine_pagemap branch March 27, 2020 17:36

poire-z mentioned this pull request Mar 29, 2020

Epub page numbers #4521

Closed

poire-z mentioned this pull request Oct 21, 2020

FR: Support for linear="no" files in EPUB #6809

Closed

This was referenced Apr 20, 2022

FR: Logical Page count for crengine formats. #9020

Open

PageMap: allow building synthetic pages numbers koreader/crengine#478

Merged

poire-z mentioned this pull request Apr 23, 2023

FR: Page Browser navigation helpers #10320

Closed

Leseratte10 mentioned this pull request Jul 16, 2023

Hidden nav elements aren't actually hidden #10703

Closed

poire-z mentioned this pull request Oct 5, 2023

Rendering Issue: Unwanted Numbers on the Right Side of EPUB Pages in Chinese #10977

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds ReaderPageMap, to optionally show source pages numbers #6004

Adds ReaderPageMap, to optionally show source pages numbers #6004

poire-z commented Mar 26, 2020 •

edited

Loading

Frenzie left a comment

Frenzie Mar 26, 2020

poire-z Mar 26, 2020

poire-z commented Mar 26, 2020

Frenzie commented Mar 26, 2020

NiLuJe commented Mar 26, 2020 •

edited

Loading

poire-z commented Mar 26, 2020

NiLuJe commented Mar 26, 2020

poire-z commented Mar 26, 2020

poire-z commented Mar 26, 2020

NiLuJe commented Mar 26, 2020 •

edited

Loading

poire-z commented Mar 26, 2020

NiLuJe commented Mar 26, 2020

poire-z commented Mar 26, 2020 •

edited

Loading

Frenzie commented Mar 26, 2020

Frenzie commented Mar 26, 2020 •

edited

Loading

poire-z commented Mar 26, 2020

Frenzie commented Mar 26, 2020

mergen3107 commented Mar 26, 2020 •

edited

Loading

Frenzie commented Mar 26, 2020

poire-z commented Mar 26, 2020

Frenzie commented Mar 26, 2020

Frenzie Mar 27, 2020

poire-z Mar 27, 2020

Frenzie left a comment

Adds ReaderPageMap, to optionally show source pages numbers #6004

Adds ReaderPageMap, to optionally show source pages numbers #6004

Conversation

poire-z commented Mar 26, 2020 • edited Loading

Frenzie left a comment

Choose a reason for hiding this comment

Frenzie Mar 26, 2020

Choose a reason for hiding this comment

poire-z Mar 26, 2020

Choose a reason for hiding this comment

poire-z commented Mar 26, 2020

Frenzie commented Mar 26, 2020

NiLuJe commented Mar 26, 2020 • edited Loading

poire-z commented Mar 26, 2020

NiLuJe commented Mar 26, 2020

poire-z commented Mar 26, 2020

poire-z commented Mar 26, 2020

NiLuJe commented Mar 26, 2020 • edited Loading

poire-z commented Mar 26, 2020

NiLuJe commented Mar 26, 2020

poire-z commented Mar 26, 2020 • edited Loading

Frenzie commented Mar 26, 2020

Frenzie commented Mar 26, 2020 • edited Loading

poire-z commented Mar 26, 2020

Frenzie commented Mar 26, 2020

mergen3107 commented Mar 26, 2020 • edited Loading

Frenzie commented Mar 26, 2020

poire-z commented Mar 26, 2020

Frenzie commented Mar 26, 2020

Frenzie Mar 27, 2020

Choose a reason for hiding this comment

poire-z Mar 27, 2020

Choose a reason for hiding this comment

Frenzie left a comment

Choose a reason for hiding this comment

poire-z commented Mar 26, 2020 •

edited

Loading

NiLuJe commented Mar 26, 2020 •

edited

Loading

NiLuJe commented Mar 26, 2020 •

edited

Loading

poire-z commented Mar 26, 2020 •

edited

Loading

Frenzie commented Mar 26, 2020 •

edited

Loading

mergen3107 commented Mar 26, 2020 •

edited

Loading