NVDA PDF Reader Add-on – Documentation
Version 0.1.0
The PDF Reader add-on transforms NVDA into a comprehensive PDF reading and management environment, built with accessibility as its core foundation. It provides blind and visually impaired users with powerful tools for text extraction, navigation, annotation, optical character recognition, high-quality speech, and document manipulation — all through an intuitive dialog interface and extensive keyboard shortcuts.
Table of Contents
- Overview
- Feature List
- Installation
- Getting Started
- The PDF Reader Panel
- Menu Reference
- Optical Character Recognition (OCR)
- Text‑to‑Speech and Reading Aloud
- Exporting Documents
- Settings Dialog
- Keyboard Shortcuts
- System Requirements
- Support and Community
- Privacy
Overview
The PDF Reader add-on turns NVDA into a full-featured PDF workstation. It opens standard PDF files (including password-protected ones), extracts text in multiple reading modes, and allows you to navigate, search, bookmark, annotate, and export documents. Integrated OCR enables reading of scanned/image-based PDFs, while Microsoft Edge TTS voices provide natural‑sounding read-aloud functionality. Document manipulation tools let you rotate, delete, merge, split, and watermark pages, redact sensitive text, and extract embedded images.
All actions are reachable via clearly labeled buttons, context menus, and customizable keyboard shortcuts. A menu navigator (Ctrl+Shift+M) offers quick access to every menu from within the text area. Reading progress, bookmarks, notes, and settings are automatically saved and restored across sessions.
Feature List
- Multi‑format PDF import – open PDF files, including password‑protected ones, from the file dialog or from a list of recently used files.
- Five text extraction modes – Blocks, Text, Words, HTML, and Structured – to adapt to different document layouts.
- Extraction profiles – Default, Simple, Detailed, OCR Only, and Clean profiles that filter and format extracted text.
- Built‑in OCR (Tesseract) – scan image‑based pages with automatic detection of Tesseract installations; manual browse fallback if needed.
- Text‑to‑speech with Edge TTS – read current page aloud using neural voices; full control over voice, speed, pitch, and volume; voice preview.
- Audiobook generation – export pages or entire document as MP3 files with selected TTS settings.
- Advanced search – search across all pages or within the current page; supports case sensitivity, whole words, regular expressions, and search history.
- Find and replace – replace occurrences on the current page directly inside the PDF, preserving document layout.
- Bookmark manager – add, rename, delete, jump to, and export bookmarks with custom titles.
- Note taking – attach multi‑line notes to any page.
- Table of contents navigation – browse the document outline in a tree view and jump to any section.
- Multi‑format export – export to TXT, DOCX, HTML, JSON, CSV (tables), and MP3 audiobook, with optional inclusion of notes and OCR text.
- Document manipulation – rotate pages, delete pages, extract page ranges, merge PDFs, split into single pages, extract images, save page as image, add text watermarks, redact sensitive text.
- Text annotations – add visible text annotations to PDF pages and save a new annotated copy.
- Password protection – encrypt PDF with AES‑256 and a user‑defined password.
- Visual customization – high contrast, colour inversion, dark mode, adjustable font size and zoom level.
- Split view – display two consecutive pages side by side for comparison.
- Auto‑scroll – automatically advance pages at a configurable speed.
- Document statistics – total words, characters, images, links, and per‑page averages.
- Page comparison – compare word/character counts across multiple specified pages.
- Link extraction – collect and save all hyperlinks from the document.
- Text translation – translate the current page content via Google Translate.
- Reading history – automatic resume prompt and persistent progress tracking.
- Recent files list – quick access to up to 15 previously opened PDFs.
- Menu navigator – (Ctrl+Shift+M) opens a list of all menus for rapid access.
- Metadata viewer – display and copy PDF document properties.
- Persistent settings – all preferences saved in a local JSON file.
- Accessible dialogs – all controls are labelled and reachable via keyboard; progress dialogs provide real‑time status updates.
Installation
- Download the
.nvda-addon file for the PDF Reader.
- Open NVDA (if not already running) by pressing
Control+Alt+N or using the Start menu.
- Open the NVDA menu with
NVDA+N, go to Tools, and select Manage Add‑ons.
- In the Add‑ons Manager, press the Install button.
- Browse to the downloaded add‑on file, select it, and press Enter.
- Review the confirmation and choose Yes to install. NVDA will ask to restart; press Enter to restart.
- After restart, the add‑on is ready. Access it via
NVDA+Alt+P or the Tools menu.
Getting Started
Press NVDA+Alt+P to open the main PDF Reader dialog. From there you can import a PDF, resume the last file, or pick from recent files. Alternatively, use the NVDA Tools menu and select PDF Reader.
Once a PDF is opened, the PDF Reader Panel appears, showing the document content and a set of toolbars and buttons. The panel can be closed with Ctrl+W, Escape, or the Close Reader Panel button.
The PDF Reader Panel
This is the main working area. It contains:
- Toolbar buttons – File, Edit, View, Tools, Navigate, Manipulations, Settings, Help. Each opens a dropdown menu.
- Information bar – shows current page / total pages, and a Reading Mode dropdown.
- Text display area – read‑only text box showing extracted content. You can select text, navigate, and use standard review commands.
- Navigation row – Prev / Next buttons, a page number dropdown, and a Go button to jump to a specific page.
- Action buttons – quick access to Search, Bookmark, TOC, OCR, Export, Note, and Read (aloud).
- Status bar – reading mode, zoom level, cursor position, and text length.
Within the text area, you can press Ctrl+Shift+M to open the Menu Navigator – a list of all menus and Settings for immediate access.
File Menu
- Import PDF (Ctrl+I) – open another PDF, closing the current one.
- Export (Ctrl+Shift+E) – open the export dialog.
- Properties (Ctrl+M) – view document metadata (title, author, page count, file size, etc.).
- Protect PDF – add a password and save an encrypted copy.
- Close (Ctrl+W) – close the reader panel.
Edit Menu
- Find (Ctrl+F) – open search dialog with options.
- Find Next (F3) – jump to the next search result.
- Find Previous (Shift+F3) – jump to the previous result.
- Find and Replace – enter find/replace text; replacements are performed directly on the current page by redacting the old text and inserting the new text in its place.
- Copy Page Text (Ctrl+C) – copy the current page text (or selection) to clipboard.
- Copy All Text (Ctrl+Shift+C) – copy text from all pages.
- Highlight Selection (Ctrl+Shift+L) – add a highlight annotation for selected text on the current page.
View Menu
- Zoom In (Ctrl+Plus) / Zoom Out (Ctrl+Minus) / Reset Zoom (Ctrl+0) – adjust text size.
- High Contrast (Ctrl+H) – toggle uppercase display.
- Invert Colors (Ctrl+Shift+I) – reverse text order.
- Dark Mode – toggle dark background with light text.
- Split View (Ctrl+Shift+V) – show a second panel with the next page.
Tools Menu
- OCR (Ctrl+Shift+O) – run optical character recognition.
- Extraction Profile (Ctrl+Shift+P) – switch between text processing profiles.
- Read Aloud (Ctrl+R) – start/stop page reading.
- Auto Scroll (Ctrl+Shift+A) – automatic page turning.
- Compare Pages (Ctrl+Shift+C) – compare word/char counts for specified pages.
- Statistics (Ctrl+Shift+S) – show document statistics dialog.
- Translate Page (Ctrl+Shift+T) – translate current page to another language.
- Extract Links – save all links to a text file.
- Voice Preview – play a short TTS sample with current settings.
- Redact Text – permanently remove all occurrences of a given text from the whole document.
Navigate Menu
- Bookmarks (Ctrl+B) – add a bookmark.
- Bookmarks Manager (Ctrl+Shift+B) – open the bookmark list for editing, jumping, exporting.
- Export Bookmarks – save bookmarks to a text file.
- Table of Contents (Ctrl+T) – open structured TOC tree.
- Annotations (Ctrl+Shift+N) – view saved annotations.
- Highlights (Ctrl+Shift+H) – view highlights.
- Go To Page (Ctrl+G) – type a page number.
- Previous Page (Alt+PageUp) / Next Page (Alt+PageDown).
Manipulations Menu
- Add Annotation – opens a dialog with an Add and Cancel button; the text annotation is placed on the current page and the document is saved as a new PDF.
- Rotate Page Clockwise / Counterclockwise – rotate the current page 90 degrees.
- Delete Current Page – remove the page (with confirmation).
- Extract Pages – create a new PDF from a page range.
- Merge PDF – combine another PDF into the current document.
- Split PDF – save each page as a separate PDF file.
- Extract Images – save all embedded images to a folder.
- Save Page as Image – render the current page as a high‑resolution PNG.
- Add Watermark – apply a diagonal text watermark to all pages.
Optical Character Recognition (OCR)
When a PDF contains scanned images, use OCR to extract readable text:
- Press
Ctrl+Shift+O or the OCR button.
- Choose Current page, All pages, or a Page range (enter start/end).
- Press Start. The add‑on first looks for Tesseract in standard installation paths (
C:\Program Files\Tesseract-OCR\tesseract.exe and C:\Program Files (x86)\Tesseract-OCR\tesseract.exe). If not found, you will be prompted to locate the executable manually.
- A progress dialog shows the OCR status. Results are cached; re‑running OCR on the same page uses the cache.
- After processing, the extraction profile automatically switches to OCR Only, displaying the recognised text. You can later switch back to other profiles.
Text‑to‑Speech and Reading Aloud
The add‑on uses Microsoft Edge TTS for high‑quality speech. Configure it in the Settings dialog (Text‑to‑Speech tab):
- Voice – choose from a list. Press Fetch Latest Voices to retrieve the full catalogue from Microsoft servers; the list is saved locally.
- Speed – from –50% to +50%.
- Pitch – from –20Hz to +20Hz.
- Volume – 0 to 100 (in the Advanced tab).
To start reading, press Ctrl+R or click the Read button. The button label changes to Stop; press again to stop. When playback finishes, the reader stops automatically. Use Voice Preview from the Tools menu to hear a short sample.
Audiobook export (MP3) also respects these TTS settings; chunking can be enabled for large documents in the Advanced settings tab.
Exporting Documents
To export content, press the Export button or Ctrl+Shift+E. In the dialog:
- Format – TXT, DOCX, MP3 Audiobook, CSV (tables), JSON, HTML.
- Scope – current page, entire PDF, or tagged pages.
- Options – include notes, include OCR text.
After selecting a save location, a progress indicator shows the export status. For DOCX, the python-docx library is required. For CSV, pdfplumber and pandas are needed; the export extracts tables from the selected pages.
Settings Dialog
All preferences are stored automatically. The dialog has three tabs:
- General – zoom level, font size, high contrast, invert colors, auto‑scroll speed, default extraction profile.
- Text‑to‑Speech – voice selection (with fetch button), speed, pitch.
- Advanced – default export directory, TTS volume (0‑100), TTS chunking on/off.
After pressing OK, settings are applied immediately and saved.
Keyboard Shortcuts
| Shortcut | Action |
NVDA+Alt+P | Open PDF Reader main dialog |
Ctrl+I | Import PDF |
Ctrl+W | Close PDF Reader Panel |
Ctrl+F | Search |
F3 | Find next search result |
Shift+F3 | Find previous search result |
Ctrl+C | Copy current page text (or selection) |
Ctrl+Shift+C | Copy all pages text |
Ctrl+Plus | Zoom in |
Ctrl+Minus | Zoom out |
Ctrl+0 | Reset zoom |
Ctrl+H | Toggle high contrast |
Ctrl+Shift+I | Toggle colour inversion |
Ctrl+Shift+V | Toggle split view |
Ctrl+Shift+O | OCR |
Ctrl+Shift+P | Change extraction profile |
Ctrl+R | Read aloud / Stop |
Ctrl+Shift+A | Auto‑scroll on/off |
Ctrl+Shift+C | Compare pages |
Ctrl+Shift+S | Document statistics |
Ctrl+B | Add bookmark |
Ctrl+Shift+B | Bookmarks manager |
Ctrl+T | Table of contents |
Ctrl+Shift+N | View annotations |
Ctrl+Shift+H | View highlights |
Ctrl+G | Go to page |
Alt+PageUp | Previous page |
Alt+PageDown | Next page |
Ctrl+Shift+E | Export dialog |
Ctrl+M | PDF properties |
Ctrl+Shift+M | Menu Navigator |
Ctrl+Shift+L | Highlight selection |
Ctrl+Shift+T | Translate page |
F1 | Open help (shortcuts list) |
Ctrl+F1 | About dialog |
Support and Community
For questions, feedback, or assistance:
- Use the Help dialog (
F1) inside the reader for a full shortcuts reference.
- Join the Telegram channel Blind Tech Nexus at https://t.me/blindtechvisionary to connect with other users and the developer.
Your suggestions help shape future updates. Please share your experience and report any issues through the channel.
Privacy
This add‑on operates entirely offline. No document content, personal data, or usage statistics are collected or transmitted. Voice list fetching connects to Microsoft servers only when you explicitly press the Fetch Latest Voices button. All PDF processing, OCR, and TTS audio generation occur locally on your computer.
Note: The add‑on bundles several open‑source libraries. If your security software blocks these components, please allow the add‑on’s folder or the specific DLL/executable files. The OCR feature depends on a working Tesseract installation; if the automatic detection fails, you can manually locate the tesseract.exe file.
NVDA PDF Reader Add‑on – Version 0.1.0 – Built for accessibility.