Added json and markdown book detail export

Author: paviro

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "koshelf"
-version = "1.0.16"
+version = "1.0.17"
 description = "Transform your KOReader library into a beautiful reading dashboard with statistics."
 repository = "https://github.com/paviro/KOShelf"
 license = "EUPL-1.2 license"

README.md

@@ -191,10 +191,15 @@ site/
 ├── calendar/
 │   └── index.html          # Reading calendar view
 ├── books/                  # Individual book pages
+│   ├── list.json           # Manifest of all books (convenience only; not used by frontend)
 │   ├── book-id1/           
-│   │   └── index.html      # Book detail page with annotations
+│   │   ├── index.html      # Book detail page with annotations
+│   │   ├── details.md      # Markdown export (human-readable)
+│   │   └── details.json    # JSON export (machine-readable)
 │   └── book-id2/
-│       └── index.html
+│       ├── index.html
+│       ├── details.md
+│       └── details.json
 └── assets/
     ├── covers/             # Optimized book covers
     │   ├── book-id1.webp
@@ -209,7 +214,7 @@ site/
     │   ├── calendar.js     # Calendar functionality
     │   ├── heatmap.js      # Activity heatmap visualization
     │   └── event-calendar.min.js # Event calendar library
-    └── json/               # Data files (when available)
+    └── json/               # Data files used by the frontend (when available)
         ├── calendar/           # Calendar data split by month
         │   ├── available_months.json # List of months with calendar data
         │   ├── 2024-01.json   # January 2024 events and book data

assets/book_detail.js

@@ -7,4 +7,18 @@ document.addEventListener('DOMContentLoaded', function() {
     // Initialize section toggles using the module
     const sectionToggle = new SectionToggle();
 
+    // Share dropdown toggle logic
+    const shareDropdownButton = document.getElementById('shareDropdownButton');
+    const shareDropdownMenu = document.getElementById('shareDropdownMenu');
+
+    shareDropdownButton?.addEventListener('click', () => {
+        shareDropdownMenu?.classList.toggle('hidden');
+    });
+
+    // Close dropdown when clicking outside
+    document.addEventListener('click', (e) => {
+        if (!shareDropdownButton?.contains(e.target) && !shareDropdownMenu?.contains(e.target)) {
+            shareDropdownMenu?.classList.add('hidden');
+        }
+    });
 }); 

src/lua_parser.rs

@@ -75,10 +75,7 @@ impl LuaParser {
     fn parse_annotation(&self, table: Table) -> Result<Annotation> {
         Ok(Annotation {
             chapter: self.get_optional_string(&table, "chapter")?,
-            color: self.get_optional_string(&table, "color")?,
             datetime: self.get_optional_string(&table, "datetime")?,
-            drawer: self.get_optional_string(&table, "drawer")?,
-            page: self.get_optional_string(&table, "page")?,
             pageno: self.get_optional_u32(&table, "pageno")?,
             pos0: self.get_optional_string(&table, "pos0")?,
             pos1: self.get_optional_string(&table, "pos1")?,

src/models.rs

@@ -238,12 +238,11 @@ pub struct KoReaderMetadata {
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct Annotation {
     pub chapter: Option<String>,
-    pub color: Option<String>,
     pub datetime: Option<String>,
-    pub drawer: Option<String>,
-    pub page: Option<String>,
     pub pageno: Option<u32>,
+    #[serde(skip_serializing)]
     pub pos0: Option<String>,
+    #[serde(skip_serializing)]
     pub pos1: Option<String>,
     pub text: String,
     pub note: Option<String>,
@@ -321,23 +320,25 @@ impl std::fmt::Display for BookStatus {
 /// Data structure representing a book entry from the statistics database
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct StatBook {
+    #[serde(skip_serializing)]
     pub id: i64,
+    #[serde(skip_serializing)]
     pub title: String,
+    #[serde(skip_serializing)]
     pub authors: String,
     pub notes: Option<i64>,
     pub last_open: Option<i64>,
     pub highlights: Option<i64>,
     pub pages: Option<i64>,
-    pub series: String,
-    pub language: String,
     #[serde(skip_serializing)]
     pub md5: String,
     pub total_read_time: Option<i64>,
+    #[serde(skip_serializing)]
     pub total_read_pages: Option<i64>,
 }
 
 /// Additional statistics calculated for a book from its reading sessions
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Serialize)]
 pub struct BookSessionStats {
     pub session_count: i64,
     pub average_session_duration: Option<i64>, // in seconds

src/site_generator.rs

@@ -285,6 +285,45 @@ impl SiteGenerator {
         completed_books.sort_by(|a, b| a.epub_info.title.cmp(&b.epub_info.title));
         unread_books.sort_by(|a, b| a.epub_info.title.cmp(&b.epub_info.title));
 
+        // ------------------------------------------------------------------
+        // Generate books manifest JSON categorized by reading status.
+        // NOTE: This manifest is not consumed by the frontend code – it is
+        // generated purely for the convenience of users who may want a
+        // machine-readable list of all books and their export paths.
+        // ------------------------------------------------------------------
+
+        use serde_json::json;
+
+        let to_manifest_entry = |b: &Book| {
+            json!({
+                "id": b.id.clone(),
+                "title": b.epub_info.title.clone(),
+                "authors": b.epub_info.authors.clone(),
+                "json_path": format!("/books/{}/details.json", b.id),
+                "html_path":  format!("/books/{}/index.html",  b.id),
+            })
+        };
+
+        let reading_json: Vec<_> = reading_books.iter().map(to_manifest_entry).collect();
+        let completed_json: Vec<_> = completed_books.iter().map(to_manifest_entry).collect();
+        let new_json: Vec<_> = unread_books.iter().map(to_manifest_entry).collect();
+
+        let manifest = json!({
+            "reading": reading_json,
+            "completed": completed_json,
+            "new": new_json,
+            "generated_at": self.get_last_updated(),
+        });
+
+        fs::write(
+            self.books_dir().join("list.json"),
+            serde_json::to_string_pretty(&manifest)?,
+        )?;
+
+        // ------------------------------------------------------------------
+        // Render book list HTML
+        // ------------------------------------------------------------------
+
         let template = IndexTemplate {
             site_title: self.site_title.clone(),
             reading_books,
@@ -294,7 +333,7 @@ impl SiteGenerator {
             last_updated: self.get_last_updated(),
             navbar_items: self.create_navbar_items("books"),
         };
-        
+
         let html = template.render()?;
         fs::write(self.output_dir.join("index.html"), html)?;
 
@@ -327,8 +366,8 @@ impl SiteGenerator {
             let template = BookTemplate {
                 site_title: self.site_title.clone(),
                 book: book.clone(),
-                book_stats,
-                session_stats,
+                book_stats: book_stats.clone(),
+                session_stats: session_stats.clone(),
                 version: self.get_version(),
                 last_updated: self.get_last_updated(),
                 navbar_items: self.create_navbar_items("books"),
@@ -339,6 +378,54 @@ impl SiteGenerator {
             fs::create_dir_all(&book_dir)?;
             let book_path = book_dir.join("index.html");
             fs::write(book_path, html)?;
+
+            // Generate Markdown export
+            let md_template = BookMarkdownTemplate {
+                book: book.clone(),
+                book_stats: book_stats.clone(),
+                session_stats: session_stats.clone(),
+                version: self.get_version(),
+                last_updated: self.get_last_updated(),
+            };
+            let markdown = md_template.render()?;
+            fs::write(book_dir.join("details.md"), markdown)?;
+
+            // Generate JSON export / not used by the frontend code - only for the user's convenience
+            let json_data = serde_json::json!({
+                "book": {
+                    "title": book.epub_info.title,
+                    "authors": book.epub_info.authors,
+                    "series": book.series_display(),
+                    "language": book.language(),
+                    "publisher": book.publisher(),
+                    "description": book.epub_info.sanitized_description(),
+                    "rating": book.rating(),
+                    "review_note": book.review_note(),
+                    "status": book.status().to_string(),
+                    "progress_percentage": book.progress_percentage(),
+                    "subjects": book.subjects(),
+                    "identifiers": book.identifiers().iter().map(|id| {
+                        serde_json::json!({
+                            "scheme": id.scheme,
+                            "value": id.value,
+                            "display_scheme": id.display_scheme(),
+                            "url": id.url()
+                        })
+                    }).collect::<Vec<_>>()
+                },
+                "annotations": book.koreader_metadata.as_ref().map(|m| &m.annotations).unwrap_or(&vec![]),
+                "statistics": {
+                    "book_stats": book_stats,
+                    "session_stats": session_stats
+                },
+                "export_info": {
+                    "generated_by": "KoShelf",
+                    "version": self.get_version(),
+                    "generated_at": self.get_last_updated()
+                }
+            });
+            let json_str = serde_json::to_string_pretty(&json_data)?;
+            fs::write(book_dir.join("details.json"), json_str)?;
         }
 
         Ok(())

src/statistics_parser.rs

@@ -58,7 +58,7 @@ impl StatisticsParser {
 
     /// Parse book entries from the database
     fn parse_books(conn: &Connection) -> Result<Vec<StatBook>> {
-        let mut stmt = conn.prepare("SELECT id, title, authors, notes, last_open, highlights, pages, series, language, md5, total_read_time, total_read_pages FROM book")?;
+        let mut stmt = conn.prepare("SELECT id, title, authors, notes, last_open, highlights, pages, md5, total_read_time, total_read_pages FROM book")?;
 
         let book_iter = stmt.query_map([], |row| {
             Ok(StatBook {
@@ -69,11 +69,9 @@ impl StatisticsParser {
                 last_open: row.get(4)?,
                 highlights: row.get(5)?,
                 pages: row.get(6)?,
-                series: row.get(7)?,
-                language: row.get(8)?,
-                md5: row.get(9)?,
-                total_read_time: row.get(10)?,
-                total_read_pages: row.get(11)?,
+                md5: row.get(7)?,
+                total_read_time: row.get(8)?,
+                total_read_pages: row.get(9)?,
             })
         })?;
 

src/templates.rs

@@ -33,6 +33,16 @@ pub struct BookTemplate {
     pub navbar_items: Vec<NavItem>,
 }
 
+#[derive(Template)]
+#[template(path = "book_details/book_details.md", escape = "none")]
+pub struct BookMarkdownTemplate {
+    pub book: Book,
+    pub book_stats: Option<StatBook>,
+    pub session_stats: Option<BookSessionStats>,
+    pub version: String,
+    pub last_updated: String,
+}
+
 #[derive(Template)]
 #[template(path = "statistics/statistics.html")]
 pub struct StatsTemplate {

templates/book_details/book_details.html

@@ -11,7 +11,7 @@
     {% include "sidebar.html" %}
 
     <!-- Header - Fixed at top -->
-    <header class="fixed top-0 left-0 right-0 md:left-64 bg-white/90 dark:bg-dark-850/75 backdrop-blur-sm border-b border-gray-200/50 dark:border-dark-700/50 px-4 md:px-6 h-[70px] md:h-[80px] z-40">
+    <header class="fixed top-0 left-0 right-0 md:left-64 bg-white/90 dark:bg-dark-850/75 backdrop-blur-sm border-b border-gray-200/50 dark:border-dark-700/50 px-4 md:px-6 h-[70px] md:h-[80px] z-40 flex items-center justify-between">
         <div class="flex items-center h-full min-w-0 flex-1">
             <!-- Mobile Title & Back Button -->
             <div class="md:hidden flex items-center space-x-3 min-w-0 flex-1">
@@ -37,6 +37,25 @@ <h1 class="text-2xl font-bold text-gray-900 dark:text-white truncate">{{ book.ep
                 {% endif %}
             </div>
         </div>
+
+        <!-- Action Buttons -->
+        <div class="flex items-center space-x-2">
+            <!-- Share Dropdown -->
+            <div class="relative" id="shareDropdownWrapper">
+                <button id="shareDropdownButton" class="p-2 bg-gray-100/50 dark:bg-dark-800/50 border border-gray-300/50 dark:border-dark-700/50 rounded-lg hover:bg-gray-200/50 dark:hover:bg-dark-700/50 transition-colors" type="button" aria-label="Share">
+                    <!-- Download Icon (Heroicons) -->
+                    <svg class="w-5 h-5 text-primary-400" fill="none" stroke="currentColor" viewBox="0 0 24 24">
+                      <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 16v2a2 2 0 002 2h12a2 2 0 002-2v-2"/>
+                      <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7 10l5 5 5-5"/>
+                      <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 4v12"/>
+                    </svg>
+                </button>
+                <div id="shareDropdownMenu" class="hidden absolute right-0 mt-2 w-40 bg-white dark:bg-dark-800/90 border border-gray-200/50 dark:border-dark-700/50 rounded-lg shadow-xl z-20 overflow-hidden">
+                    <a href="/books/{{ book.id }}/details.md" download class="block px-4 py-2 hover:bg-gray-100/50 dark:hover:bg-dark-700/50 text-sm transition-colors duration-200">Markdown</a>
+                    <a href="/books/{{ book.id }}/details.json" download class="block px-4 py-2 hover:bg-gray-100/50 dark:hover:bg-dark-700/50 text-sm transition-colors duration-200">JSON</a>
+                </div>
+            </div>
+        </div>
     </header>
 
     <div class="min-h-full md:ml-64">