336 lines
14 KiB
Markdown
336 lines
14 KiB
Markdown
# 🔍 Guide Recherche, PDF, Excel & Excalidraw
|
||
|
||
ObsiGate va au-delà de la simple lecture : recherche puissante, rendu des
|
||
documents riches (PDF, diagrammes) et indexation de leur contenu pour que tout
|
||
soit retrouvable.
|
||
|
||
> **Public :** tous les utilisateurs
|
||
> **Fiches techniques :** [`features/semantic-search.md`](../features/semantic-search.md) ·
|
||
> [`features/pdf.md`](../features/pdf.md) · [`features/excalidraw.md`](../features/excalidraw.md)
|
||
|
||
---
|
||
|
||
## 1. Recherche plein texte (TF-IDF)
|
||
|
||
Le moteur d'ObsiGate s'appuie sur un **index inversé** et un scoring **TF-IDF**
|
||
avec :
|
||
|
||
- **Boost titre** — une correspondance dans le titre pèse 3× plus.
|
||
- **Normalisation des accents** — `resume` trouve `résumé`, `elephant` trouve `éléphant`.
|
||
- **Stemming français** — les variantes des mots sont rapprochées.
|
||
- **Snippets surlignés** — les termes trouvés sont mis en `<mark>` dans l'extrait.
|
||
- **Facettes** — compteurs par vault et par tag sur les résultats.
|
||
- **Pagination** — 50 résultats par page.
|
||
- **Tri** — par pertinence (TF-IDF) ou par date de modification.
|
||
- **Chips de filtres** — les filtres actifs apparaissent sous forme de puces retirables.
|
||
- **Historique** — les 50 dernières recherches sont conservées en `localStorage`.
|
||
|
||
La recherche s'effectue **sans I/O disque** : le contenu est déjà en mémoire.
|
||
|
||
---
|
||
|
||
## 2. Syntaxe de requête
|
||
|
||
| Opérateur | Description | Exemple |
|
||
|---|---|---|
|
||
| `tag:<nom>` | Filtre par tag | `tag:recette docker` |
|
||
| `#<nom>` | Raccourci de tag | `#linux serveur` |
|
||
| `vault:<nom>` | Filtre par vault | `vault:IT kubernetes` |
|
||
| `title:<texte>` | Filtre par titre | `title:pizza` |
|
||
| `path:<texte>` | Filtre par chemin | `path:recettes/soupes` |
|
||
| `ext:<type>` | Filtre par type de fichier | `ext:md kubernetes` |
|
||
| `"phrase exacte"` | Recherche d'une phrase | `tag:"multi mots"` |
|
||
|
||
Les opérateurs sont **combinables** :
|
||
|
||
```text
|
||
tag:linux vault:IT ext:md serveur web
|
||
```
|
||
|
||
Cette requête cherche « serveur web » dans les fichiers Markdown de la vault
|
||
`IT` portant le tag `linux`.
|
||
|
||
### Filtres par extension
|
||
|
||
| Extension | Contenu |
|
||
|---|---|
|
||
| `ext:md` | Notes Markdown |
|
||
| `ext:py`, `ext:sh`, `ext:js` | Scripts et code |
|
||
| `ext:pdf` | Documents PDF (texte extrait) |
|
||
| `ext:excalidraw` | Diagrammes Excalidraw (texte extrait) |
|
||
|
||
---
|
||
|
||
## 3. Autocomplétion et suggestions
|
||
|
||
- **`/api/suggest`** — suggère des titres de fichiers.
|
||
- **`/api/tags/suggest`** — suggère des tags.
|
||
- Navigation clavier : `↑` / `↓` puis `Entrée` ; `Échap` ferme les suggestions.
|
||
|
||
### Raccourcis de recherche
|
||
|
||
| Raccourci | Action |
|
||
|---|---|
|
||
| `Ctrl + K` / `Cmd + K` | Focaliser la barre de recherche |
|
||
| `/` | Focaliser la recherche (hors champ texte) |
|
||
| `↑` / `↓` | Naviguer dans les suggestions |
|
||
| `Entrée` | Sélectionner la suggestion active ou lancer la recherche |
|
||
| `Échap` | Fermer les suggestions / quitter la recherche |
|
||
|
||
Recherches sauvegardées et signets sont disponibles via l'API
|
||
(`/api/saved-searches`, `/api/bookmarks`).
|
||
|
||
---
|
||
|
||
## 4. Recherche sémantique (optionnelle)
|
||
|
||
Au classement TF-IDF peut s'ajouter un classement **par embeddings**, fusionné
|
||
via la méthode **RRF** (Reciprocal Rank Fusion). Activation : touche `~`
|
||
(ou `Alt + S`) dans la recherche.
|
||
|
||
Deux modes :
|
||
|
||
1. **Sans dépendance** — un *embedder* par hachage fournit une base utilisable
|
||
immédiatement.
|
||
2. **Embeddings réels** — installez `backend/requirements-semantic.txt` et/ou
|
||
renseignez les variables `OBSIGATE_EMBEDDING_*` pour utiliser
|
||
`all-MiniLM-L6-v2`.
|
||
|
||
Détails et configuration :
|
||
[`features/semantic-search.md`](../features/semantic-search.md).
|
||
|
||
---
|
||
|
||
## 5. Support PDF
|
||
|
||
### Lecture
|
||
|
||
Les fichiers PDF de vos vaults s'affichent **en ligne** dans le navigateur via le
|
||
visualiseur PDF natif (iframe + `<embed>`). Le fichier est **streamé** en HTTP
|
||
Range (`206 Partial Content`) : les gros PDF se chargent progressivement.
|
||
|
||
### Recherche
|
||
|
||
Le texte est **extrait à l'indexation** (`pypdf` / `pymupdf`), donc le contenu
|
||
des PDF est recherchable via la recherche plein texte. Utilisez `ext:pdf` pour
|
||
limiter les résultats aux PDF.
|
||
|
||
### Métadonnées
|
||
|
||
`GET /api/file/{vault}/pdf/info` renvoie les métadonnées (pages, titre, auteur)
|
||
**sans transférer** le document.
|
||
|
||
```bash
|
||
curl "http://localhost:2020/api/file/Recettes/pdf/info?path=menu.pdf"
|
||
```
|
||
|
||
### Limites
|
||
|
||
- **Pas d'OCR** : les PDF scannés (images) ne sont pas recherchables.
|
||
- Pas d'annotation ni d'édition du PDF lui-même.
|
||
|
||
---
|
||
|
||
## 6. Tableurs Excel (XLSX)
|
||
|
||
### Affichage et édition
|
||
|
||
Un fichier `.xlsx` s'ouvre dans une visionneuse dédiée : un tableau par
|
||
feuille, des onglets pour naviguer entre elles (toujours visibles, même à
|
||
une seule feuille), les en-têtes A1/B1 et les numéros de ligne. La barre de
|
||
commandes regroupe les actions en sections (Formules · Insertion · Vue ·
|
||
Fichier) autour d'un bouton **Enregistrer** principal. Chaque cellule est
|
||
modifiable directement (clic), `Entrée` valide, `Échap` annule la saisie.
|
||
**Enregistrer** envoie les cellules modifiées à
|
||
`PUT /api/file/{vault}/xlsx/save` : une sauvegarde par feuille, avec
|
||
**backup automatique** du fichier avant écriture, et une écriture
|
||
**atomique** (le classeur n'est jamais laissé à moitié écrit).
|
||
|
||
Le bouton **« + »** à côté des onglets ajoute une nouvelle feuille. Deux
|
||
pastilles d'état rappellent les limites de la vue : **« Lecture seule »**
|
||
pour les formats `.xls`/`.ods`, et **« Formules non recalculées »** — ObsiGate
|
||
affiche la formule telle qu'elle est enregistrée, Excel la recalcule à
|
||
l'ouverture et les cellules dépendantes ne se rafraîchissent pas à l'écran.
|
||
|
||
### Avertissement avant enregistrement
|
||
|
||
Certains classeurs contiennent des éléments qu'ObsiGate ne sait pas
|
||
réécrire : **valeurs calculées** mises en cache par Excel, segments
|
||
(slicers), chronologies, contrôles de formulaire, connexions/requêtes,
|
||
XML personnalisé, signature numérique, commentaires enrichis, macros.
|
||
L'ouverture affiche alors un bandeau qui les liste, et la première
|
||
sauvegarde demande confirmation dans une fenêtre intégrée au thème de
|
||
l'application. Si vous refusez, rien n'est écrit.
|
||
|
||
> Les **graphiques, images et tableaux croisés** sont, eux, bien conservés.
|
||
|
||
Si le classeur est modifié ailleurs entre-temps (verrou concurrent), ObsiGate
|
||
n'interrompt pas votre travail : un bandeau vous propose de **réessayer**
|
||
l'enregistrement, vos modifications restant en place.
|
||
|
||
### Formules
|
||
|
||
Par sécurité, une valeur saisie commençant par `=` ou `@` est **stockée comme
|
||
texte** (une formule injectée s'exécuterait à l'ouverture du fichier dans
|
||
Excel). Le bouton `f(x)` de la barre d'outils active les vraies formules pour
|
||
la session en cours.
|
||
|
||
```bash
|
||
curl -X PUT "http://localhost:2020/api/file/Recettes/xlsx/save?path=budget.xlsx" -H "Content-Type: application/json" -d '{"sheet": "Budget", "cells": {"B1": "250"}, "allow_formula": false, "force": false}'
|
||
```
|
||
|
||
- `allow_formula` : `true` pour écrire une vraie formule (`=B1*2`).
|
||
- `force` : `true` pour enregistrer malgré les éléments non préservés
|
||
(sinon l'API répond **409** `xlsx_lossy_content`).
|
||
- Deux sauvegardes simultanées sur le même fichier : la seconde reçoit
|
||
**409** `conflict` au lieu d'écraser la première.
|
||
|
||
### Feuilles volumineuses et lecture par fenêtres
|
||
|
||
Le rendu est plafonné à **500 lignes × 40 colonnes** par feuille. Quand
|
||
une feuille dépasse ce plafond, un bandeau **« Feuille tronquée »**
|
||
l'annonce explicitement (par exemple « 500 lignes affichées sur 520 »)
|
||
au lieu de présenter une table courte comme complète — le classeur,
|
||
lui, n'est jamais modifié. La ligne d'en-têtes de colonnes reste
|
||
visible pendant le défilement vertical.
|
||
|
||
Côté API, `GET /api/file/{vault}/xlsx/sheet` sert une feuille **par
|
||
fenêtres de lignes**, y compris au-delà du plafond d'affichage — les
|
||
coordonnées A1 renvoyées sont celles de la feuille réelle :
|
||
|
||
```bash
|
||
curl "http://localhost:2020/api/file/Recettes/xlsx/sheet?path=budget.xlsx&sheet=Budget&offset=500&limit=200"
|
||
```
|
||
|
||
- `offset` : première ligne renvoyée (0-based) ; `limit` : nombre de
|
||
lignes (1 à 1 000 par requête).
|
||
- La réponse porte `total_rows`, `truncated` et `has_more` pour paginer.
|
||
- Erreurs : **404** si la feuille n'existe pas, **415** si le fichier
|
||
n'est pas un `.xlsx`.
|
||
|
||
### Fonctions avancées
|
||
|
||
**Barre de formule et navigation clavier** — la cellule active est nommée en
|
||
A1 au-dessus du tableau ; `Tab`/`Maj+Tab` et les flèches circulent entre les
|
||
cellules, `Entrée` valide, `Maj+Entrée` insère un retour à la ligne, une
|
||
plage se copie telle quelle vers un tableur.
|
||
|
||
**Annuler / rétablir** — `Ctrl+Z` (ou le bouton **Annuler** du ruban) revient
|
||
sur les dernières éditions de cellules, `Ctrl+Maj+Z` / `Ctrl+Y` les rétablit.
|
||
|
||
**Sélection et menu contextuel** — cliquer une cellule l'active, **glisser**
|
||
ou `Maj+clic` sélectionne une plage (affichée dans la zone Nom, ex. `A1:B3`),
|
||
et cliquer un **en-tête** sélectionne toute la ligne ou colonne. Un **clic
|
||
droit** (ou un **appui long** sur mobile) ouvre un menu : insérer/supprimer
|
||
une ligne ou une colonne, trier A→Z / Z→A, effacer le contenu.
|
||
|
||
**Tri, filtre, recherche, export** — le tri (ascendant / descendant) s'applique
|
||
depuis le menu contextuel et n'affecte que l'affichage ; les lignes se filtrent,
|
||
la recherche (`Ctrl+F` du panneau) va de correspondance en correspondance, et
|
||
la feuille s'exporte en CSV. Rien de tout cela ne modifie le classeur.
|
||
|
||
**Structure** — le menu **Structure** de la barre d'outils ajoute,
|
||
renomme, duplique ou supprime une feuille, et insère/supprime des lignes ou
|
||
colonnes autour de la cellule active (`PUT …/xlsx/structure`, backup
|
||
automatique et confirmation, comme pour l'édition des cellules).
|
||
|
||
**Styles et mise en page** — la lecture restitue couleurs de police et de
|
||
fond, gras/italique/souligné, alignements, cellules fusionnées et volets
|
||
figés ; l'ancrage de la zone figée est conservé au défilement.
|
||
|
||
**Formats de fichiers** — `.xlsm` s'édite comme un `.xlsx` et ses
|
||
**macros sont préservées** à l'enregistrement ; `.xls` et `.ods` s'affichent
|
||
en **lecture seule** ; un `.csv` s'ouvre dans la même grille et se réécrit
|
||
conformément à la RFC 4180 (les guillemets et séparateurs sont
|
||
échappés).
|
||
|
||
**Tableau de bord** — le bouton **Tableau de bord** ouvre un **inspecteur
|
||
latéral droit** (la grille reste visible à côté) qui liste les plages
|
||
nommées du classeur (nom, référence, portée), signale les feuilles
|
||
contenant des graphiques ou des tableaux croisés, et donne pour chaque
|
||
feuille un résumé (cellules, lignes, colonnes, formules, valeurs
|
||
numériques) avec quelques chiffres clés. Cliquer une **plage nommée**
|
||
sélectionne sa première cellule dans la grille, et le panneau est
|
||
**redimensionnable**. L'en-tête de l'inspecteur offre
|
||
aussi un accès direct à l'**assistant IA**, qui peut ensuite exploiter ces
|
||
plages (outils `list_xlsx_sheets`, `xlsx_to_markdown`, `update_xlsx_cells`,
|
||
`append_xlsx_rows`).
|
||
|
||
### Limites
|
||
|
||
- L'affichage intégré démarre à **500 lignes × 40 colonnes** par feuille ;
|
||
sous une feuille plus grande, le bouton **« Charger la suite »** (ou le
|
||
défilement vers le bas du tableau) ajoute les lignes suivantes par
|
||
fenêtres de 500 — elles deviennent aussitôt éditables et
|
||
sauvegardables.
|
||
- Un **format de nombre personnalisé** (devise, pourcentage…) est signalé
|
||
par une police à chasse fixe, mais la valeur reste affichée brute.
|
||
- L'application de **styles** depuis la visionneuse (mettre en gras,
|
||
colorer) n'est pas proposée — seuls les styles existants sont rendus.
|
||
- `.xls` et `.ods` restent en lecture seule (convertir vers `.xlsx` pour
|
||
éditer) ; les macros d'un `.xlsm` sont conservées mais ne s'exécutent
|
||
pas dans ObsiGate.
|
||
|
||
---
|
||
|
||
## 7. Diagrammes Excalidraw
|
||
|
||
Les fichiers `.excalidraw` et `.excalidraw.md` (dont le format compressé du
|
||
**plugin Obsidian Excalidraw**) s'ouvrent dans un **éditeur visuel Excalidraw
|
||
complet**, dans une iframe sandboxée.
|
||
|
||
- **Dessin et édition** sans quitter ObsiGate.
|
||
- **Sauvegarde automatique** (débounce 2 s) ou `Ctrl + S`.
|
||
- **Thème** clair/sombre suivi automatiquement.
|
||
- **Texte indexé** : le texte des éléments du diagramme est extrait à
|
||
l'indexation et donc recherchable (`ext:excalidraw`).
|
||
|
||
Fiche technique : [`features/excalidraw.md`](../features/excalidraw.md).
|
||
|
||
---
|
||
|
||
## 8. Autres contenus riches
|
||
|
||
### Mermaid
|
||
|
||
Les blocs de code ` ```mermaid ` sont rendus en diagrammes interactifs (live
|
||
preview, thèmes, zoom, plein écran, pré-processeur compatible syntaxe Obsidian).
|
||
|
||
### Images Obsidian
|
||
|
||
Toutes les syntaxes d'images sont supportées avec résolution intelligente en
|
||
7 stratégies :
|
||
|
||
1. chemin absolu ;
|
||
2. dossier d'attachements configuré (`VAULT_N_ATTACHMENTS_PATH`) ;
|
||
3. index de démarrage (correspondance unique) ;
|
||
4. même répertoire que la note ;
|
||
5. racine de la vault ;
|
||
6. index de démarrage (correspondance la plus proche) ;
|
||
7. repli : `[image not found: fichier.ext]`.
|
||
|
||
Rescan manuel des attachements :
|
||
|
||
```bash
|
||
curl -X POST "http://localhost:2020/api/attachments/rescan/Recettes"
|
||
```
|
||
|
||
### Graphe et backlinks
|
||
|
||
- **Graphe** : vue force-directed (Barnes-Hut), filtres (tag, type), profondeur,
|
||
mode focus, export PNG, aperçu au survol (`Ctrl + clic`).
|
||
- **Backlinks** : `GET /api/file/{vault}/backlinks?path=…` liste les notes
|
||
pointant vers un document.
|
||
|
||
---
|
||
|
||
## 9. Dépannage
|
||
|
||
| Symptôme | Piste |
|
||
|---|---|
|
||
| Un PDF ne s'affiche pas | Vérifier la taille (`OBSIGATE_PDF_MAX_SIZE_MB`, défaut 50 Mo) |
|
||
| Le texte d'un PDF scanné n'est pas trouvé | Pas d'OCR : normal |
|
||
| Une image reste introuvable | Configurer `VAULT_N_ATTACHMENTS_PATH`, puis rescan |
|
||
| La recherche sémantique ne s'active pas | Vérifier le toggle `~` et `OBSIGATE_EMBEDDING_*` |
|
||
| Résultats obsolètes | Forcer une réindexation : `GET /api/index/reload` |
|