hdoc-tools 0.7.15 → 0.7.17

package/README.md

@@ -1,9 +1,51 @@
-# HDocBook documentation
-This is an example of a simple static content documentation project that is compatible with the Hornbill Docs system
+# hdoc-tools
 
-Make sure that you have installed hdoc-tools   
+Hornbill HDocBook Development Support Tool.
 
-  npm install hdoc-tools -g
+## Usage
+
+<code>hdoc argument switches</code>
+
+## Arguments
+
+The arguments available to this command-line tool are as follows.
+
+### help
+
+Outputs available arguments and switches.
+
+### init
+
+Initializes a new HDocBook project from a template, using runtime input variables.
+
+### stats
+
+Returns statistics regarding the book you are working on:
+
+- Document ID
+- Version
+- Title
+- Description
+- Public Source
+- Total Book Word Count
+- Number of Markdown Files in the Book
+- Number of Static HTML Files in the Book
+
+If the -v switch is provided, then a more verbose output is output, which includes a list of each MD and HTML file found, the file sizes, and file-specific word count.
+
+### build
+
+Performs a local build of the book, validates the links and static content are present and correct, and outputs as a ZIP file.
+
+If the -v switch is provided, then a more verbose output is provided, which includes a list of all HTML files created and checked for embedded links and static content.
+
+### serve
+
+Starts a local web server on port 3000, serving the book content.
 
 To preview the documentation in a browser, you can open a terminal window and run the dev preview server with the 
 command `hdoc serve` and in a local browser go to the url `http://localhost:3000`
+
+## Installation
+
+  npm install hdoc-tools -g

package/hdoc-build.js

@@ -14,8 +14,6 @@
         md_files = [];
 
     function expand_variables(text) {
-        // For debug mode our base path is our root??
-        text = text.replaceAll('{{BASE_PATH}}', '/' + docId);
         text = text.replaceAll('{{BUILD_NUMBER}}', '0');
 
         let build_date = new Date().toISOString();
@@ -70,7 +68,7 @@
         // * Create a _work folder 
         // * copy the hdocbook content to the work folder
         // * Render all markdown into side-by-side HTML file
-        // * Replace SERVER_VARS embedded in documents with the right base path, version information etc.
+        // * Replace SERVER_VARS embedded in documents with the right version information etc.
         // * Build an index (sqlite FTS5) by extracting text from all HTML content in  the work 
         //   folder, conceptually we are making a little mini website crawler to index all of the content
         //   within the book. 

package/hdoc-serve.js

@@ -53,7 +53,7 @@
       var hdocbook_config = require(hdocbook_path);
       var hdocbook_mtime = fs.statSync(hdocbook_path).mtime;
 
-      app.get('/content/library.json', function (req, res) {
+      app.get('/_books/library.json', function (req, res) {
          let library = {
             books: [{
                docId: hdocbook_config.docId,
@@ -112,7 +112,6 @@
 
       function expand_variables(text) {
          // For debug mode our base path is our root??
-         text = text.replaceAll('{{BASE_PATH}}', '/' + docId);
          text = text.replaceAll('{{DOC_ID}}', docId);
          text = text.replaceAll('{{BUILD_NUMBER}}', '0');
 
@@ -213,13 +212,13 @@
       //
       // Anything else in this handler will return a 404 error
 
-      app.get('/content/*', function (req, res) {
+      app.get('/_books/*', function (req, res) {
 
          let url = req.url;
 
          let segs = url.split('/');
 
-         if (segs.length == 4 && segs[1] == 'content' && segs[3] == 'book.json') {
+         if (segs.length == 4 && segs[1] == '_books' && segs[3] == 'book.json') {
             // Special case of a virtual file here, we need to check  the book ID and
             // if its our book, send the json
             if (hdocbook_config.docId == segs[2]) {
@@ -231,7 +230,7 @@
                res.status(404).send('Specified bookId ' + segs[2] + ' not found');
             }
             return;
-         } else if (segs.length == 3 && segs[1] == 'content' && segs[2] == 'index.json') {
+         } else if (segs.length == 3 && segs[1] == '_books' && segs[2] == 'index.json') {
             // For development mode, we always have an index with one book in it, the one being developed
             if (hdocbook_config) {
                let index = {
@@ -252,7 +251,7 @@
             return;
          }
 
-         url = url.replace('/content/', '/');
+         url = url.replace('/_books/', '/');
 
          console.log('URL Requested:', url);
 
@@ -331,23 +330,6 @@
       app.get('/*', function (req, res) {
 
          let segs = req.url.split('/');
-         if (segs.length > 2 && segs[1] === docId) {
-            // In this case we are looking for static content within the book
-            // Create the file path
-            let url = req.url.replace('/content/', '/');
-            console.log('URL Requested:', url);
-            let file_path = path.join(source_path, url);
-
-            // If the file exists, send it.
-            if (fs.existsSync(file_path) == true) {
-               send_file(req, res, file_path);
-               return;
-            }
-
-            // All else fails, we have not file to return, so return a 404 error here
-            send_content_resource_404(req, res);
-            return;
-         }
 
          let ui_file_path = path.join(ui_path, req.url);
 
@@ -375,7 +357,7 @@
          console.log('Server listening at http://127.0.0.1:%s', port);
          console.log('Document source path is: ' + source_path);
 
-         let _vars = ['{{DOC_ID}}', '{{BASE_PATH}}', '{{BUILD_NUMBER}}', '{{BUILD_DATE}}'];
+         let _vars = ['{{DOC_ID}}', '{{BUILD_NUMBER}}', '{{BUILD_DATE}}'];
          console.log("Server Vars:");
          for(let x = 0; x < _vars.length; x++) {
             let name = _vars[x];

package/hdoc-validate.js

@@ -63,6 +63,8 @@ const parseLinkDestination = require('markdown-it/lib/helpers/parse_link_destina
         // Remove explicit anchor links
         let file_path = path.join(source_path, relative_path.split('#')[0]);
 
+        // Replace /_books/ with /
+        file_path = file_path.replace(path.sep + '_books' + path.sep, path.sep);
         if (!fs.existsSync(file_path) && !fs.existsSync(file_path + '.htm') && !fs.existsSync(file_path + '.html')) {
             errors[html_path.relativePath].push(`Book resource does not exist: ${file_path}`);
             return false;
@@ -118,7 +120,7 @@ const parseLinkDestination = require('markdown-it/lib/helpers/parse_link_destina
             // Write list
             const listFile = path.join(source_path, doc_id, 'list.txt');
             fs.writeFileSync(listFile, listContent);
-            console.log(`${listFile} created successfully`);
+            console.log(`\r\nLink list text file created successfully: ${listFile}`);
         } catch (err) {
             console.error(err);
         }

package/package.json

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

package/ui/js/doc.hornbill.js

@@ -233,7 +233,7 @@ function loadContentUrl(linkRef,fromPageRefresh,fromPopState)
 
     //-- for now just load whatever the href prop is (we can add actions to perform specific processing and then load content based on element atts etc)
     let frontmatterData = {};
-    fetch("content/"+linkRef).then(response =>
+    fetch("_books/"+linkRef).then(response =>
     { 
         if(response.headers.has("X-frontmatter"))
         {
@@ -474,7 +474,7 @@ async function intialiseApp() {
     jqContentContainer = $(".injected-document-content");
     jqLeftNav = $("#DocSidebarNav");
 
-    await fetchJsonFile("content/library.json").then(function(data){
+    await fetchJsonFile("_books/library.json").then(function(data){
 
         // Get docbook library list
         view.docApp.library = data;
@@ -482,7 +482,7 @@ async function intialiseApp() {
 
     }).then(function(){
         // Get hdocbook.json
-        fetchJsonFile("content/" + view.docId + "/hdocbook.json").then(function(data)
+        fetchJsonFile("_books/" + view.docId + "/hdocbook.json").then(function(data)
         {
             view.docApp.book = data;
             view.bookId = data.docId;