blindpandas/bookworm

The Universally Accessible document Reader

Appveyor Builds

Bookworm

Bookworm is an accessible document reader that enables blind and visually impaired individuals to read documents in an easy and hassle free manor. The main highlights of bookworm are:

• Supports over 20 document formats
• Support for named bookmarks. This enables you to mark interesting positions in the text for later reference
• Support for adding comments to capture an interesting thought or create a summary of the content at a particular position in the text. Bookworm allows you to quickly jump to a specific comment and view it. Later, you can export these comments to a text file or HTML document for later use.
• Two different styles of viewing pages; plain-text and fully rendered, zoomable, images.
• Full text search with customizable search options
• Book navigation via Table of content is extensively supported for all document formats
• Support for reading books aloud using Text-to-speech, with configurable voice parameters.
• The ability to customize text-to-speech with voice profiles. Each voice profile configures the style of the speech, and you can freely activate/deactivate a voice profile anytime.
• Support for standard zoom-in/zoom-out/reset commands. This is supported in the textual view and the rendered page view.
• Support for exporting any document format to a plain text file.

Resources

• The official website: getbookworm.com
• Telegram group: Bookworm Official group
• Telegram channel: Bookworm news
• User guide: Bookworm user guide

Development

If you would like to contribute to Bookworm's development, please follow the following steps to get bookworm up and running on your computer:

Required Binaries

You need the following binaries to develop Bookworm:

1. Python: currently we use Python 3.10 series: Grab the latest version from python.org
2. GNU win32 tools: the easiest way to get those is to install Git. Since Git comes with these binaries you can simply add them to your path. For example, if git was installed to: "C:\Program Files\Git". Then you need to add the following directory to your path: "C:\Program Files\Git\mingw64\bin".
3. NSIS: for creating Windows installers. Get it from NSIS download page and add it to your path.
4. Optionally, you need Visual Studio 2019 with the Windows 10 development workload to compile some libraries.

Prepare the source tree

Bookworm is composed of many components. To prepare your source tree and run Bookworm for the first time, follow these steps:

• Get the source code by cloneing this repo:

git clone https://github.com/blindpandas/bookworm.git
cd bookworm

• Create a virtual environment:

python -m venv .env
.env\\scripts\\activate

• Install "invoke" : invoke is the command runner we use to define and run the build process. Install it from pip using:

pip install invoke

• Then run the following command to prepare your development environment:

invoke dev

This should install the development and application dependencies and prepare the source tree.

• If everything worked as expected, you can now run Bookworm using the following command:

invoke run

This should run Bookworm with debug mode enabled. To run the app with debug mode disabled you can do:

invoke run --no-debug

Another way to run the app is to execute the package directly. In this case, you can turn on debug mode yourself using the "--debug" flag. To execute the package, you can do:

py -m bookworm --debug

• All the build/deployment commands are available in the tasks.py script. To view a list of these commands, issue the following in your terminal:

invoke --list

As an example, to build Bookworm, issue the following command:

invoke build

• If you've found a bug, or you want to contribute your changes back to bookworm, please create an issue or submit a pull request. We welcome any contribution, no matter how small it is.

Telegram group

You can discuss Bookworm, help others or make suggestions in the official Telegram group. Join it by visiting this link

Telegram channel

The Telegram channel will be dedicated to publishing new features, changes and fixes will be posted. All discussions will continue in the main group and files will also be available for download from the main group.

License

Bookworm is copyright (c) 2019-2023 Blind Pandas Team. It is licensed under the GNU General Public License.

bookworm's Issues

The icons for the Bookworm preferences categories are invisible if their pane has a black background

Describe the Problem

If the pane in which is located the list of categories in Bookworm's preferences has a black background (e.g. the "High Contrast Black" theme in Windows is used), each icon is not visible, unless its category is selected/highlighted.

To Reproduce

Steps to reproduce the behavior:

1. Go to Windows Settings (press Windows+I) -> Ease of Access -> High Contrast -> Enable High Contrast.
2. From the list of themes to use for high contrast, select "High Contrast Black" - it is the one which uses black backgrounds.
3. Open Bookworm.
4. Open Bookworm's preferences.
5. Observe how the icons for the categories in the pane on the left are not visible, unless the category in question is selected/highlighted.

Expected behavior

The icons for the categories in the pane on the left should be visible, no matter if the category in question is selected/highlighted or not.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.388), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b3, x86.

Additional context

The problem is a minor one. As far as I know, it is probably hard, if not impossible to fix, unless different sets of icons are used in accordance with the background color of the pane, which I think is an overkill for such a minor bug. But I'm reporting it just in case I'm wrong about its complexity and for the sake of completeness/thoroughness.

Bookworm Beta reads twice the last page of a book

Problem description

I've noticed that Bookworm Beta reads twice the last page of a book when reading on its own (not via the screen reader). I have a lot of e-books in EPUB format downloaded from a local (bulgarian) public site for e-books. Each e-book there has a single-page section in its end, called "Credits". When Bookworm reads on its own (with F5) and reaches that last single-page section called "Credits", it reads it twice. I was able to reproduce this only with SAPI5, but not with OneCore. Since the books are in bulgarian, I was able to test only with one SAPI5 bulgarian voice - "Irina" from "Innoetics", because the other one - "SpeechLab Gergana" seams not to be compatible with Bookworm (for reference - see Bookworm issue #31 - Bookworm does not correctly initialize a specific bulgarian SAPI5 TTS voice. Therefore, I can't tell for sure if the problem is in Bookworm or the voice. Additionally, now I've tested with an e-book in EPUB format in english with the SAPI5 variant of the english voice "Microsoft David" and the issue was also reproducible. So, it is not due to a specific book or a specific TTS voice.

Steps to reproduce it

Steps to reproduce the behavior:

1. Open Bookworm.
2. In Bookworm's preferences, from the "Voice" section, select the SAPI5 engine and then the bulgarian voice "Irina".
3. Open a book in it. Preferably the example one that I'll attach here.
4. Go to its last page and then go 1 page back.
5. Press F5 to read that page and the next/last page of the book.

Expected behavior

Bookworm should read the last page of the book only once, as does the stable release of the program.

Actual behavior

Bookworm reads the last page of the book twice.

The File You've Opened

The book formats that I read in are EPUB ones. I don't know if the problem is reproducible with other supported e-book formats. I'll attach an example e-book in EPUB format. It is in bulgarian, but for the purposes of the testing, I think this does not matter.

Test environment

• Operating system: Windows 10 Pro version 2004 (build 19041.572), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.2a4, portable, in english.
• Processor: Intel Core i5-9400F at 2.90GHz.
• RAM Memory: 16.00GB.
• Graphics: MSI GeForce GTX-1050TI Gaming X 4G, 4096MB dedicated memory, desktop resolution set to 1920x1080.
• Sound Card: Realtek ALC892 at Intel Cannon Point PCH.

Additional context

Here is the example e-book in EPUB format, zipped:

TestBook.zip

A search for a very long string brakes the search

Describe the Problem

A search for a very long string brakes the search - the searched string cannot be found, even if it exists in the book. I don't know how long the string has to be, but a bit longer sentence should do the job.

To Reproduce

Steps to reproduce the behavior:

1. Open a book in Bookworm.
2. Open the "Search" dialog of Bookworm (press Ctrl+F).
3. Search for a particularly long string that you know it exists in the opened book.

Expected behavior

Bookworm should find the searched string, but it does not - it reports that there are 0 results found.

The File You've Opened

Most of my e-books are in EPUB format and that is in what format I'm searching for the long string. But I don't think the format matters. I even tried books with cyrillic and books with latin characters, but the result was the same.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.356), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b3, x86 (32-bit).

bookworm fails to start

after using bookworm for several days, perhaps, 5 days, now it can't run. When i press enter on 'bookworm', nothing happen. I try uninstall and reinstall again, still the same. Curious why it fails to open.

eunable to launch Bookworm Portable 0.2A4

Describe the Problem

Hello,

When I unzip the file
Bookworm-0.2a4-portable.zip
and press enter on bookworm.exe, I get the following error written to the log

19/01/2021 00:08:19 root CRITICAL: Error details:
Traceback (most recent call last):
File "bookworm\bookworm.py", line 27, in main
File "", line 983, in _find_and_load
File "", line 967, in _find_and_load_unlocked
File "", line 677, in _load_unlocked
File "c:\projects\bookworm-o7wa1.venv32\lib\site-packages\PyInstaller\loader\pyimod03_importers.py", line 493, in exec_module
File "bookworm\bootstrap.py", line 10, in
File "", line 983, in _find_and_load
File "", line 967, in _find_and_load_unlocked
File "", line 677, in _load_unlocked
File "c:\projects\bookworm-o7wa1.venv32\lib\site-packages\PyInstaller\loader\pyimod03_importers.py", line 493, in exec_module
File "bookworm\paths.py", line 11, in
File "", line 983, in _find_and_load
File "", line 967, in _find_and_load_unlocked
File "", line 677, in _load_unlocked
File "c:\projects\bookworm-o7wa1.venv32\lib\site-packages\PyInstaller\loader\pyimod03_importers.py", line 493, in exec_module
File "bookworm\runtime.py", line 59, in
File "bookworm\runtime.py", line 48, in is_running_portable
File "pathlib.py", line 1027, in new
File "pathlib.py", line 674, in _from_parts
File "pathlib.py", line 658, in _parse_args
TypeError: expected str, bytes or os.PathLike object, not NoneType

To Reproduce

Steps to reproduce the behavior:

1. Unzip the portable .zip file.
2. Press enter on the bookworm.exe file.
3. See error

Expected behavior

Bookworm should launch.

The File You've Opened

I am unable to open a file.

Desktop (please complete the following information):

• OS: Windows 7 SP1 64 Bit
• Bookworm version 0.2B4
• Recent settings you may have changed in Bookworm [e.g. changed the speech settings]

Additional context

Add any other context about the problem here.

User manual on Git pages

The user manual on the github homepage is broken and does not work. It is unclear if the user guide directory in the help menu is leading the user to the most recent user guide.

Text display issues

about the problem

Hi, thank you for such amazing app.
The app is great, however the format of the epub and pdf files is not displayed correctly. It is particularly problematic where I'm trying to read the code, I will provide the example below to illustrate the problem.

Steps To Reproduce

Actual Behavior

I have the following line below copied from the epub book that is about coding
quick note, the line below is rendered as one line of code

#mainCanvas { width: 400px; height: 400px; border: solid 1px black; }
this happens when I open pdf or epub book in this app.

Expected Behavior

same line of code should be rendered as follows

#mainCanvas {
width: 400px;
height: 400px;
border: solid 1px black;
}

I checked how it's supposed to be rendered against same pdf file in adobe acrobat.

I'm assuming that the coder who wrote the app should be aware about need to read code correctly using screenreader
I hope it could be fixed, because it is a great option. To read books, knowing the fact that PDF books are not always accessible it is great alternative to read any book in accessible way.

Thank you for such amazing app, and best of luck in future development, also high contrast mode is a must without a doubt.

System Configuration

Bookworm Version:

version: 0.1b4

Windows Version:

2020-04

Other Questions

Does the issue still occur after restarting your PC?

yes

Have you tried any other versions of Bookworm? If so, please report their behaviors.

nope

present of '-' in pdf document

I've use bookworm to read a pdf file. For unknown reason, there are '-' symbol all over the text in the pdf document.
E.G:
normal text: Tax break enable more jobs created.
What happened: Tax br- eak enable m- ore job - s cr- eated.

When i try to open the same document using other app like adobe reader or any other apps, the text or sentences appear just fine/normal. Hopes can investigate.

El renderizado de página no responde

Describe the Problem

Cuando intento renderizar una página, no renderiza, y NVDA dice: "página renderizada (no responde)". Luego, abre el diálogo que dice que si cierra el programa, se podría perder información, y las dos opciones: esperar a que el programa responda, o cerrar el programa.

To Reproduce

1. Abre el programa.
2. Abre un libro epub.
3. Elige una página que sepas que contiene enlaces o imágenes.
4. Pulsa Control más R.
5. Ve el error.

Expected behavior

Simplemente, esperaba que renderizara la página. Esto ocurre tanto en modo normal como en modo depuración, sin devolver un mensaje de error ni código.

The File You've Opened

sucede con todos los archivos formato Epub.

Desktop (please complete the following information):

• OS: Windows 10 32-bit
• Bookworm version 0.1b4.

Windows Error Sound Effect Occurs While Turning Pages

Hi,

I'm using windows 10 with Bookworm 64bit and updated it to the latest version b4.
I found that every time I press Enter of Backspace to turn to the next/previous page, the windows error sound effect is played with the app's pagination sound. Even I unchecked the "Play pagination sound" in the Preferences, the error sound effect still occurs.

Thank you

can't open bookworm after updated to b4

after install the update to b4, the recent update, i can't open the bookworm. when i open it, the following message displayed,

Fatal error detected
Failed to execute script launcher
OK

i have try restart computer and the error still persists.

windows 10, 64bit,

No dark or high-contrast theme and problem with headings/titles

There's no dark/High-contrast mode in BookWorm. This makes it difficult for low vision users to use the software. Windows high-contrast mode could be used, but it doesn't affect the navigation tree-view in the BookWorm.
Additionally, There's a problem in displaying Headings and content below the headings. Currently, it appears on separate pages. This is not proper.
BookWorm version: latest version.
Windows version: Windows 10Ver2004 (64-bit) build 19041.329

Support OneCore Voices

Is your feature request related to a problem? Please describe.

No, although ability to continuously read with a screen-reader would make it less important (see below).

Describe the solution you'd like

Support OneCore voices and allow the user to switch to them using speech settings or voice profiles.

Describe alternatives you've considered

1. There are registry hacks to make OneCore voices available as SAPI5 voices, but this requires a certain degree of technical knowledge as well as knowledge of the possibility.
2. Narrator, NVDA and (I think) JAWS all support these voices. Since Narrator comes with Windows, one option is to just read books using Narrator or the user's preferred screen-reader along with the preferred voice. However, this is impractical right now because the screen-reader stops reading at the end of the page due to the text view only showing one at a time. If this is not something that will change, the only way to read continuously is to use the play function in Bookworm, and therefore Bookworm's voice support defines the reading experience.

Additional context

Microsoft has a lot of really good, multilingual voices that come with Windows 10, but they are out of reach for most apps that only support SAPI 5. It would be great to see support for these voices added to Bookworm itself, so the user can make voice profiles with them and read using all available voices.

Incorrectly rendered page with Windows high-contrast mode enabled

Problem description

If the Windows 10 high-contrast mode is enabled and the "High-Contrast Black" theme is selected, the beta version of Bookworm does not render the pages correctly. It should use a black background and white text as does the stable release of Bookworm, but instead it renders them with a light gray canvas and white background for the pages. This looks almost as if the high-contrast mode is not enabled, except for one thing - the text should be black in such a case, but it is white. To summarize, the beta version of Bookworm renders pages with a light gray canvas and white text on a white background for the pages. So, this is not only incorrect considering the theme used in Windows, but also makes the text unreadable. I'll attach some screenshots if the system will allow me.

Steps to reproduce it

Steps to reproduce the behavior:

1. Enable high-contrast mode in Windows 10, by doing the following:
   1.1. Open Windows Settings (Windows+I).
   1.2. Go to Ease of access -> High-contrast.
   1.3. Turn on the high-contrast mode, using the respective toggle.
   1.4. From the "High-contrast theme" combo-box, select "High-Contrast Black".
2. Open Bookworm.
3. Open a book in it.
4. Select a page with some text on it.
5. Invoke the "Render page" command from the "Tools" menu (or press Control+R).

Expected behavior

Bookworm should render the page with the following colors: black canvas and black background with white text for the pages.

Actual behavior

Bookworm renders the page with the following colors: light gray canvas and white background with white text for the pages, which makes the pages practically unreadable.

The File You've Opened

The problem is most accurately reproducible with EPUB files. With PDF files the white text is visible, because there is a black background around it, but the other parts of the render has the same wrong colors as the one for EPUB files.

Test environment

• Operating system: Windows 10 Pro version 2004 (build 19041.508), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.2a4, portable, in english.
• Processor: Intel Core i5-9400F at 2.90GHz.
• RAM Memory: 16.00GB.
• Graphics: MSI GeForce GTX-1050TI Gaming X 4G, 4096MB dedicated memory, desktop resolution set to 1920x1080.
• Sound Card: Realtek ALC892 at Intel Cannon Point PCH.

Additional context

Here are the made screenshots:

Can you add documents for language translates?

Hello, I would like to add the Turkish language to this beautiful program.
But there is no POT file.
A simple translation document is very useful.
I don't know how to prepare the translation template without a POT file.
I'm going to try something with PoEdit.

How should I proceed with the process of adding new translations?

God bless all script code lines 😂🤗 .

For group controls in some dialogs, the first option visually overlaps the header/name of the group

Describe the Problem

NOTE: I might be wrong, but I think that at least some vision may be required, in order to properly reproduce and diagnose this issue.

In some dialogs of Bookworm, in group controls (where there are a few controls visually grouped together), the text label of the first control in the group is positioned so it is located over the name of the group. Many such examples can be found in Bookworm preferences. Exceptions in there seam to be the groups of controls that contain radio buttons - there the label of the group is visible, because the first control in the group (the first radio button) is located below it as it should and not over it.

To Reproduce

Steps to reproduce the behavior:

1. Open Bookworm preferences.
2. Select any of the categories of settings.
3. Observe how in most groups of settings/options, the first option in each group is positioned on top (over) the text label for the group name, making it invisible/unreadable.

Expected behavior

The first option in each group of options should be positioned within the group container and not on its edge, so it does not obscure the label for the group.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.329), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b2, x86 (32-bit).

Contents of "pre" tag is rendered like one long line

Open an e-book in epub format containing the "pre" tag. I tested this with the book Mastering Go, second edition from Packpub. Every presented code example was rendered like one long line. This makes the book unusable, at least for me.

Bookworm alpha has problem "escaping" some characters

Describe the Problem

While reading a book in the alpha version of Bookworm, I've noticed that while displaying the text, it has problems "escaping" some characters. In particular - the backslash (). When there is a sequence of characters such as for example "YES\NO", Bookworm alpha displays it as "YES\u041dO". Actually, the text is in bulgarian. It should display as "ДА\НЕ", but it displays as "ДА\u041dЕ". Apparently Bookworm displays the character "Н" by its hexadecimal unicode representation.

Steps to reproduce it

1. Launch Bookworm alpha
2. Open a book with text that contains a backslash character and text right before and after it.
3. Find the text and observe how it is displayed.

Expected behavior

The text string containing the backslash character should be displayed correctly.

Actual behavior

Bookworm displays part of the string by its hexadecimal unicode representation.

The File You've Opened

It is an EPUB file. I can attach it here if needs be.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 20H2 (build 19042.746), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.2a4.

support for html and txt

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

I would like to be able to open txt and html files in BW directly and to navigate through the HTML with headings, links, etc.

Describe alternatives you've considered

This can be done in notepad or a browser but BW has better functionality for reading and many books are in html and some are even in txt.

Additional context

Bookworm does not split some lines

Describe the Problem

In the book that I'm currently reading, I've noticed that Bookworm does not split a particular text into separate lines as it should. When I load the book into Microsoft Edge or Balabolka, the text is properly split into separate lines. The lines in question are verses in a poem. It seams that the whole poem is combined in a paragraph.

To Reproduce

Steps to reproduce the behavior:

1. Launch Bookworm.
2. Open a book containing poem(s) with verses. I can provide a book, but it is in bulgarian.
3. Check how the lines in the verses of the poem(s) are combined in a single paragraph.

Expected behavior

Bookworm should split correctly lines of verses in a poem.

The File You've Opened

The file with which I've noticed this is a EPUB.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.388), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b3, x86 (32-bit).

setting to change hotkey

I would like to suggest that adding a option under preferences or settings to enable users to change hotkey to particular function. For example, i prefer using screen reader instead of built-in tts to read file in bookworm. As a result, i would frequently use the standard reading command like homekey to move to the beginning of line, and end key to move to the end of line. But, these hotkeys have been assigned to move to beginning of document and end document. Therefore, i would very hopeful that such settings exist because it is quite frustrated.

Thank you.

Display not only the title of the book in the Bookworm's title bar, but the name of the author as well.

Describe the solution you'd like

In bookworm's title bar, display not only the book's name, but the name of its author as well. That will make it easier to know which is the author of the current book and copy both the name of the book and the name of the author, without needing to navigate to the beginning or the end of the book to copy them from there.

Issues and suggestions

the issues

• Even in correctly labelled files, NVDA voice won't change to the correct language, i.e, I opened a book in English and was quite confused that the voice remaining my standard Portuguese one. When reading with the voices installed on windows, the voices are changed accordingly though.
• When using continuous reading, NVDA will read the page number every time it turns. As useful as it might be, it is slightly annoying.
• It isn't possible to focus the note title with the common tab / shift tab keys.

The suggestions

• add a shortcut to hide / show the table of contents.
• Add a library interface, where the user could create and manage shelves. This would be specially handy for students and anyone who likes organizing their content.
• Add the possibility to choose which voice will be used for each language.
• Make it possible to know which section of the text was notated. It can be done by adding the desired text to the note title, but it might be interesting to do it automatically when you create a note.

Conclusion

I'm very pleased to see that there is a modern and powerful E Book reader being developed. Please keep this one going.

clear list under recent books submenu

Hi, here's another suggestion. I would like to suggest that the 'clear list' option put in the bottom of the menu instead of the first menu item. This is partly because, i think, there is less often that a user would want to clear list compared to looking for the recent books. And the second, there is a tendency to accidentally press enter on it (clear list) as usually would expect the most recent book.

Thank you.

In some places in the program, "Bookworm" is written with a lower case letter "b"

Describe the Problem

In some places in the program, the name of the program - "Bookworm" - is written with a lower case letter "B", instead of a capital one. I've noticed this in the "About" dialog and in the documentation as well.

I've fixed those cases in the bulgarian copy of the documentation. I cannot do it however in the "About" dialog, because the name of the program there is hard-coded as a variable. I'm referring to the "{name}" variable in the string "bookworm/gui/book_viewer/menubar/init.py:44".

To Reproduce

Steps to reproduce the behavior:

1. Open Bookworm.
2. Open its "About" dialog".
3. Either press Control+C to copy the text content of the "About" dialog into the clipboard and paste it into a text editor and read it in there, or use your screen reader's method(s) of reading the text in the dialog directly from it.
4. Observe how the name of the program - "Bookworm" - positioned above the version number is written with a lower case "b", instead of a capital one.
5. Open Bookworm's documentation.
6. Search for "bookworm", writing it all in lower case and instructing the searching function to take upper/lower case in consideration when searching.

Expected behavior

The name of the program in the text in the dialog box (above the version number) is written with a lower case "b", instead with a capital one. There are such instances of the program's name written in all lower case in the program's documentation as well.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.329), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b2, x86 (32-bit).

Ability to highlight the text word by word when reading via TTS

Is your feature request related to a problem? Please describe

When reading with a TTS (not via the screen reader), Bookworm has the ability to highlight the spoken text. Now however, the highlighting is done on a paragraph level. That means, that the program highlights a whole paragraph and reads it aloud. That makes it somewhat difficult for a partially sighted user like me to track the reading progress, specially if it is in a big paragraph.

Describe the solution you'd like

An option in Bookworm to configure the level of highlighting when reading aloud should fix this. Example levels are: Word, line, sentence, paragraph.

Additional context

I don't know if my suggestion is technically possible at this stage (seams complex even to me (smile)), but I'm making it just in case it is or it becomes possible at a later time.

ci-cd: Provide the new bookworm .pop translation template at build time

Is your feature request related to a problem? Please describe.

Currently bookworm has started using crowdin to host translations.
It is recommended to provide the latest .pot translation template when building in appveyor

Describe the solution you'd like

Provide the latest .pot translation templates at the time of appveyor build

Describe alternatives you've considered

ci-cd: Provide the new bookworm .pop translation template at build time

Additional context

none

Visually overlapping pages in rendered view in Bookworm

Describe the Problem

NOTE: I might be wrong, but I think that at least some vision may be required, in order to properly reproduce and diagnose this issue.

In Bookworm 07122019 (the test version), pages in rendered view seam to overlap vertically. The first displayed page is OK - it is centered on the screen. Each next page however has its top edge snapped to the top edge of the screen. At the same time, the next page is also displayed so its bottom edge is snapped to the bottom edge of the screen. The current page is displayed completely and the next page has its top part hidden behind the current page (probably because there is not enough vertical space to fit both). If I'm not wrong, Bookworm should display only one page at a time, so its current behavior is a bug.

To Reproduce

Steps to reproduce the behavior:

1. Open Bookworm.
2. Open a book (the file format seams not to matter).
3. Execute the "Render page" function (pressing Control+R will do it).
4. Move forward and backward through the pages in the book.
5. Observe how after the first displayed page, Bookworm tries to display two pages at the same time one below the other, but probably due to not enough vertical space, the current page will overlap the next one.

Expected behavior

Bookworm should display only one page at a time, centered on the screen and maximized for best vertical fit.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1909 (build 18363.476), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: Bookworm 07122019 (the test version).

automatic page scrolling with NVDA

Hello. I have to read numerous PDF files because of my law school, and for me, the Bookworm is really great in the PDF files open quickly and also in other resources you have. But I lack a feature that I consider really essential: The Bookworm does not scroll the pages automatically when I'm reading with NVDA, the way it promises to do when we are using the internal mechanism of the application speech. I know I can hit enter when the cursor reaches the end of a page, but the automatic page scrolling would be much more comfortable, especially for a continuous reading of very large books, such as the Laws of books. And besides, I may have to copy a paragraph that starts on a page and ends in another. Anyway, I would like to bring the request for more this important resource for the community and especially to the developer, whom I thank for the excellent work and effort in bringing a good PDF reader accessible to the blind, and I hope to have the support of all ... Thank you.

The content of the "About" dialog is not localized

Describe the Problem

Bug: The content of the "About" dialog is not localized. Instead, the content is displayed in english. The string for it is available in the .po file. It is the "bookworm/gui/book_viewer/menubar/init.py:44" one and it is localized/translated. But the program ignores it for some reason and displays the english string instead. I've managed to reproduce the issue with both bulgarian and arabic translation.

To Reproduce

Steps to reproduce the behavior:

1. Open Bookworm.
2. Open its preferences and change the language to something other than english (I've managed to reproduce the issue with both bulgarian and arabic translation).
3. Apply the changes with the "OK" button and restart Bookworm when prompted to do so.
4. When Bookworm restarts, from the "Help" menu, open the "About" dialog.
5. Notice how no matter that the display language is different than english, the content of the "About" dialog is still in english.

Expected behavior

Even though the display language of Bookworm is different than english, the content of the "About" dialog is still in english.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.329), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b2, x86 (32-bit).

In the "Bookworm File Associations" dialog, the string "Associate files of type" is not localized

Describe the Problem

In the "Bookworm File Associations" dialog, the string "Associate files of type" for each individual file type is not localized. Instead, it is shown in english. Only the "Associate files of type" part is not localized - the name of the file type is localized.

To Reproduce

Steps to reproduce the behavior:

1. Open Bookworm.
2. Open Bookworm preferences.
3. Select the "Main" preferences category.
4. From the "Display language" combo box, choose a language other than english (I can reproduce it with bulgarian and arabic).
5. Apply the changes with the "OK" button and restart Bookworm when prompted to do so.
6. When Bookworm restarts, open the Bookworm preferences.
7. Select the "Main" preferences category.
8. Activate the "Manage File Associations" button in there. The "Bookworm File Associations" dialog opens.
9. Use TAB to navigate between the available buttons in the "Bookworm File Associations" dialog.

Expected behavior

The "Associate files of type" string is displayed in english, even though Bookworm's display language is not english.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.329), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b2, x86 (32-bit).

Bookworm does not show the name of the voice "Irina" from Innoetics

Describe the Problem

There is a bulgarian SAPI5 voice, developed by the greek company "Innoetics". The voice is called "Irina". Bookworm fails to display its name in the list of available voices. Instead, it shows only a blank entry in its place. The voice works and can be used in Bookworm - only its name does not display as it should. This occurs only in Bookworm. Other programs (e.g. NVDA, JAWS, Balabolka) do see the voice correctly with its name.

Unfortunately, the company "Innoetics" does no longer distribute its voices (they can't be downloaded from their website). But I can privately send you an installer for a demo of the voice, if needs be.

If I can provide some logs in which the issue is recorded/reproduced, please let me know how to create them and from where to obtain them.

To Reproduce

Steps to reproduce the behavior:

1. Install the voice "Irina" from "Innoetics" from its installer. You can use it as a demo for our purposes.
2. Open Bookworm.
3. Open the Bookworm preferences.
4. Navigate to the "Speech" section.
5. Go to the "Select Voice" combo box.
6. Open the "Select Voice" combo box with Alt+Down Arrow.
7. Use the Up/Down arrow keys to navigate between available voices.

Expected behavior

Bookworm should see the voice "Irina" with its display name in the list of available voices.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.329), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b2, x86 (32-bit).

The preferences dialog doesn't open

Describe the Problem

I can't open the preferences dialog. When I try to do it, never happen.
A clear and concise description of what the problem is.

To Reproduce

1. Open the portable app;
2. Try to open the preferences dialog by clicking on this in tools menu or pressing CTRL+Shift+P.
   Steps to reproduce the behavior:
3. Go to '...'
4. Click on '....'
5. See error

Expected behavior

The preferences dialog should open
A clear and concise description of what you expected to happen.

The File You've Opened

Any book or without it at all
Tell us what is the format of the file you've opened [e.g. PDF]. If possible, attach the file you have open in Bookworm when the problem happened.

Desktop (please complete the following information):

• OS: [e.g. Windows 10 64-bit]
  Windows 10 Pro 64 bit
• Bookworm version [e.g. 0.1.0b1]
  Bookworm version 0.2 A4
• Recent settings you may have changed in Bookworm [e.g. changed the speech settings]

Additional context

I use the portable app on my Windows 10 with NVDA. Can't to change any preferences...
Add any other context about the problem here.

Ability to synchronize books (incl. progress) between devices

Is your feature request related to a problem? Please describe.

If I want to use Bookworm on more than one computer, I can do that. But as far as I know, at the moment I cannot synchronize my book reading progress between the different computers.

Describe the solution you'd like

Maybe providing an option in Bookworm to save the currently read book in some specific to Bookworm file format (e.g. XML-based) that contains the book content, the bookmarks, notes, book reading progress, etc. is a good solution as a start. That way we can save our book in this format and transfer it between our computers (e.g. on a flash drive, SD card, cloud storage, etc.). And no matter on which computer with Bookworm installed we open that book file, we can resume reading from where we left off, review our bookmarks and notes, etc.

unable to access links in epub files

Hello,

Many Epub files have footnotes and endnotes which are linked to from within the text. This is very common, and very helpful, in academic texts, but is also very useful in other texts. Often readers will have these listed in their notes area but I notice that BW doesn't seem to acknowledge these links. It would be most helpful for the program to support such links. I am pleased to send, if needed, a copy of a text with plenty of these notes.

Thanks,

Bookworm inserts a "comma" character between pages when reading

Describe the Problem

I don't know if it is intentional or not, but Bookworm seams to be inserting a "comma" (,) character between pages. The comma character is not visible on the end or the beginning of a page, but when reading aloud with Bookworm, it can be observed that something is read between the pages - something, that is not part of the text of the loaded file. Depending on the speed of the TTS engine being used, it may be missed, but it is still there. At first I was wondering what it is, but last night I was reading a book that had a few consecutive blank pages and was able to recognize the thing that the TTS engine was trying to read between the pages. It was trying to say "comma", but since the bulgarian word for "comma" is long, in most cases the TTS engine was barely able to pronounce the first syllable from the 3-syllable bulgarian word for "comma", before it gets interrupted and forced to read the next page of the book. Last night however, when reading those few blank pages, it managed to read almost the whole bulgarian word for "comma", so I was able to understand what it was trying to say/read. Strangely enough, I don't hear the "comma" character being read while reading the book with the screen reader - only when reading it with Bookworm directly.

Actually, now that I think of it, the insertion of the "comma" character may not be between every two pages, but only in certain circumstances. But what are those certain circumstances - I haven't figured out yet.

So, is it intentional? Is Bookworm intentionally inserting the "comma" (,) character between the pages and sending it to the TTS engines while reading aloud? And if so - why it is doing it? Or is it just a bug?

To Reproduce

Steps to reproduce the behavior:

1. Launch Bookworm.
2. Load a book.
3. Start reading aloud the book with Bookworm.
4. Observe how in some cases, Bookworm inserts a "comma" character between pages and sends it to the TTS engine for reading/interpretation.

Expected behavior

Bookworm should not insert such characters that are not present in the loaded book, unless it is absolutely necessary.

The File You've Opened

The file seams not to matter.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1909 (build 18363.535), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b4, 32-bit, in bulgarian.

error message on first-time openafter install

after installation completed and run bookworm for the first time, the following error message pop up.

Fatal error detected
Failed to execute script pyi_rth_multiprocessing

It only happened on the first time run after installation. Subsequent run of bookworm will not produces this error message. Although not critical, hopes can't be fixed in the next release.

Ability to choose the font for the book's content

Is your feature request related to a problem? Please describe

Yes, my feature request is related to a problem. I rarely come across such e-books, but there are a few of them, in which the text has some characters that standard fonts (e.g. Segoe UI) do not support. In such cases, the e-book requires the usage of other fonts (e.g. Dejavu), that do support such non-standard (Unicode) characters.

Describe the solution you'd like

I would like for Bookworm to have an option to choose which font is used for displaying the e-book's content (the text area on the right). If possible, that could be extended to the "Table of contents" tree view area on the left as well.

Describe alternatives you've considered

I don't think there are alternatives, except maybe for using another e-book reading program, which provides the ability to choose which font is used for displaying the e-book's content (e.g. Balabolka). But such a solution in this case is besides the point - isn't it (?). 😀

Multi-language version of the program

This is a much sought after program. For many blind users, the lack of English is a problem.
I propose to provide a tool that will translate Bookworm into other languages.
What do you think?

Bookworm doesn't recognize headings in PDF documents

Describe the Problem

In some PDF documents, it is possible to navigate through headings using the NVDA commands h and shift-h, just like in HTML web pages. However, this currently doesn't work in Bookworm; it only works in Adobe Acrobat Reader DC.

To Reproduce

1. Open the Reaper Users' Guide in Acrobat Reader DC; see link below to download the file.
2. Go to a page that contains headings, for example 287.
3. Using NVDA, press h and shift-h. You'll notice that there are two headings, namely 15.1 and 15.2.
4. Open the same PDF file in Bookworm, go to the same page, and notice that pressing h and shift-h does nothing.

Expected behavior

Bookworm should recognize the same headings as Acrobat Reader does.

The File You've Opened

Please download it, as it's too big to attach here:
https://www.reaper.fm/userguide/ReaperUserGuide5985c.pdf

Desktop (please complete the following information):

• Windows 10 pro 64-bit 1909.
• Bookworm 0.1B3

explicitly use wxpython==4.0.3

In versions of wxpython>4.0.3, representation of control labels aren't necessarily what you'd want. The contrast can easily be seen by running:

pip install wxpython==4.0.3
invoke run

It might be helpful from a usability perspective to rely on this older version until something else is done by the folks at WxWidgets.
If anyone knows another way of keeping this more elegant interface in later versions, I'd love to hear about it.

Distribute portable version

Is your feature request related to a problem? Please describe.

No.

Describe the solution you'd like

I believe it would be beneficial to additionally include portable distributions along-side the provided installers.

Describe alternatives you've considered

Additional context

Some users might want to carry the app around on removable media or avoid having to deal with windows installers altogether.

Stable and alpha versions of Bookworm show different number of pages for the same book

Describe the Problem

While reading books and testing the current alpha version of Bookworm, I've noticed that it and the stable release show the same book with different number of pages. I've noticed this with EPUB files. For example, the same book in the stable release of Bookworm is displayed with 397 pages and in the current alpha is displayed with 430 pages. In all cases the number of pages is bigger in the alpha version than it is in the stable one.

Steps to Reproduce it

1. Open the stable release of Bookworm.
2. Load a book in EPUB format in it (preferably one with more pages, e.g. one with a few hundred pages).
3. Check how many pages does the book have, by opening the "Go to page" dialog of Bookworm.
4. Open the alpha release of Bookworm.
5. Load the same book from step 2.
6. Check how many pages does the book have, by opening the "Go to page" dialog of Bookworm.

Expected behavior

The number of pages should be the same, considering that the book is the same in both cases.

Actual behavior

The number of pages is different - the alpha version of Bookworm shows it with more pages.

The File You've Opened

The problem occurs at least with EPUB files. I don't have other e-book formats to test it with. I've tried with several books/files and the problem occurs with all of them.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 20H2 (build 19042.746), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.2a4

Zoom level resets on page change

Describe the Problem

If I change the zoom level of the text in an opened book and go to another page, zoom level resets. But executing the zoom-in/zoom-out commands continues to change from the last zoom level.

To Reproduce

Steps to reproduce the behavior:

1. Open a book in Bookworm.
2. Use the zoom commands to increase or decrease the zoom level of the displayed book text.
3. Go to another page.
4. Observe how the zoom level will reset to default.
5. Use the zoom commands again to increase or decrease the zoom level on the new page.
6. Observe how the zoom level continues to change not from the default value to which it was reset during the page change, but from the level that it was on before the page change.

Expected behavior

Bookworm should not reset the zoom level while changing the pages.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.356), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b3, x86 (32-bit).

hope Bookworm can display the images in the e-book

Is your feature request related to a problem? Please describe.

As described in the titleMany e-books contain images, Although most of us don't know what's in the image, But that doesn't mean it's useless.
Bookworm is a good software, if it already has this function, please let me know and please to close the issue

Describe the solution you'd like

Be able to display images on the screen in an appropriate way.

Describe alternatives you've considered

I didn't think of an alternative for the time being. Displaying images is necessary.

Additional context

1. Ask others to describe the image content in the book.
2. I believe that visual users would like to have this feature more.

In the "Table of contents" tree view in the left pane of Bookworm, only level 1 items are tracked, but not level 2 ones

Describe the Problem

In some books, the table of contents contains not only chapters, but parent items, which in some cases are called "parts". So, a "part" can contain a few chapters. In such cases, Bookworm displays the "parts" as "level 1" items, and the chapters - as "level 2" items. If the book contains only chapters but not parts, the chapters are displayed by Bookworm as "level 1" items.

When Bookworm reads a book, whenever a new part/chapter is reached, the focus in the "Table of contents" tree view moves to the item corresponding to the respective part/chapter. But that is valid only for level 1 items. If the book contains not only chapters but parts as well (chapters are displayed as "level 2" items), Bookworm moves the focus in the "Table of contents" tree view only when a new part ("level 1" item) is reached. When a new chapter ("level 2" item) is reached, Bookworm does not change the focus to it in the "Table of contents" tree view. Is this intentional, a bug, or a technical limitation?

To Reproduce

Steps to reproduce the behavior:

1. Launch Bookworm.
2. Load a book that contains not only chapters, but parts containing chapters as well (includes "level 2" items in the "Table of contents" tree view).
3. Start reading the book aloud with Bookworm (not via the screen reader).
4. Observe when the focus changes in the "Table of contents" tree view, when a new part and chapter is reached.

Expected behavior

Bookworm should move the focus in the "Table of contents" tree view not only when a "level 1" item is reached, but when a "level 2" item is reached as well.

The File You've Opened

Any EPUB or PDF file that contains "level 2" items in its "table of contents".

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1909 (build 18363.535), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b4, 32-bit, in bulgarian.

Bookworm does not correctly initialize a specific bulgarian SAPI5 TTS voice

Describe the Problem

A friend of mine has reported this to me and I was able to reproduce it.

There is one very old (made in 2005 I think) SAPI5 bulgarian voice. It is called "Gergana" (the software product itself is called "SpeechLab").

When the user configures Bookworm to use this voice and presses F5 to read an opened book with it, the voice just stutters on the first syllable from the text.

I've restarted Bookworm with debugging enabled and reproduced the problem. Then Ive gathered the log files from the \AppData\Roaming\Bookworm\logs\ folder. I'll attach them here. If needs be, I'll personally send you the voice for you to test with it and some bulgarian books.

I'm afraid however, that this is an incompatibility between the voice "Gergana" and the method which Bookworm uses to access the SAPI5 TTS voices in Windows and I don't know if you'll be able to do something about it. Still, I'm reporting it, just in case I'm wrong and the problem can be fixed.

To Reproduce

Steps to reproduce the behavior:

1. Install the bulgarian SAPI5 voice "Gergana" (the product "SpeechLab").
2. Open Bookworm.
3. Configure Bookworm to use the SAPI5 voice "Gergana".
4. Open a bulgarian book in Bookworm.
5. Press F5 to start reading the book with Bookworm with the voice "Gergana".

Expected behavior

The voice should start reading the book.

The File You've Opened

It is an EPUB book in bulgarian (not a particular one).

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1909 (build 18363.535), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b4, 32-bit, in bulgarian.

Additional context

1. The voice "Gergana" is a 32-bit only voice. That means, that 64-bit programs that under 64-bit Windows look only for 64-bit voices, will not be able to use this voice.
2. The problem is reproducible under 32-bit Windows 7 as well.

Bookworm_Logs_2019-12-17.zip

The "Rendered Page" dialog shows only a blank screen

Describe the Problem

NOTE: I might be wrong, but I think that at least some vision may be required, in order to properly reproduce and diagnose this issue.

Even if a book is opened/loaded and even if it is being read aloud, when the "Render Page" function is executed, the dialog/screen that appears is a blank one. No content from the book (text and/or images) is displayed.

I use the high-contrast black theme in Windows 10 and at first I thought that the issue may be related to it (sometimes such issues occur in programs when a high-contrast theme is used in Windows). But I've disabled the usage of a high-contrast theme and the issue persisted.

To Reproduce

Steps to reproduce the behavior:

1. Open Bookworm.
2. Open a book (the file format seams not to matter).
3. Optionally, press F5 to start reading the book aloud via SAPI5 TTS.
4. Execute the "Render page" function (pressing Control+R will do it).
5. Observe what is displayed on the screen.

Expected behavior

A rendered version of the book's content should be displayed, but it is not - only a blank screen is shown.

The File You've Opened

It does not matter if the file is EPUB or PDF. It does not matter if the text is in latin or cyrillic.

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1903 (build 18362.329), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b2, x86 (32-bit).

A book in EPUB format brakes correct functionality of Bookworm

Describe the Problem

A friend of mine sent me a book in EPUB format, which causes incorrect functionality of Bookworm. The book content seams to load and read aloud correctly, but when I try to close the book with Control+W, open another book with Control+O, close the Bookworm window with Alt+F4, it just does not work.

Pressing Control+W does nothing. Control+O brings the open file dialog, I can select a file and press ENTER on it, but after that the result is as if I haven't tried to open a file - the problematic EPUB file remains opened/loaded in Bookworm. Pressing Alt+F4 does nothing. I can terminate Bookworm from Windows 10's Task Manager (from the "Processes" tab).

Those are my observations from my brief testing. There might be other broken functions of Bookworm with this problematic EPUB file.

To Reproduce

Steps to reproduce the behavior:

1. Launch Bookworm.
2. Open the problematic EPUB file in Bookworm.
3. Execute the "Close current book" command.
4. Try to open another book with the "Open" command.
5. Try to close Bookworm with Alt+F4 or the "Exit" command.

Expected behavior

Bookworm maybe should work correctly with this EPUB file, if the fault is not in the file itself.

The File You've Opened

The file is an EPUB one. I'll attach it here, if possible. Note, that the file is in bulgarian (cyrillic).

Desktop (please complete the following information):

• Operating system: Windows 10 Pro version 1909 (build 18363.693), 64-bit, in Bulgarian with all locale settings set to "Bulgarian".
• Bookworm version: 0.1b4.

TestBook.zip

NVDA does not seem to read past end of page.

Describe the Problem

NVDA does not continue to read past the end of the current page, no matter which setting is chosen in the reading section of preferences. I understand that the setting says "when pressing play", and therefore is probably only applicable to the program's own TTS.
There is no setting I can find which allows the entire page or book to be displayed for NVDA to read with the navigation functions of BW available. One must start the reading and, when it is done, press enter to turn the page and then start reading again. Would it be possible for the screen reader to read the entire text without interuption?

To Reproduce

Steps to reproduce the behavior:

1. Open an Epub book with multiple chapters/pages.o
2. SGo to one of the chapters and start reading with your screen reader, not with the program TTS.
3. The screen reader will not go on reading when the end of the page is reached.

Expected behavior

I wish the screen reader to keep reading until told to stop.

The File You've Opened

Epub

Desktop (please complete the following information):

• OS: Windows 7 64 Bit

• Bookworm version 0.1.0b1