Skip to content

Commit a652e63

Browse files
committed
More readme updates
1 parent a1a5020 commit a652e63

2 files changed

Lines changed: 40 additions & 17 deletions

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,21 @@
55
## Features
66

77
- Written entirely in Rust to ensure it's modern, fast, and memory-safe
8-
- Supports a wide range of document formats: HTML/XHTML, EPUB, FB2, CHM, DAISY, PDF, DOCX/DOCM, PPTX/PPTM, DOC, PPT, ODT/FODT, ODP/FODP, RTF, MOBI/AZW/AZW3, Markdown, and plain text
8+
- Supports a wide range of document formats:
9+
- HTML documents (htm/html/xhtml)
10+
- EPUB books (epub)
11+
- FictionBook ebooks (fb2)
12+
- CHM help files (chm)
13+
- DAISY books (opf/zip)
14+
- PDF documents (pdf)
15+
- Word documents (doc/docx/docm)
16+
- PowerPoint presentations (ppt/pptx/pptm)
17+
- OpenDocument text files (odt/fodt)
18+
- OpenDocument presentations (odp/fodp)
19+
- RTF documents (rtf)
20+
- MOBI/Kindle books (mobi/azw/azw3)
21+
- Markdown documents (md/markdown/mdx/mdown/mdwn/mkd/mkdn/mkdown/ronn)
22+
- Plain text and log files (txt/log)
923
- Intuitive tabbed interface for managing multiple documents, with single-instance behavior so opening a file from the shell or a file association reuses the running window
1024
- Full screen reader accessibility, including live-region status announcements for actions like search results and navigation
1125
- Robust find functionality with match case, whole word, and regular expression options, plus persisted search history

doc/readme.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,40 +35,45 @@ The workaround, eventually surfaced through the JAWS discussion group after mont
3535
Paperback supports the following formats and extensions:
3636

3737
* CHM help files (`.chm`)
38+
* DAISY books (`.opf`, `.zip`)
3839
* EPUB books (`.epub`)
3940
* FB2 ebooks (`.fb2`)
4041
* HTML documents (`.htm`, `.html`, `.xhtml`)
4142
* Markdown documents (`.md`, `.markdown`, `.mdx`, `.mdown`, `.mdwn`, `.mkd`, `.mkdn`, `.mkdown`, `.ronn`)
42-
* Microsoft Word documents (`.docx`, `.docm`)
43+
* Microsoft Word documents (`.docx`, `.docm`, `.doc`)
44+
* MOBI/Kindle books (`.mobi`, `.azw`, `.azw3`)
4345
* OpenDocument presentations (`.odp`, `.fodp`)
4446
* OpenDocument text files (`.odt`, `.fodt`)
4547
* PDF documents (`.pdf`)
46-
* PowerPoint presentations (`.pptx`, `.pptm`)
48+
* PowerPoint presentations (`.pptx`, `.pptm`, `.ppt`)
4749
* RTF documents (`.rtf`)
4850
* Plain text and log files (`.txt`, `.log`)
49-
* XML documents (`.xml`)
5051

5152
## Keyboard shortcuts
5253

5354
Paperback is designed for keyboard-first and screen reader-first use. Here are the current shortcuts.
5455

56+
Shortcuts below are for Windows and Linux. Where macOS differs, the macOS equivalent is noted in parentheses — mainly because Ctrl+G, Ctrl+W, and Alt+Left/Right are already claimed by other system or app conventions on that platform.
57+
5558
### File menu
5659

5760
* `Ctrl+O`: Open a document.
58-
* `Ctrl+F4`: Close the current document.
59-
* `Ctrl+Shift+F4`: Close all open documents.
61+
* `Ctrl+F4` (macOS: `Cmd+W`): Close the current document.
62+
* `Ctrl+Shift+F4` (macOS: `Cmd+Shift+W`): Close all open documents.
63+
* `Ctrl+Shift+T`: Reopen the last closed document.
6064
* `Ctrl+R`: Show the "All Documents" dialog (from Recent Documents).
65+
* `Ctrl+Q`: Exit (Windows/Linux only; on macOS this is under the app menu instead).
6166

6267
### Go menu
6368

6469
* `Ctrl+F`: Show the Find dialog.
65-
* `F3`: Find next.
66-
* `Shift+F3`: Find previous.
67-
* `Ctrl+G`: Go to line.
68-
* `Ctrl+Shift+G`: Go to percent.
70+
* `F3` (macOS: `Cmd+G`): Find next.
71+
* `Shift+F3` (macOS: `Cmd+Shift+G`): Find previous.
72+
* `Ctrl+G` (macOS: `Cmd+L`): Go to line.
73+
* `Ctrl+Shift+G` (macOS: `Cmd+Shift+L`): Go to percent.
6974
* `Ctrl+P`: Go to page (when supported by the current document).
70-
* `Alt+Left`: Go back in navigation history.
71-
* `Alt+Right`: Go forward in navigation history.
75+
* `Alt+Left` (macOS: `Cmd+[`): Go back in navigation history.
76+
* `Alt+Right` (macOS: `Cmd+]`): Go forward in navigation history.
7277
* `[`: Previous section.
7378
* `]`: Next section.
7479
* `Shift+H`: Previous heading.
@@ -84,9 +89,13 @@ Paperback is designed for keyboard-first and screen reader-first use. Here are t
8489
* `Ctrl+B`: Jump to all bookmarks and notes.
8590
* `Ctrl+Alt+B`: Jump to bookmarks only.
8691
* `Ctrl+Alt+M`: Jump to notes only.
87-
* `Ctrl+Shift+W`: View note text at the current position.
92+
* `Ctrl+Shift+W` (macOS: `RawCtrl+Shift+W`, i.e. the physical Control key rather than Cmd): View note text at the current position.
8893
* `Shift+K`: Previous link.
8994
* `K`: Next link.
95+
* `Shift+G`: Previous image.
96+
* `G`: Next image.
97+
* `Shift+F`: Previous figure.
98+
* `F`: Next figure.
9099
* `Shift+T`: Previous table.
91100
* `T`: Next table.
92101
* `Shift+S`: Previous separator.
@@ -100,7 +109,7 @@ Paperback is designed for keyboard-first and screen reader-first use. Here are t
100109

101110
### Tools menu
102111

103-
* `Ctrl+W`: Show word count for the current document.
112+
* `Ctrl+W` (macOS: `RawCtrl+W`, i.e. the physical Control key rather than Cmd): Show word count for the current document.
104113
* `Ctrl+I`: Show document info.
105114
* `Ctrl+T`: Show table of contents.
106115
* `F7`: Show elements list.
@@ -113,7 +122,7 @@ Paperback is designed for keyboard-first and screen reader-first use. Here are t
113122
* `Ctrl+Shift+B`: Toggle bookmark at the current selection/cursor.
114123
* `Ctrl+Shift+N`: Add or edit bookmark note at the current selection/cursor.
115124
* `Ctrl+Alt+W`: Toggle word wrap.
116-
* `Ctrl+,`: Open options.
125+
* `Ctrl+,`: Open options (macOS: Preferences, under the app menu).
117126
* `Ctrl+Shift+S`: Toggle sleep timer.
118127

119128
### Help menu
@@ -127,8 +136,8 @@ Paperback is designed for keyboard-first and screen reader-first use. Here are t
127136
### Additional document-view keys
128137

129138
* `Delete` / `Numpad Delete` on the tab control: Close the selected document tab.
130-
* `Enter` in the document text: Activate link at cursor, or open a table view when on a table marker.
131-
* `Shift+F10` in the document text: Open the context menu.
139+
* `Enter` or `Space` in the document text: Activate link at cursor, or open a table view when on a table marker.
140+
* `Shift+F10` or the Menu/Application key in the document text: Open the context menu.
132141

133142
## Supported languages
134143

0 commit comments

Comments
 (0)