Skip to content

FUNCTIONALITY.md

Latest commit

 

History

History
73 lines (56 loc) · 2.5 KB

FUNCTIONALITY.md

File metadata and controls

73 lines (56 loc) · 2.5 KB

TejOCR Functionality Guide

This document explains what the user sees and what actually happens inside the extension.

What actions are available

  • Settings
  • OCR Selected Image
  • OCR Image from File
  • Toolbar action (same handler family, resolved by command URL)

Expected UI behavior

Settings
  -> dependency status + path controls
  -> save defaults

OCR Selected Image
  -> selection check (must be Writer image/shape)
  -> OCR options (or fallback input)
  -> output

OCR Image from File
  -> file picker
  -> OCR options (or fallback input)
  -> output

%%{init: {"theme":"base","themeVariables":{"primaryColor":"#1f6feb","primaryTextColor":"#ffffff","primaryBorderColor":"#1347a0","lineColor":"#7c3aed","secondaryColor":"#22c55e","tertiaryColor":"#f59e0b","mainBkg":"#dbeafe","background":"#ffffff","textColor":"#0f172a"}}}%% flowchart TD A["Settings"] --> B["Dependencies + defaults"] C["OCR Selected Image"] --> D["Selection check"] D --> E["OCR"] F["OCR Image from File"] --> G["File picker"] G --> E E --> H["Output inserted"]


## Output behavior by output mode

| Mode | Selected image input | File input |
|---|---|---|
| `at_cursor` | Insert near selected image anchor (or cursor fallback) | Insert at active cursor |
| `clipboard` | Copy recognized text | Copy recognized text |
| `new_text_box` | Add a text frame in document | Add a text frame at cursor |
| `replace_image` | Replace selected image with text | Converted to safe insertion path |

%%{init: {"theme":"base","themeVariables":{"primaryColor":"#1f6feb","primaryTextColor":"#ffffff","primaryBorderColor":"#1347a0","lineColor":"#7c3aed","secondaryColor":"#22c55e","tertiaryColor":"#f59e0b","mainBkg":"#dbeafe","background":"#ffffff","textColor":"#0f172a"}}}%%
flowchart LR
  A["output_mode"] -->|at_cursor| B["cursor insert"]
  A -->|new_text_box| C["text frame"]
  A -->|clipboard| D["system clipboard"]
  A -->|replace_image| E["selected target only"]
  E --> F["in-place replace"]

What the fallback mode means

In some LibreOffice runtime profiles:

  • com.sun.star.awt.UnoControlDialogModel may be unavailable
  • visual XDL dialogs cannot be created
  • OCR still proceeds with saved settings and defaults

Fallback indicators:

  • settings or option editor message appears as plain text
  • preview box might be skipped and result inserted directly

Practical recommendation

If cursor insertion is unstable in your workflow, use new_text_box mode. It is the most stable for preserving insertion context across selection changes.