Skip to content

Docs: state which unknown-word choices are remembered - #13338

Merged
niksedk merged 1 commit into
mainfrom
docs/skip-all-not-persisted
Aug 7, 2026
Merged

Docs: state which unknown-word choices are remembered#13338
niksedk merged 1 commit into
mainfrom
docs/skip-all-not-persisted

Conversation

@niksedk

@niksedk niksedk commented Aug 7, 2026

Copy link
Copy Markdown
Member

Problem

Neither the OCR page nor the spell-check page said which of the unknown-word choices are remembered and which are not. Both list "Change all" and "Skip all" side by side with no hint that one is written to disk and the other disappears when the window closes.

That gap is what made #13284 ("Skip all choices are now remembered") look like a bug fix rather than a behaviour change: #10166 reads as a defect precisely because the documented behaviour never existed to contradict it.

Change

Documentation only — no code.

docs/features/ocr.md — a "What is remembered" table under Unknown Words:

Choice Remembered? Stored in
Change all Yes {language}_OCRFixReplaceList.xml
Add to names list Yes {language}_names.xml
Add to user dictionary Yes {language}_user.xml
Skip once No
Skip all No — current OCR session only

…plus a short paragraph on why "Skip all" is deliberately temporary (a mis-click should not have lasting consequences) and which choice to use instead when you do want something permanent.

docs/features/spell-check.md — the same distinction inline in the existing option list, with a shorter note.

Verified

  • Change allOcrFixEngine.ChangeAllOcrFixReplaceList2.AddWordOrPartialSaveWordToWordList, which writes <lang>_OCRFixReplaceList.xml. Persisted.
  • Skip allOcrFixEngine.SkipAll adds to the in-memory _wordSkipList only; it is created per engine instance and cleared by Unload(). Nothing reads or writes disk. Session-only.
  • F1 targets land on these pages: the OCR window calls ShowHelp("features/ocr") (OcrViewModel.cs:4521) and the spell-check window calls ShowHelp("features/spell-check") (SpellCheckViewModel.cs:931).
  • Swept all 70 ShowHelp(...) targets in src/ui against docs/<target>.md — every one resolves, none missing.

Related

  • Closes the documentation half of OCR Keeps Re-Flagging Correct Characters — Skips/Resolves Not Remembered #10166. The remaining half is that 5.x lost the Tools.CheckOneLetterWords setting that 4.0.14 had (OcrFixEngine: correct = !Configuration.Settings.Tools.CheckOneLetterWords, defaulted to true in ToolsSettings.cs:541). It does not exist anywhere in src today, and there is no single-character branch in src/libuilogic/Ocr/FixEngine/OcrFixEngine.cs — so the supported way to stop single-letter prompts is gone. That is the likelier root fix for the reporter and is worth its own issue.
  • Fix #10166: OCR skip-all choices are now remembered #13284 was closed in favour of keeping "Skip all" session-only.

"Skip all" lasts only for the current session; Change all, Add to names list and
Add to user dictionary are written to disk. Neither the OCR nor the spell-check
page said so, which is what made persisting the skip list look like a bug fix
rather than a behaviour change (#10166, PR #13284).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@niksedk
niksedk merged commit ebcbb73 into main Aug 7, 2026
1 check passed
@niksedk
niksedk deleted the docs/skip-all-not-persisted branch August 7, 2026 13:33
@niksedk niksedk mentioned this pull request Aug 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant