hdoc-tools 0.8.7 → 0.8.9

package/hdoc-build.js

@@ -1,11 +1,10 @@
-const {
-    stat
-} = require('fs');
-
 (function () {
     'use strict';
 
-    const dree = require('dree'),
+    const {
+        createHash
+    } = require('crypto'),
+        dree = require('dree'),
         fs = require('fs-extra'),
         mdfm = require('markdown-it-front-matter'),
         path = require('path'),
@@ -18,13 +17,14 @@ const {
 
     const h_tags_to_search = ['h1', 'h2', 'h3'],
         index_cols = [
-            'relative_url',
+            'relative_url UNINDEXED',
             'book_id',
-            'book_audience',
+            'book_audience UNINDEXED',
             'book_tags',
             'doc_title',
             'doc_content',
-            'doc_preview'
+            'doc_preview UNINDEXED',
+            'doc_family_id'
         ];
 
     let conversion_attempted = 0,
@@ -37,7 +37,10 @@ const {
         docId = '',
         md_files = [],
         static_html_files = [],
-        index_records = [];
+        index_records = [],
+        work_path_content = '',
+        built_relative_paths = [],
+        built_file_hashes = [];
 
     const transform_static_html = function (file_path) {
         if (fs.existsSync(file_path.path)) {
@@ -98,7 +101,10 @@ const {
                     console.log(`No frontmatter title property, or ${h_tags_to_search.join(', ')} tags detected in ${file_path.path}`);
                 }
             }
-            index_records.push({relative_path: file_path.relativePath, index_html: hdoc_index.transform_html_for_index(html_txt)});
+            index_records.push({
+                relative_path: file_path.relativePath,
+                index_html: hdoc_index.transform_html_for_index(html_txt)
+            });
             if (html_txt_updated) {
                 // Save HTML into HTML file
                 fs.writeFile(file_path.path, html_txt, function writeJSON(err) {
@@ -184,10 +190,13 @@ const {
             fs.writeFile(target_file, html_txt, function writeJSON(err) {
                 if (err) return console.log('Error writing:', target_file, '\r\n', err);
             });
-            
-            const index_details =  hdoc_index.transform_html_for_index(html_txt);
-            
-            index_records.push({relative_path: relative_path, index_html: index_details});
+
+            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 {
@@ -203,8 +212,8 @@ const {
         return false;
     };
 
-    // File callbacks for scans
-    const fileCallback = function (element) {
+    // File callback for build scan
+    const build_file_callback = function (element) {
         if (element.extension === 'md') {
             md_files.push(element);
         } else {
@@ -221,16 +230,28 @@ const {
         }
     };
 
+    // File & folder callback for MD5 hash of built content
+    const hash_callback = function (element) {
+        if (element.extension !== 'db') {
+            built_file_hashes.push({
+                path: element.relativePath,
+                hash: element.hash
+            });
+        }
+    };
+
     const dreeOptions = {
-        descendants: true,
-        depth: 10,
         extensions: ['md', 'html', 'htm'],
-        hash: false,
         normalize: true,
-        size: false,
-        sizeInBytes: false,
-        stat: false,
-        symbolicLinks: false
+    };
+
+    const md5DreeOptions = {
+        hash: true,
+        hashAlgorithm: 'md5',
+        hashEncoding: 'hex',
+        normalize: true,
+        size: true,
+        sorted: true
     };
 
     exports.run = function (source_path, verbose) {
@@ -261,7 +282,7 @@ const {
         console.log(`Building: ${docId} v${hdocbook_config.version}...\r\n`);
 
         const work_path = path.join(source_path, '_work');
-
+        work_path_content = path.join(work_path, docId);
         // Make _work folder to copy everything into
         if (fs.existsSync(work_path)) {
             fs.rmSync(work_path, {
@@ -273,14 +294,14 @@ const {
 
         // Copy files from book into _work-docId folder
         try {
-            fs.copySync(path.join(source_path, docId), path.join(work_path, docId));
+            fs.copySync(path.join(source_path, docId), work_path_content);
         } catch (e) {
             console.error('Error copying from source_path:\r\n', e);
             process.exit(1);
         }
 
         // Get a list of MD files in work_path
-        dree.scan(work_path, dreeOptions, fileCallback);
+        dree.scan(work_path, dreeOptions, build_file_callback);
 
         // Work through MD files and convert to HTML
         md_files.forEach(function (md_file) {
@@ -336,6 +357,7 @@ const {
                     index_records[i].index_html.fm_props.title,
                     index_records[i].index_html.text,
                     index_records[i].index_html.preview,
+                    hdocbook_config.productFamily
                 ];
                 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) {
@@ -350,9 +372,31 @@ const {
             console.log(`\nIndex Build Complete: ${index_success_count} records created.`);
         }
 
+        // Now create MD5 hash of built content
+        dree.scan(work_path_content, md5DreeOptions, hash_callback);
+        let concat_hash = '|';
+        for (let i = 0; i < built_file_hashes.length; i++) {
+            concat_hash += built_file_hashes[i].path + ':' + built_file_hashes[i].hash + '|';
+        }
+        if (concat_hash === '|') {
+            console.log('No hash of content has been returned.');
+            process.exit(1);
+        }
+
+        const hash = createHash("md5").update(concat_hash).digest("hex");
+        const checksum_path = path.join(work_path_content, 'checksum.md5');
+        try {
+            fs.writeFileSync(checksum_path, hash);
+            console.log('\nHash file creation success:', checksum_path);
+        } catch (e) {
+            console.log('\nError creating', checksum_path, ':', e);
+            process.exit(1);
+        }
+
+
         try {
             const zip_path = path.join(work_path, docId + '.zip');
-            zipper.sync.zip(path.join(work_path, docId)).compress().save(zip_path);
+            zipper.sync.zip(work_path_content).compress().save(zip_path);
             console.log(`\nZIP Creation Success: ${zip_path}\n`);
             console.log('Build Complete\n');
         } catch (e) {

package/hdoc-db.js

@@ -33,10 +33,10 @@
         let vals = 'VALUES (';
         for (let i = 0; i < columns.length; i++) {
             if (i === 0) {
-                cols += `${columns[i]}`;
+                cols += `${columns[i].replace('UNINDEXED', '').trim()}`;
                 vals += '?';
             } else {
-                cols += `,${columns[i]}`;
+                cols += `,${columns[i].replace('UNINDEXED', '').trim()}`;
                 vals += ',?';
             }
         }

package/hdoc-init.js

@@ -71,9 +71,6 @@
                 process.exit(1);
             }
 
-            // The file update tasks can now all be done async now 
-            // we have the file and folder structure in place
-
             // Update hdocbook-project.json
             const hdocBookProjectFilePath = path.join(source_path, 'hdocbook-project.json');
             const hdocBookProjectFile = require(hdocBookProjectFilePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.8.7",
+  "version": "0.8.9",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {

package/templates/init/_hdocbook/hdocbook.json

@@ -3,7 +3,14 @@
     "title": "--title--",
     "description": "--description--",
     "publicSource": "--publicSource--",
+    "productFamily": "docs",
     "version": "0.0.1",
+    "audience": [
+        "public"
+    ],
+    "languages": [
+        "en"
+    ],
     "navigation": {
         "items": [
             {
@@ -11,5 +18,6 @@
                 "expand": true
             }
         ]
-    }
+    },
+    "tags": []
 }

package/ui/css/theme-default/styles/components/content.css

@@ -34,6 +34,36 @@
 
 }
 
+/* nav tabs in doc content */
+.DocContent .nav-tabs
+{
+    padding-left: 0!important;
+    list-style: none!important;
+}
+.DocContent .nav-tabs li
+{
+    margin-top: 0px !important
+}
+
+
+.DocContent .nav-tabs.codeblock
+{
+  border-bottom: 1px solid #1E1E1E;
+  margin-bottom: 0px
+}
+.DocContent .nav-tabs.codeblock .nav-link.active
+{
+  background-color: #1E1E1E;
+  color: #fff;
+  border-color: #1E1E1E;
+}
+.DocContent .nav-tabs.codeblock .nav-link:hover
+{
+  border-bottom-color: #1E1E1E;
+}
+/* eof nav tabs in doc content */
+
+
 
 
 @media (min-width: 1000px) {
@@ -68,13 +98,13 @@
 /* LAYOUT MODS */
 
 /* table-list*/
-.DocContent.document-full .injected-document-content
+.DocContent.article-wide .injected-document-content
 {
     /* take up max width - overrides max-width set in [.DocContent .injected-document-content] */
     max-width:100%;
 }
 
-.DocContent.document-full .injected-document-content table
+.DocContent.article-wide .injected-document-content table
 {
     /* make all tables 100% */
     width:100%;

package/ui/js/doc.hornbill.js

@@ -267,6 +267,44 @@ function loadContentUrl(linkRef,fromPageRefresh,fromPopState)
             generateTableOfContentsFromDoc();
         }
 
+        //-- find any <tabs> and andd a bootstrap tab item strip
+        $("#DocContent").find('tabs').each((idx,el) => {
+            let tabClass = el.getAttribute("tabstyle");
+            let tabMarkup = "<ul class='nav nav-tabs'>";
+            //-- for each tab we need to create a tab link
+            $(el).find("tab").each((idx,aTab) => {
+
+                let activeClass=(idx===0)?" active":"";
+                tabMarkup += `<li class='nav-item c-pointer' contentidx='${idx}'><span class='nav-link${activeClass}'>${aTab.getAttribute("name")}</span></li>`;
+
+                //-- hide the tab element if it is not the active one (first)
+                if(idx>0)$(aTab).addClass("d-none");
+
+            });
+
+            tabMarkup += "</ul>";
+            //-- inject markup
+            $(el).prepend(tabMarkup).find(".nav.nav-tabs").addClass(tabClass);
+
+            //-- add event handler for switching tab items
+            $(el).find("li").off("click").on("click",function()
+            {
+                let contentIdx = this.getAttribute('contentidx');
+                let tabsContainer = $(this).closest("tabs").eq(0);
+                let tabs= tabsContainer.find("tab");
+                
+                //-- hide other tab content and show this tabs content
+                tabs.addClass("d-none");
+                tabs.eq(contentIdx-0).removeClass("d-none");
+
+                //-- set clicked tab item to active
+                tabsContainer.find(".nav-link").removeClass("active");
+                $(this).find(".nav-link").addClass("active");
+                
+            });
+        });
+
+
         //-- do any code highlighting
         document.querySelectorAll('pre code').forEach((el) => {
             hljs.highlightBlock(el);