# Manual

[← README](../README.md)

## In the bar

An open book, drawn as a Nerd Font glyph rather than an image: it inherits the
bar's font, its icon size and its foreground colour, so it recolours with every
Omarchy theme switch and stays optically aligned with the widgets beside it.

A two-letter **FR** sits in the icon's bottom-left corner, overlapping the
book, which is what says *which* dictionary this is beside the other reference
plugins that also draw a book. It costs a few pixels of bar width — the room
two letters need to resolve at bar size. `"frBadge": false` gives them back and
leaves a plain book.

| Click | Result |
|---|---|
| Left | Open / close the panel, with the search box focused |
| Middle | Empty the entry cache |

## In the panel

![The panel showing every tab for AMOUR](../preview.png)

The header is the word you are reading, its part of speech, a ☆ to keep it, and
— on the right — **Favoris** and **Récents** with their counts. Under it, the
tabs the portal has for this word; under those, the article. The source line at
the foot opens the same page at the portal.

Clicking the book icon or the title returns the panel to the state it opens in:
no query, no entry, both lists showing. It resets *where you are*, not what you
have kept.

### Searching

Type. The 87 268 words shipped with the plugin are filtered as you go, so the
list answers on the keystroke and **what you type never leaves the machine** —
that is also why search works with the network down. `↑ ↓` moves, `Enter`
opens.

A query the index cannot match shows the words that surround it alphabetically.
With `onlineSearch` on, it is also sent to the portal, which is how words the
TLFi predates — "internet" among them — become findable.

*Parcourir l'index alphabétique* takes the other route: the alphabet cut into
groups of words, the way the printed volumes are, one click to a group and one
more to a word.

### Reading

Twelve tabs, in the portal's order, under its names, and only the ones the word
actually has:

Morphologie · Lexicographie · Étymologie · Synonymie · Antonymie · Voisinages ·
Proverbes · Proxémie · Concordance · Traductions · Famille de mots · Historique

Inside **Lexicographie**, seven dictionaries: TLFi, Wiktionnaire, Académie 9e,
Académie 8e, Littré, Académie 4e, Dictionnaire du Moyen Français.

Everything the tabs show comes out of **one request per word**, so switching
tabs costs nothing and a word already read works offline.

Cross-references in an article are links. Any other word opens on a
double-click. Synonyms, collocations and word-family members are one click
each. `Alt + ←` and `Alt + →` walk back and forward through what you have read.

### Keeping words

`Ctrl + D`, or the ☆ in the header, keeps a word — with its part of speech,
because *chien* the noun and *chien* the adjective are two entries.

**Favoris** and **Récents** at the top right show how many of each you have;
clicking one filters the list to it, clicking again shows both. Up to 200 kept
words and your last 25 lookups, each scrolling inside its own box rather than
growing the panel. Hover any row and click the ✕ to forget one; *tout effacer*,
beside either list's title, empties that list.

## Controls

| Action | Result |
|---|---|
| Click the book | Open the panel, search box focused |
| Click the icon or title, in the panel | Back to the panel as it opens |
| Type | Filter the words as you go |
| `↑ ↓` | Scroll the entry — or move in the result list while searching |
| `Enter` | Open the selected word |
| `Page ↑ ↓`, `Home`, `End` | Scroll a page; jump to top or bottom |
| `Ctrl + ↑ ↓` | Previous / next word in the index |
| `Ctrl + ← →` | Previous / next tab |
| `Ctrl + ⇧ + ← →` | Previous / next dictionary, inside Lexicographie |
| `Ctrl + D`, or the ☆ | Keep this word, or stop keeping it |
| `Alt + ← →` | Back and forward through what you have read |
| `Escape` | Entry → word list → empty box → closed |
| Double-click any word | Open that word's own entry |
| Hover a kept or recent word, click ✕ | Forget that one |
| *tout effacer*, beside either list's title | Empty that list |
| Middle-click the bar icon | Empty the entry cache |
| Click the source line | Open the same page at the portal |

Every one of these lives on the search box, because it keeps the keyboard the
whole time the panel is open — it has to, or typing a word would not work. So
the bindings stay off what a one-line field actually uses: `←` and `→` still
move the caret, and `Home` and `End` are only taken over while an entry is on
screen.

## IPC

The panel answers to IPC, so anything can drive it:

```bash
omarchy-shell jmaeder.frenchdict-cnrtl toggle
omarchy-shell jmaeder.frenchdict-cnrtl lookup prendre
omarchy-shell jmaeder.frenchdict-cnrtl tab morphologie
omarchy-shell jmaeder.frenchdict-cnrtl dictionary littre
omarchy-shell jmaeder.frenchdict-cnrtl browse
omarchy-shell jmaeder.frenchdict-cnrtl about
```

In `~/.config/hypr/bindings.conf`:

```
bindd = SUPER CTRL, D, French dictionary, exec, omarchy-shell jmaeder.frenchdict-cnrtl toggle
```

## Where it starts

The panel opens with the search box focused and both lists showing. Nothing is
fetched until you open a word, and nothing is fetched twice: an entry read once
is served from the cache until the cache fills and the oldest are dropped.

## Removing it

```bash
omarchy plugin disable jmaeder.frenchdict-cnrtl   # keep it installed, take it out of the bar
omarchy plugin remove jmaeder.frenchdict-cnrtl    # remove it entirely
rm -rf ~/.local/state/omarchy/plugins/jmaeder.frenchdict-cnrtl
```

`remove` leaves the state directory behind; the third line is what deletes the
reading history and the cached entries.