hdoc-tools 0.8.5 → 0.8.8

package/hdoc-build.js

@@ -18,13 +18,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,
@@ -312,6 +313,7 @@ const {
         console.log('Performing SQlite index creation...');
         let db_name = path.join(work_path, docId, 'index.db');
         const db = new Database(db_name);
+        db.pragma('encoding="UTF-8"');
         console.log(`\nDatabase created: ${db_name}`);
 
         // Now add the table
@@ -335,6 +337,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) {

package/hdoc-db.js

@@ -1,8 +1,7 @@
 (function () {
     'use strict';
 
-    const ellipsize = require('ellipsize'),
-        html2text = require('html-to-text'),
+    const html2text = require('html-to-text'),
         path = require('path'),
         hdoc = require(path.join(__dirname, 'hdoc-module.js'));
 
@@ -34,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 += ',?';
             }
         }
@@ -84,7 +83,7 @@
             uppercaseHeadings: false,
             wordwrap: null
         });
-        response.preview = ellipsize(response.preview, 200).replace(/(?:\r\n|\r|\n)/g, ' ');
+        response.preview = hdoc.truncate_string(response.preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
         return response;
     };
 

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/hdoc-module.js

@@ -191,4 +191,10 @@
         }
         return response;
     };
+
+    exports.truncate_string = function( str, n, useWordBoundary ){
+        if (str.length <= n) { return str; }
+        const subString = str.slice(0, n-1);
+        return (useWordBoundary ? subString.slice(0, subString.lastIndexOf(" ")) : subString) + '…';
+      };
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.8.5",
+  "version": "0.8.8",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -33,7 +33,6 @@
     "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/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);