docs: update all docs with SQLite, API, content_hash, reader features
This commit is contained in:
1 parent
c1421665c0
commit
e62c50c616
5 files changed
+458
-199
No files matched your search
+63
-13
@@ -25,20 +25,54 @@
|
||||
| FB2 | EPUB, MD, DOCX, PDF, TXT, HTML, LaTeX |
|
||||
| LaTeX | EPUB, MD, DOCX, PDF, TXT, HTML |
|
||||
|
||||
### Reader
|
||||
### Reader — Operazioni base
|
||||
|
||||
1. Vai su **Reader** nella navigazione
|
||||
2. Carica un ebook (EPUB, PDF, MD, TXT, HTML, FB2, DOCX)
|
||||
2. Trascina un ebook (EPUB, PDF, MD, TXT, HTML, FB2, DOCX) o clicca per caricarlo
|
||||
3. Usa la toolbar per:
|
||||
- **☰** — Apri/chiudi indice
|
||||
- **A− / A+** — Zoom font
|
||||
- **☀️ / 🌙 / 🟤** — Cambia tema (chiaro/scuro/seppia)
|
||||
- **🔍** — Cerca nel testo
|
||||
- **⛶** — Schermo intero
|
||||
4. Naviga con frecce tastiera ← → o cliccando ai lati
|
||||
5. La posizione di lettura viene salvata automaticamente
|
||||
|
||||
### API Endpoints
|
||||
| Pulsante | Azione |
|
||||
|---|---|
|
||||
| **☰** | Apri/chiudi indice laterale |
|
||||
| **⇔** | Slider larghezza area di lettura (40–100%) |
|
||||
| **A− / A+** | Zoom font |
|
||||
| **☀️ / 🌙 / 🟤** | Cambia tema (chiaro/scuro/seppia) |
|
||||
| **🔍** | Cerca nel testo |
|
||||
| **🔖** | Aggiungi segnalibro alla posizione corrente |
|
||||
| **⛶** | Schermo intero |
|
||||
| **?** | Aiuto e scorciatoie da tastiera |
|
||||
|
||||
4. Naviga con le frecce **← →** della tastiera
|
||||
5. La **posizione di lettura** viene salvata automaticamente (locale + server)
|
||||
|
||||
### Reader — Segnalibri
|
||||
|
||||
- Premi **🔖** nella toolbar o **Ctrl+B** / **⌘B** per aggiungere un segnalibro
|
||||
- Un toast di conferma appare in basso e il pulsante fa un piccolo "pulse"
|
||||
- Vai nella sidebar **☰ → Segnalibri** per vedere l'elenco
|
||||
- **Clicca** su un segnalibro per tornarci
|
||||
- Premi **✕** per eliminarlo
|
||||
- I segnalibri sono salvati su server SQLite + localStorage (fallback)
|
||||
- Lo stesso libro ha sempre gli stessi segnalibri, anche su PC diverso
|
||||
|
||||
### Reader — Scorciatoie da tastiera
|
||||
|
||||
| Tasti | Azione |
|
||||
|---|---|
|
||||
| **←** / **→** | Pagina precedente/successiva |
|
||||
| **Ctrl+B** / **⌘B** | Aggiungi segnalibro |
|
||||
| **Ctrl+F** / **⌘F** | Cerca nel libro |
|
||||
| **+** / **-** | Zoom avanti/indietro |
|
||||
| **F** | Schermo intero |
|
||||
| **Esc** | Chiudi help modal / Esci da fullscreen |
|
||||
|
||||
### Reader — Slider larghezza
|
||||
|
||||
La barra a destra nella toolbar (con icona ⇔) regola la larghezza dell'area di lettura dal 40% al 100% dello schermo. Utile per file con righe molto lunghe o per preferenze personali di lettura. L'impostazione viene salvata in localStorage.
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Endpoints pubblici
|
||||
|
||||
| Metodo | Path | Descrizione |
|
||||
|---|---|---|
|
||||
@@ -51,16 +85,32 @@
|
||||
| GET | `/reader/serve/<filename>` | Serve il file al reader |
|
||||
| GET | `/reader/formats` | Formati supportati dal reader |
|
||||
|
||||
### API REST (bookmarks e posizioni)
|
||||
|
||||
| Metodo | Path | Descrizione |
|
||||
|---|---|---|
|
||||
| GET | `/api/bookmarks/<content_hash>` | Recupera tutti i segnalibri del libro |
|
||||
| POST | `/api/bookmarks` | Aggiunge un segnalibro |
|
||||
| DELETE | `/api/bookmarks/<id>` | Elimina un segnalibro |
|
||||
| GET | `/api/position/<content_hash>` | Recupera l'ultima posizione di lettura |
|
||||
| PUT | `/api/position/<content_hash>` | Salva la posizione di lettura (body JSON) |
|
||||
|
||||
## Domande frequenti
|
||||
|
||||
**D: Che qualità ha la conversione?**
|
||||
R: Pandoc preserva titoli, grassetto/corsivo, elenchi, tabelle semplici e immagini. Per layout complessi (es. PDF con colonne multiple) la fedeltà dipende dalla complessità del file originale.
|
||||
|
||||
**D: I file vengono conservati?**
|
||||
R: No, vengono cancellati dopo 1 ora. Usa il download subito dopo la conversione.
|
||||
R: I file in `uploads/` e `converted/` vengono cancellati dopo 1 ora. Usa il download subito dopo la conversione. I segnalibri e le posizioni di lettura sono invece permanenti in `bookish.db`.
|
||||
|
||||
**D: I segnalibri restano se ricarico lo stesso libro?**
|
||||
R: Sì. I segnalibri sono legati al contenuto del file (SHA256), non al nome o all'UUID di upload. Stesso file = stessi segnalibri.
|
||||
|
||||
**D: Posso usare i segnalibri da un altro PC?**
|
||||
R: Sì, se sei sulla stessa LAN e raggiungi lo stesso server. I segnalibri sono salvati su SQLite, non nel browser.
|
||||
|
||||
**D: Quanto spazio serve?**
|
||||
R: Minimo. L'app stessa è ~5MB. Pandoc binary incluso ~35MB extra.
|
||||
R: Minimo. L'app stessa è ~5MB. Pandoc binary incluso ~35MB extra. Il database SQLite occupa pochi KB.
|
||||
|
||||
**D: Posso usarlo su mobile?**
|
||||
R: Il convertitore è responsive. Il reader funziona ma non è ottimizzato per schermi piccoli.
|
||||
@@ -75,4 +125,4 @@ R: Imposta `BOOKISH_SECRET` come variabile d'ambiente prima di avviare.
|
||||
- Path traversal prevenuto con `os.path.basename()` e `secure_filename()`
|
||||
- MIME types controllati al download
|
||||
- Limite file a 50MB
|
||||
- Pulizia automatica file temporanei
|
||||
- Pulizia automatica file temporanei dopo 1h
|
||||
Reference in new issue
Block a user