hdoc-tools 0.9.11 → 0.9.13

package/README.md

@@ -18,6 +18,10 @@ Outputs available arguments and switches.
 
 Initializes a new HDocBook project from a template, using runtime input variables.
 
+### createDocs
+
+Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
+
 ### stats
 
 Returns statistics regarding the book you are working on:

package/hdoc-build.js

@@ -565,94 +565,6 @@
         sorted: true
     };
 
-    const build_breadcrumbs = function (nav_items) {
-        console.log('Processing navigation breadcrumbs...\n');
-        // Steve - need to rework this to use recursion, as it's hard-coded for a maximum of 4 levels deep right now
-        for (let a = 0; a < nav_items.length; a++) {
-            const nav_a = nav_items[a];
-            const parent_a = nav_a.text;
-            if (nav_a.link) {
-                bc[nav_a.link] = [{
-                    text: nav_a.text,
-                    link: nav_a.link
-                }];
-            }
-            if (nav_a.items) {
-                for (let b = 0; b < nav_a.items.length; b++) {
-                    const nav_b = nav_a.items[b];
-                    const parent_b = nav_b.text;
-                    if (nav_b.link) {
-                        if (bc[nav_a.link]) {
-                            bc[nav_b.link] = bc[nav_a.link];
-                        } else {
-                            bc[nav_b.link] = [{
-                                text: parent_a,
-                                link: nav_a.items[0].link
-                            }];
-                        }
-                        bc[nav_b.link].push({
-                            text: nav_b.text,
-                            link: nav_b.link
-                        });
-                    }
-
-                    if (nav_b.items) {
-                        for (let c = 0; c < nav_b.items.length; c++) {
-                            const nav_c = nav_b.items[c];
-                            const parent_c = nav_c.text;
-                            if (nav_c.link) {
-                                if (bc[nav_b.link]) {
-                                    bc[nav_c.link] = bc[nav_b.link];
-                                } else {
-                                    bc[nav_c.link] = [{
-                                        text: parent_a,
-                                        link: nav_a.items[0].link
-                                    }];
-                                    bc[nav_c.link].push({
-                                        text: parent_b,
-                                        link: nav_b.items[0].link
-                                    });
-                                }
-                                bc[nav_c.link].push({
-                                    text: nav_c.text,
-                                    link: nav_c.link
-                                });
-                            }
-
-                            if (nav_c.items) {
-                                for (let d = 0; d < nav_c.items.length; d++) {
-                                    const nav_d = nav_c.items[d];
-                                    if (nav_d.link) {
-                                        if (bc[nav_c.link]) {
-                                            bc[nav_d.link] = bc[nav_c.link];
-                                        } else {
-                                            bc[nav_d.link] = [{
-                                                text: parent_a,
-                                                link: nav_a.items[0].link
-                                            }];
-                                            bc[nav_d.link].push({
-                                                text: parent_b,
-                                                link: nav_b.items[0].link
-                                            });
-                                            bc[nav_d.link].push({
-                                                text: parent_c,
-                                                link: nav_c.items[0].link
-                                            });
-                                        }
-                                        bc[nav_d.link].push({
-                                            text: nav_d.text,
-                                            link: nav_d.link
-                                        });
-                                    }
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    };
-
     exports.run = async function (source_path, verbose_output, github_api_token, validate) {
         if (github_api_token !== '') {
             git_token = github_api_token;
@@ -759,8 +671,8 @@
                 process.exit(1);
             }
         }
-
-        build_breadcrumbs(hdocbook_config.navigation.items);
+        console.log('Processing navigation breadcrumbs...\n');
+        bc = hdoc.build_breadcrumbs(hdocbook_config.navigation.items);
 
         console.log('Processing content...');
         // Get a list of MD files in work_path

package/hdoc-create.js

@@ -0,0 +1,91 @@
+(function () {
+    'use strict';
+
+    const fs = require('fs-extra'),
+          path = require('path'),
+          hdoc = require(path.join(__dirname, 'hdoc-module.js'));
+    
+    let doc_id,
+        processed_links = {},
+        file_count = 0,
+        folder_count = 0;
+
+    exports.run = async function (source_path) {
+
+        console.log('Hornbill HDocBook Create', '\n');
+        console.log('Path:', source_path, '\n');
+
+        // Load the hdocbook-project.json file to get the docId
+        // use the docId to get the book config
+        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
+        let hdocbook_project = {};
+        try {
+            hdocbook_project = require(hdocbook_project_config_path);
+        } catch (e) {
+            console.log(`File not found: ${hdocbook_project_config_path}\n`);
+            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        doc_id = hdocbook_project.docId;
+
+        const book_path = path.join(source_path, doc_id),
+            hdocbook_path = path.join(book_path, 'hdocbook.json');
+        
+        let hdocbook = {};
+        try {
+            hdocbook = require(hdocbook_path);
+        } catch (e) {
+            console.log(`File not found: ${hdocbook_path}\n`);
+            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+
+        // Get paths from breadcrumb builder
+        let nav_paths = hdoc.build_breadcrumbs(hdocbook.navigation.items);
+        for (const key in nav_paths) {
+            if (nav_paths.hasOwnProperty(key)) {
+                for (let i = 0; i < nav_paths[key].length; i++) {
+                    if (!processed_links[nav_paths[key][i].link]) {
+                        nav_paths[key][i].path = path.join(source_path, nav_paths[key][i].link);
+                        await add_doc(nav_paths[key][i]);
+                    }
+                }
+            }
+        }
+        console.log('\n-----------------------');
+        console.log(' Docs Creation Summary');
+        console.log('-----------------------\n');
+        console.log(`  Files Created: ${file_count}`);
+        console.log(`Folders Created: ${folder_count}\n`);
+    };
+
+    const add_doc = async function(doc_info) {
+
+        // Does folder exist? Create if not
+        const folder = path.dirname(doc_info.path);
+        if (!fs.existsSync(folder)) {
+            try {
+                fs.mkdirSync(folder, true);
+                console.log('Folder created:', folder);
+                folder_count++;
+            } catch {
+                console.log('\nError creating folder', folder, ':', e);
+                return;
+            }
+        }
+
+        // Does file exist? Create if not
+        if (!fs.existsSync(doc_info.path + '.md') && !fs.existsSync(doc_info.path + '.htm') && !fs.existsSync(doc_info.path + '.html')) {
+            try {
+                const file_path = doc_info.path + '.md';
+                fs.writeFileSync(file_path, `# ${doc_info.text}\n`);
+                console.log('  File created:', file_path);
+                processed_links[doc_info.link] = true;
+                file_count++;
+            } catch (e) {
+                console.log('\nError creating file', doc_info.path, ':', e);
+            }
+        }
+    }
+
+})();

package/hdoc-help.js

@@ -14,6 +14,9 @@ Commands
  - build
     Performs a local build of the book, and outputs as a ZIP file
 
+ - createDocs
+    Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
+
  - help
     Outputs available arguments and switches
 

package/hdoc-module.js

@@ -290,4 +290,94 @@
         return response;
     };
 
+    
+    exports.build_breadcrumbs = function (nav_items) {
+        let bc = {};
+        // Steve - need to rework this to use recursion, as it's hard-coded for a maximum of 4 levels deep right now
+        for (let a = 0; a < nav_items.length; a++) {
+            const nav_a = nav_items[a];
+            const parent_a = nav_a.text;
+            if (nav_a.link) {
+                bc[nav_a.link] = [{
+                    text: nav_a.text,
+                    link: nav_a.link
+                }];
+            }
+            if (nav_a.items) {
+                for (let b = 0; b < nav_a.items.length; b++) {
+                    const nav_b = nav_a.items[b];
+                    const parent_b = nav_b.text;
+                    if (nav_b.link) {
+                        if (bc[nav_a.link]) {
+                            bc[nav_b.link] = bc[nav_a.link];
+                        } else {
+                            bc[nav_b.link] = [{
+                                text: parent_a,
+                                link: nav_a.items[0].link
+                            }];
+                        }
+                        bc[nav_b.link].push({
+                            text: nav_b.text,
+                            link: nav_b.link
+                        });
+                    }
+
+                    if (nav_b.items) {
+                        for (let c = 0; c < nav_b.items.length; c++) {
+                            const nav_c = nav_b.items[c];
+                            const parent_c = nav_c.text;
+                            if (nav_c.link) {
+                                if (bc[nav_b.link]) {
+                                    bc[nav_c.link] = bc[nav_b.link];
+                                } else {
+                                    bc[nav_c.link] = [{
+                                        text: parent_a,
+                                        link: nav_a.items[0].link
+                                    }];
+                                    bc[nav_c.link].push({
+                                        text: parent_b,
+                                        link: nav_b.items[0].link
+                                    });
+                                }
+                                bc[nav_c.link].push({
+                                    text: nav_c.text,
+                                    link: nav_c.link
+                                });
+                            }
+
+                            if (nav_c.items) {
+                                for (let d = 0; d < nav_c.items.length; d++) {
+                                    const nav_d = nav_c.items[d];
+                                    if (nav_d.link) {
+                                        if (bc[nav_c.link]) {
+                                            bc[nav_d.link] = bc[nav_c.link];
+                                        } else {
+                                            bc[nav_d.link] = [{
+                                                text: parent_a,
+                                                link: nav_a.items[0].link
+                                            }];
+                                            bc[nav_d.link].push({
+                                                text: parent_b,
+                                                link: nav_b.items[0].link
+                                            });
+                                            bc[nav_d.link].push({
+                                                text: parent_c,
+                                                link: nav_c.items[0].link
+                                            });
+                                        }
+                                        bc[nav_d.link].push({
+                                            text: nav_d.text,
+                                            link: nav_d.link
+                                        });
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        return bc;
+    };
+
 })();

package/hdoc-validate.js

@@ -190,6 +190,23 @@
         }
     };
 
+    const checkTags = async function (htmlFile) {
+        const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
+        const $ = cheerio.load(htmlBody);
+        
+        const h1_tags = $('h1').map(function () {
+            return $(this);
+        }).get();
+        if (h1_tags.length && h1_tags.length > 1) {
+            let error_msg = `${h1_tags.length} <h1> tags found in content: `;
+            for (let i = 0; i < h1_tags.length; i++) {
+                error_msg  += h1_tags[i].text();
+                if (i <  h1_tags.length - 1) error_msg += '; ';
+            }
+            errors[htmlFile.relativePath].push(error_msg);
+        }
+    };
+
     const dreeOptions = {
         descendants: true,
         depth: 10,
@@ -376,6 +393,9 @@
                 await checkImages(source_path, html_to_validate[i], links.img);
             }
 
+            // Check for multiple H1 tags
+            await checkTags(html_to_validate[i]);
+
             // Build list content for Google 
             listContent += `/${html_to_validate[i].relativePath.replace(path.extname(html_to_validate[i].relativePath), '')}`;
             if (i < html_to_validate.length - 1) {

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 (async function () {
    'use strict';
 
@@ -69,6 +69,9 @@
    } else if (command == 'build') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
       await builder.run(source_path, verbose, git_token, false);
+   } else if (command == 'createDocs') {
+      const creator = require(path.join(__dirname, 'hdoc-create.js'));
+      await creator.run(source_path);
    } else if (command == 'validate') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
       await builder.run(source_path, verbose, git_token, true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.9.11",
+  "version": "0.9.13",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -12,6 +12,7 @@
     "hdoc-build.js",
     "hdoc-build-db.js",
     "hdoc-build-pdf.js",
+    "hdoc-create.js",
     "hdoc-help.js",
     "hdoc-init.js",
     "hdoc-module.js",

package/ui/js/doc.hornbill.js

@@ -110,9 +110,9 @@ function listenForHrefClicks()
                 ev.preventDefault();                
 
                 //-- do we need to scroll into view element on this page
-                if(checkUrl.hash && $(checkUrl.hash +".faq-toc-item")[0])
+                if(checkUrl.hash && getAnchorFromHash(checkUrl.hash,"faq-toc-item"))
                 {
-                    $(checkUrl.hash +".faq-toc-item")[0].scrollIntoView();    
+                    getAnchorFromHash(checkUrl.hash,"faq-toc-item").scrollIntoView();
                     if(ele.href!==document.location.href) window.history.pushState(null, null, ele.href); //-- user has clicked a link so we want to add state to history so we can click back                
                 }
                 else
@@ -166,6 +166,31 @@ function highlightNavigationLinkFromUrl(matchLinkHref)
     });
 }
 
+function getAnchorFromHash(strHash,strHasClass)
+{
+    try{
+        let strSelector = toSeoUrl(strHash.replace("#",""));
+        if(strHasClass)strSelector += "." + strHasClass;
+
+        let jqEle = $("#"+strSelector);
+        if(jqEle[0])
+        {
+            return jqEle;
+        }
+        else
+        {
+            return null;
+        }
+    }
+    catch(e)
+    {
+        console.log("Get document anchor element by hash failed ["+strHash+"]",e);
+        return null;
+    }
+
+}
+
+
 //-- create items to stick in toc from current loaded content
 //-- searches for H2,H3
 function generateTableOfContentsFromDoc()
@@ -361,7 +386,8 @@ function loadContentUrl(linkRef,fromPageRefresh,fromPopState)
                 //-- scroll to element that match hash (if have one)
                 if(document.location.hash)
                 {
-                    $(document.location.hash)[0].scrollIntoView();
+                    let gotoEle = getAnchorFromHash(document.location.hash) ;
+                    if(gotoEle)gotoEle[0].scrollIntoView();
                 }
             });
             view.$forceUpdate();

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Hornbill Docs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.