Skip to content

Commit

Permalink
docs: adjust to new detection settings
Browse files Browse the repository at this point in the history
  • Loading branch information
dynobo committed Feb 9, 2025
1 parent 10dd7fb commit 01307e4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
13 changes: 7 additions & 6 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,17 @@ hide:
- The icons <span class="md-pink">★</span> or <span class="md-pink">☰</span> next to the selection-rectangle indicate the active "capture mode" (see below).
- To abort a capture or quit NormCap press `<esc>`

<!-- TODO: Adjust to new settings -->
## Capture Modes
## Detection settings

The settings menu <span class="md-pink">⚙</span> allows switching between the two capture modes: "parse" and "raw":
The settings menu <span class="md-pink">⚙</span> allows toggling various detection modes:

- **"Raw"-Mode**
- **Raw**

Marked by the <span class="md-pink">☰</span> symbol, it returns text just as detected by the OCR software. For example, all line-breaks are preserved.
If no detection setting is active, the selection rectangle gets marked with the
<span class="md-pink">☰</span> symbol: it returns text just as detected by the OCR
software. For example, all line-breaks are preserved.

- **"Parse"-Mode** <small>(default)</small>
- **Parse Text** <small>(default)</small>

Indicated by the <span class="md-pink">★</span> symbol, it performs some formatting of the output based on certain implemented rules, which can take additional information like text position and content into account. In a first step, every rule calculates a "score" to determine the likelihood of being responsible for this type of text. In a second step, the rule which achieved the highest "score" takes the necessary actions to "transform" the input text according to its type. The following rules are currently implemented:

Expand Down
3 changes: 0 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,6 @@ max_cluster_size = 1
project_name = "NormCap"
bundle = "eu.dynobo"

# TODO: wix was updated. Check compatibility. Run briefcase upgrade wix

[tool.briefcase.app.normcap]
formal_name = "NormCap"
sources = [ "normcap" ]
Expand Down Expand Up @@ -342,7 +340,6 @@ USER brutus
[tool.briefcase.app.normcap.windows]
use_full_install_path = false


[tool.tbump.version]
current = "0.5.9"
regex = '''
Expand Down

0 comments on commit 01307e4

Please sign in to comment.