hdoc-tools 0.8.3 → 0.8.5

package/hdoc-build.js

@@ -23,7 +23,8 @@ const {
             'book_audience',
             'book_tags',
             'doc_title',
-            'doc_content'
+            'doc_content',
+            'doc_preview'
         ];
 
     let conversion_attempted = 0,
@@ -183,8 +184,10 @@ const {
             fs.writeFile(target_file, html_txt, function writeJSON(err) {
                 if (err) return console.log('Error writing:', target_file, '\r\n', err);
             });
-
-            index_records.push({relative_path: relative_path, index_html: hdoc_index.transform_html_for_index(html_txt)});
+            
+            const index_details =  hdoc_index.transform_html_for_index(html_txt);
+            
+            index_records.push({relative_path: relative_path, index_html: index_details});
 
             // Delete MD file from _work path
             try {
@@ -306,41 +309,44 @@ const {
         }
 
         // Now build the index
-        console.log('Performing SQlite index creation...\n');
+        console.log('Performing SQlite index creation...');
         let db_name = path.join(work_path, docId, 'index.db');
         const db = new Database(db_name);
-        console.log(`Database created: ${db_name}`);
+        console.log(`\nDatabase created: ${db_name}`);
 
         // Now add the table
         const table_name = 'hdoc_index';
         const table_created = hdoc_index.create_virtual_table(db, table_name, index_cols);
 
         if (table_created !== null) {
-            console.log(`Error creating table: ${table_created}`);
+            console.log(`\nError creating table: ${table_created}`);
         } else {
-            console.log(`Virtual table created: ${table_name}`);
+            console.log(`\nVirtual table created: ${table_name}`);
             if (!hdocbook_config.tags) hdocbook_config.tags = [];
             let index_success_count = 0;
             for (let i = 0; i < index_records.length; i++) {
+                let index_path_name = index_records[i].relative_path.replace('\\', '/').replace(`${hdocbook_config.docId}/`, '');
+                index_path_name = index_path_name.replace(path.extname(index_records[i].relative_path), '');
                 const index_vals = [
-                    index_records[i].relative_path.replace('\\', '/').replace(`${hdocbook_config.docId}/`, ''),
+                    index_path_name,
                     hdocbook_config.docId,
                     hdocbook_config.audience.join(','),
                     hdocbook_config.tags.join(','),
                     index_records[i].index_html.fm_props.title,
-                    index_records[i].index_html.text
+                    index_records[i].index_html.text,
+                    index_records[i].index_html.preview,
                 ];
-                let new_record_id = hdoc_index.insert_record(db, table_name, index_cols, index_vals, hdocbook_config.docId, index_records[i].index_html.fm_props.title);
-                if (!new_record_id) {
-                    console.log(`Index record creation failed - ${hdocbook_config.docId}/${index_records[i].index_html.fm_props.title}: ${e}`);
+                const index_response = hdoc_index.insert_record(db, table_name, index_cols, index_vals, hdocbook_config.docId, index_records[i].index_html.fm_props.title);
+                if (!index_response.success) {
+                    console.log(`Index record creation failed - ${hdocbook_config.docId}/${index_records[i].index_html.fm_props.title}: ${index_response.error}`);
                     continue;
                 }
                 index_success_count++;
                 if (verbose) {
-                    console.log(`Inserted index record ${new_record_id}: ${hdocbook_config.docId} - ${index_records[i].index_html.fm_props.title}`);
+                    console.log(`Inserted index record ${index_response.row_id}: ${hdocbook_config.docId} - ${index_records[i].index_html.fm_props.title}`);
                 }
             }
-            console.log(`\nIndex Build Complete. ${index_success_count} records created.`);
+            console.log(`\nIndex Build Complete: ${index_success_count} records created.`);
         }
 
         try {

package/hdoc-db.js

@@ -1,7 +1,8 @@
 (function () {
     'use strict';
 
-    const html2text = require('html-to-text'),
+    const ellipsize = require('ellipsize'),
+        html2text = require('html-to-text'),
         path = require('path'),
         hdoc = require(path.join(__dirname, 'hdoc-module.js'));
 
@@ -22,6 +23,11 @@
     };
 
     exports.insert_record = function (db, table, columns, values, book_id, doc_title) {
+        let response = {
+            success: false,
+            row_id: 0,
+            error: null
+        };
         let queryProps = [];
         queryProps.push(`INSERT INTO ${table}`);
         let cols = '(';
@@ -43,15 +49,18 @@
         try {
             const stmt = db.prepare(queryProps.join('\n'));
             const info = stmt.run(values);
-            return info.lastInsertRowid;
+            response.row_id = info.lastInsertRowid;
+            response.success = true;
         } catch (e) {
-            return false;
+            response.error = e;
         }
+        return response;
     };
 
     exports.transform_html_for_index = function (html_txt) {
         let response = {
             text: '',
+            preview: '',
             fm_props: {}
         };
 
@@ -61,9 +70,21 @@
 
         // Convert HTML into plain text
         response.text = html2text.convert(html_txt, {
+            ignoreHref: true,
+            ignoreImage: true,
+            uppercaseHeadings: false,
             wordwrap: null
         });
 
+        // Convert HTML into preview text
+        response.preview = html2text.convert(html_txt, {
+            baseElement: 'p',
+            ignoreHref: true,
+            ignoreImage: true,
+            uppercaseHeadings: false,
+            wordwrap: null
+        });
+        response.preview = ellipsize(response.preview, 200).replace(/(?:\r\n|\r|\n)/g, ' ');
         return response;
     };
 

package/hdoc-module.js

@@ -172,13 +172,15 @@
                     // We have a Frontmatter header - return each property in an array
                     const fm_properties = child.data.split(/\r?\n/);
                     for (let i = 0; i < fm_properties.length; i++) {
-                        const property_details = fm_properties[i].split(/:(.*)/s);
-                        if (property_details.length > 1) {
-                            let prop_val = property_details[i].trim();
-                            if (/^".*"$/.test(prop_val)) {
-                                prop_val = prop_val.substring(1, prop_val.length - 1);
+                        if (fm_properties[i].includes(':')) {
+                            const property_details = fm_properties[i].split(/:(.*)/s);
+                            if (property_details.length > 1) {
+                                let prop_val = property_details[1].trim();
+                                if (/^".*"$/.test(prop_val)) {
+                                    prop_val = prop_val.substring(1, prop_val.length - 1);
+                                }
+                                response.fm_properties[property_details[0].trim().toLowerCase()] = prop_val;
                             }
-                            response.fm_properties[property_details[0].trim().toLowerCase()] = prop_val;
                         }
                     }
 

package/hdoc-stats.js

@@ -4,11 +4,11 @@
     
     // Required modules
     // /const { STATUS_CODES } = require('http');
-    const fs = require('fs');
-    const path = require('path');
-    const dree = require('dree');
-    const html2text = require('html-to-text');
-    const wordsCount = require('words-count').default;  
+    const fs = require('fs'),
+    path = require('path'),
+    dree = require('dree'),
+    html2text = require('html-to-text'),
+    wordsCount = require('words-count').default;  
     
     // Regex to remove Hornbill-specific tags 
     const hbMDTagRegex = /(:{3}[ ]note)|(:{3}[ ]tip)|(:{3}[ ]important)|(:{3}[ ]caution)|(:{3}[ ]warning)|(:{3})/g;
@@ -103,6 +103,12 @@
                 console.error('Could not load book configuration:\r\n', e);
                 return;
             }
+            // Load markdown-it module
+            const md = require('markdown-it')({
+                html: true,
+                linkify: true,
+                typographer: true
+            });
 
             // Scan content path directory, send file info to callback for processing
             dree.scan(bookPath, dreeOptions, fileCallback);
@@ -110,7 +116,6 @@
                 // Load markdown file
                 let md_txt = fs.readFileSync(element.path, 'utf8');
 
-                // Render markdown into HTML
                 var html_txt = md.render(md_txt.toString());
                 const text = html2text.convert(html_txt, {
                     wordwrap: null

package/hdoc-validate.js

@@ -105,7 +105,7 @@ const parseLinkDestination = require('markdown-it/lib/helpers/parse_link_destina
             }
 
             // Build list content for Google 
-            listContent += `/${htmlFiles[i].relativePath}`;
+            listContent += `/${htmlFiles[i].relativePath.replace(path.extname(htmlFiles[i].relativePath), '')}`;
             if (i < htmlFiles.length - 1) {
                 listContent += '\r\n';
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -33,6 +33,7 @@
     "cheerio": "^1.0.0-rc.12",
     "cookie-parser": "^1.4.6",
     "dree": "^3.4.2",
+    "ellipsize": "^0.5.1",
     "express": "^4.18.2",
     "fs-extra": "^11.1.0",
     "highlight.js": "^11.6.0",

package/ui/css/theme-default/styles/base.css

@@ -44,7 +44,7 @@ h5,
 h6 {
   margin: 0;
   line-height: normal;
-  /*font-size: var(--htl-default-font-size);*/
+  font-size: revert; /* let browser handle it */
   font-weight: 400;
 }
 
@@ -105,6 +105,9 @@ code,
 kbd,
 samp {
   font-family: var(--htl-font-family-mono);
+  font-size: var(--htl-default-font-size);
+  font-weight: 400;
+  overflow: unset;
 }
 
 img,

package/ui/index.html

@@ -185,14 +185,14 @@
                         <div class="injected-document-content"></div>
 
                         <!-- table of contents -->
-                        <div v-if="docApp.tableOfContents.length" class="injected-document-toc">
-                            <div class="panel-header">
+                        <div  v-if="docApp.keepTocLayout" class="injected-document-toc">
+                            <div v-if="docApp.tableOfContents.length" class="panel-header">
                                 <span class="icon">
                                     <i class="bi bi-list-ul"></i> 
                                 </span>
                                 <span class="title">In This Document</span>
                             </div>
-                            <div class="panel-content">
+                            <div v-if="docApp.tableOfContents.length" class="panel-content">
                                 <div v-for="tocItem in docApp.tableOfContents" :class="tocItem.tagName">
                                     <a :href="tocItem.href">{{tocItem.eleText}}</a>
                                 </div>

package/ui/js/doc.hornbill.js

@@ -257,17 +257,15 @@ function loadContentUrl(linkRef,fromPageRefresh,fromPopState)
         {
             $("#DocContent").addClass(frontmatterData.layout);
             global.lastLayoutClass = frontmatterData.layout;
-
-            //-- if layout supports toc (expects layout to have name "<layoutname>-toc")
-            if(frontmatterData.layout.substr(frontmatterData.layout.length - 4)==="-toc")
-            {
-                //generateTableOfContentsFromDoc();
-            }
-
         }
 
-        //--generate toc for all layouts that have h2/h3
-        generateTableOfContentsFromDoc();
+        //--generate toc for all layouts that have h2/h3 
+        view.docApp.keepTocLayout = (frontmatterData.layout == "article-no-toc");
+        if(!frontmatterData.layout || frontmatterData.layout==="article" || frontmatterData.layout==="article-toc")
+        {
+            view.docApp.keepTocLayout = true;
+            generateTableOfContentsFromDoc();
+        }
 
         //-- do any code highlighting
         document.querySelectorAll('pre code').forEach((el) => {
@@ -439,7 +437,7 @@ async function fetchJsonFile(strFilePath)
 //-- THE INIT APP CALLED FROM index.html
 var view = new Vue({
     el: '#vDocDevApp',
-    data: {updateCounter:0,bookId:"", docApp:{book:{},navSections:[],tableOfContents:[]}},
+    data: {updateCounter:0,bookId:"", docApp:{keepTocLayout:false,book:{},navSections:[],tableOfContents:[]}},
     methods:docAppMethods,
     directives: {
        somedirectivename: {