Startsida Utforska Hjälp
Logga in
bernardo
/
Bibliotheca
1
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Träd: 0733a7d400
Grenar Taggar
Bibliotheca
/
docs
Bernardo Magri 961a70d4b7 adding feature request 2 månader sedan
..
README.md 8e553142f6 adding documentation 2 månader sedan
bibliotheca_window.md 8e553142f6 adding documentation 2 månader sedan
bookimport.md 8e553142f6 adding documentation 2 månader sedan
booklist.md 8e553142f6 adding documentation 2 månader sedan
bookshelf.md 8e553142f6 adding documentation 2 månader sedan
booktile.md 8e553142f6 adding documentation 2 månader sedan
database_manager.md 8e553142f6 adding documentation 2 månader sedan
feature_requests.md 961a70d4b7 adding feature request 2 månader sedan
main.md 8e553142f6 adding documentation 2 månader sedan
sha256.md 8e553142f6 adding documentation 2 månader sedan

README.md

Bibliotheca Architecture Overview

This document links together the module overviews and describes how a book flows through the system.

High-level flow

  1. Import (BookImport, Sha256)
    • Compute SHA-256 id for each selected file.
    • Extract metadata and cover (EPUB via libzip/tinyxml2, PDF via poppler).
  2. Persistence (DatabaseManager)
    • Ensure the SQLite schema exists.
    • Insert/update/remove records using prepared statements.
  3. Model (BookList)
    • Load books from the database into memory.
    • Expose CRUD helpers with signal emission.
    • Provide thread-safe enqueue helpers for background imports.
  4. Presentation (BookShelf, BookTile)
    • Mirror the model into a Gio::ListStore.
    • Render a grid of tiles, expose activation, and filter results.
  5. Application shell (BibliothecaWindow)
    • Build the UI chrome (header, search bar, stack pages).
    • React to imports, search queries, and user activation.

Module documentation

External dependencies

  • GTK 4 / gtkmm: UI toolkit for widgets, signals, and layout.
  • SQLite3: persistence layer for book metadata.
  • poppler-glib: PDF metadata/covers.
  • libzip + tinyxml2: EPUB metadata extraction.
  • OpenSSL (libcrypto): SHA-256 hashing.

Future work

  • Add ADRs (docs/decisions/) for larger architectural choices.
  • Document additional subsystems as they appear (e.g., reader view, tagging).
  • Add screenshots or diagrams for quick onboarding.