hdoc-tools 0.15.1 → 0.15.3

package/hdoc-build.js

@@ -24,7 +24,8 @@
         non_git_pdf_header_template_path = path.join(__dirname, 'templates', 'pdf-header-non-git.html'),
         pdf_template_path = path.join(__dirname, 'templates', 'pdf'),
         pdf_template_file_path = path.join(pdf_template_path, 'template.html'),
-        regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/;
+        regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/,
+        h1_pattern = /(<h1.*?>)\s*.*\s*(.*<\/h1>)/;
 
     let bc = {}, // Breadcrumbs map
         built_file_hashes = [],
@@ -126,7 +127,7 @@
                     }
                 }
 
-                if (!fm_title_found) {
+                if (!fm_title_found && file_path.name !== 'description_ext.md' && file_path.name !== 'article_ext.md') {
                     // No frontmatter title found in properties
                     // Go get title from h tags in html
                     const html_heading = hdoc.getFirstHTMLHeading(html_txt, h_tags_to_search);
@@ -153,7 +154,7 @@
                         id: 'title',
                         value: html_heading[0].children[0].data
                     });
-                } else {
+                } else if (file_path.name !== 'description_ext.md' && file_path.name !== 'article_ext.md') {
                     // No header tag, no frontmatter title, output a warning 
                     console.log(`[WARNING] No frontmatter title property, or ${h_tags_to_search.join(', ')} tags detected in ${file_path.path}`);
                 }
@@ -176,7 +177,11 @@
             let metadata = {};
 
             // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
-            html_txt = html_txt.replace(/(<h1.*?>)\s*.*\s*(.*<\/h1>)/, '');
+            let html_h1 = h1_pattern.exec(html_txt);
+            if (html_h1 && html_h1[0])
+                html_h1 = html_h1[0].replace(/(<h1.*?>)/, '').replace(/(<\/h1>)/, '');
+
+            html_txt = html_txt.replace(h1_pattern, '');
 
             // Get contributor data from Github, if exists
             let contribs = [];
@@ -240,16 +245,16 @@
             if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
                 if (!inline_content)
-                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template, html_h1);
 
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template, html_h1);
             } else {
                 if (!inline_content)
-                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git, html_h1);
 
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git, html_h1);
             }
 
             let pdf_size = 0;
@@ -388,7 +393,7 @@
                         value: html_heading[0].children[0].data.trim()
                     });
                     doc_title = html_heading[0].children[0].data.trim();
-                } else {
+                } else if (file_path.name !== 'description_ext.md' && file_path.name !== 'article_ext.md') {
                     // No header tag, no frontmatter title, output a warning 
                     console.log(`[WARNING] No frontmatter title property, or h1, h2 or h3 header tags detected in ${file_path.path}`);
                 }
@@ -406,7 +411,11 @@
             let metadata = {};
 
             // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
-            html_txt = html_txt.replace(/(<h1.*?>)\s*.*\s*(.*<\/h1>)/, '');
+            let html_h1 = h1_pattern.exec(html_txt);
+            if (html_h1 && html_h1[0])
+                html_h1 = html_h1[0].replace(/(<h1.*?>)/, '').replace(/(<\/h1>)/, '');
+
+            html_txt = html_txt.replace(h1_pattern, '');
 
             // Get contributor data from Github, if exists
             let contribs = [];
@@ -472,17 +481,17 @@
             if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
                 if (!inline_content)
-                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template, html_h1);
 
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template, html_h1);
             } else {
                 // Build doc header from template and frontmatter tags
                 if (!inline_content)
-                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
+                    doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git, html_h1);
 
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
+                    pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git, html_h1);
             }
 
             let pdf_size = 0;
@@ -532,14 +541,19 @@
         return false;
     };
 
-    const process_doc_header = function (fm_headers, doc_path, template) {
+    const process_doc_header = function (fm_headers, doc_path, template, h1) {
         let wip_doc_header = template;
-
+        let used_h1 = false;
+        if (h1 && h1 !== '') {
+            wip_doc_header = wip_doc_header.replaceAll('{{title}}', h1);
+            used_h1 = true;
+        }
         // Process fm_headers properties first
         for (let i = 0; i < fm_headers.length; i++) {
             switch (fm_headers[i].id) {
                 case 'title':
-                    wip_doc_header = wip_doc_header.replaceAll('{{title}}', fm_headers[i].value);
+                    if (!used_h1)
+                        wip_doc_header = wip_doc_header.replaceAll('{{title}}', fm_headers[i].value);
                     break;
                 case 'reading-time':
                     wip_doc_header = wip_doc_header.replaceAll('{{reading-time}}', fm_headers[i].value);

package/hdoc-serve.js

@@ -223,10 +223,11 @@
 
          // Process redirect
          if (hdocbook_project.redirects && hdocbook_project.redirects instanceof Array && hdocbook_project.redirects.length > 0) {
-            const source_url = url.indexOf('/') === 0 ? url.replace('/', '') : url;
+            const source_url = url.indexOf('/') === 0 ? url : `/${url}`;
             hdocbook_project.redirects.forEach(function (redir) {
+               redir.url = redir.url.indexOf('/') === 0 ? redir.url : `/${redir.url}`
                if (redir.url === source_url && redir.location && redir.location !== '') {
-                  url = `/${redir.location}`;
+                  url = `${redir.location}`;
                   console.log(`Redirecting to ${url}`);
                }
             });

package/package.json

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

package/ui/index.html

@@ -203,8 +203,7 @@
 
                 <nav class="hdoc-nav hb-container-expand" id="DocSidebarNav" aria-labelledby="sidebar-aria-label"
                     tabindex="-1">
-                    <div v-for="(navSection,index) in docApp.navSections"
-                        v-bind:class="{'group':navSection.items, 'nogrouplink':!navSection.items}">
+                    <div v-for="(navSection,index) in docApp.navSections" v-bind:class="{'group':navSection.items, 'nogrouplink':!navSection.items}">
 
                         <div v-show="!navSection.items">
                             <a class="DocLink link noitems" v-bind:href="navSection.link"
@@ -219,6 +218,17 @@
                                 v-bind:asection="navSection"></nav-section-component>
                         </div>
                     </div>
+
+                    <div v-if="docApp.hasInlinePopupDocuments" class="nogrouplink">
+                        <div>
+                            <a class="DocLink link noitems" v-on:click="showInlineDocumentList($event)">
+                                <span class="link-text">
+                                    Inline Help Documents
+                                </span>
+                            </a>
+                        </div>
+                    </div>
+
                 </nav>
 
             </aside>
@@ -226,7 +236,8 @@
             <!-- the right hand content col -->
             <div class="DocContent hb-container-expand hb-container-vertical" id="DocContent">
                 <div class="HTL-doc content-wrapper hb-container-expand">
-                    <div class="injected-document-container hb-container-horizontal">
+
+                    <div v-show="!docApp.showInlineDocumentsMarkup" class="injected-document-container hb-container-horizontal">
 
                         <div class="injected-document-content">
                             <div class="document-header">
@@ -286,9 +297,6 @@
                         </div>
 
 
-
-
-
                         <!-- table of contents -->
                         <div v-if="docApp.keepTocLayout" class="injected-document-toc">
                             <div v-if="docApp.tableOfContents.length" class="panel-header">
@@ -307,6 +315,38 @@
 
                     </div>
 
+                    <!-- show inline document links -->
+                    <div v-if="docApp.showInlineDocumentsMarkup" class="hb-container-vertical">
+
+                        <!-- the problem is the test server doesn't serve inline documents like the live/proper one ?? -->
+                        <div class="modal fade" id="inlineModal" tabindex="-1" role="dialog"  aria-hidden="true">
+                            <div class="modal-dialog" role="document">
+                                <div class="modal-content">
+                                    <iframe v-if="docApp.inlinePopupDocumentHref" v-bind:src="docApp.inlinePopupDocumentHref"></iframe>
+                                </div>
+                            </div>
+                        </div>
+                    
+
+                        <div class="p-4">
+
+                            <div class="document-header">
+                                <div class="document-title"><h1>Inline Help Documents (DOES NOT WORK) - NOTE DEV SERVER NEEDS _inline.html PROCESSING - NEED TO SPEAK TO GERRY</h1></div>
+                            </div>
+
+                            <div class="p-2">
+                                <div v-for="(navSectionItem,index) in docApp.inlineDocumentItems">
+
+                                    <a class="DocLink link noitems" href="#" v-on:click="popupInlineDocument($event,navSectionItem)"  style="padding-left: 0px;">
+                                        <span class="link-text"><i v-if="navSectionItem.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This page is set to draft."></i><i class="bi bi-files-alt text-warning"></i> {{navSectionItem.text}}</span>
+                                    </a>
+                
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+
+                   
                 </div>
             </div>
 
@@ -314,6 +354,8 @@
 
     </div> <!-- <div class="main hb-vertical-expand"> -->
 
+
+
 </body>
 <script>
 

package/ui/js/doc.hornbill.js

@@ -12,6 +12,31 @@ var docAppMethods = {
         let self = this;
         self.docApp.userSession = info;
     },
+
+    showInlineDocumentList:function(ev)
+    {
+        if(ev)
+        {
+            ev.stopImmediatePropagation();
+            ev.preventDefault();
+        }
+
+        let self = this;
+        self.docApp.showInlineDocumentsMarkup = true;
+        self.$forceUpdate();
+    },
+    popupInlineDocument:function(ev,navSectionItem)
+    {
+        if(ev)
+        {
+            ev.stopImmediatePropagation();
+            ev.preventDefault();
+        }
+
+        $('#inlineModal').modal("show");
+        let self = this;
+        self.docApp.inlinePopupDocumentHref = navSectionItem.link;
+    },
     switchViewTheme: function () {
         if (ThemePreference) document.documentElement.classList.remove(ThemePreference);
 
@@ -456,33 +481,56 @@ function old_expandNavParentSectionBySelectedLinkHref(findByLinkRef, currentNavS
 
 }
 
-function setBrowserViewUrl(strHrefToLoad, viewData, fromPageRefresh, fromPopState) {
-
-    let urlToSet = window.location.origin + "/" + strHrefToLoad;
-    const url = new URL(urlToSet);
-
-    //-- remove any old params
-    for (let strKey in global.stateParams) {
-        url.searchParams.delete(strKey);
-    }
-
-    //-- now set new data params in url
-    for (let strKey in viewData) {
-        url.searchParams.set(strKey, viewData[strKey]);
+var lastUrlDynamicallySet = "";
+function setBrowserViewUrl(strHrefToLoad,viewData,fromPageRefresh,fromPopState)
+{
+   
+   let urlToSet = window.location.origin + "/" + strHrefToLoad;
+   const url = new URL(urlToSet);
+   
+   //-- remove any old params
+   for(let strKey in global.stateParams)
+   {
+       url.searchParams.delete(strKey);
+   }
+
+   //-- now set new data params in url
+   for(let strKey in viewData)
+   {
+       url.searchParams.set(strKey,viewData[strKey]);
+   }    
+
+   //-- store global params
+   global.stateParams = viewData;
+
+   if(!fromPageRefresh)
+   {
+    if(fromPopState)
+    {
+            //-- so user has clicked on a link - always add entry
+            window.history.pushState(null, null, url); //-- add entry
     }
-
-    //-- store global params
-    global.stateParams = viewData;
-
-    if (!fromPopState) {
-        if (fromPageRefresh) {
-            window.history.replaceState(null, null, url); //-- user has refreshed page or jsut visited page
-        }
-        else {
-            window.history.pushState(null, null, url); //-- user has clicked a link so we want to add state to history so we can click back
+    else
+    {
+            if(lastUrlDynamicallySet)
+            {
+                if(lastUrlDynamicallySet!==strHrefToLoad)
+                {
+                    window.history.pushState(null, null, url); //-- add entry
+                }
+                else
+                {
+                    window.history.replaceState(null, null, url); //-- user has refreshed page or jsut visited page
+                    
+                }
+            }
+            else
+            {
+                window.history.replaceState(null, null, url); //-- user has clicked a link so we want to add state to history so we can click back
+            }
         }
     }
-
+    lastUrlDynamicallySet=strHrefToLoad;
 }
 
 async function fetchContentFile(strFilePath) {
@@ -503,7 +551,7 @@ $(".document-body").attr("v-pre", "");
 
 var view = new Vue({
     el: '#vDocDevApp',
-    data: { userSession: {}, updateCounter: 0, bookId: "", docApp: { keepTocLayout: false, book: {}, navSections: [], tableOfContents: [], bookBreadCrumb: [] } },
+    data: { userSession: {}, updateCounter: 0, bookId: "", docApp: {inlinePopupDocumentHref:"",showInlineDocumentsMarkup:false, keepTocLayout: false, book: {}, navSections: [], inlineDocumentItems:[], tableOfContents: [], bookBreadCrumb: [] } },
     methods: docAppMethods,
     directives: {
         somedirectivename: {
@@ -582,7 +630,6 @@ async function intialiseApp() {
     });
 
     //-- eof session stuff
-
     await fetchJsonFile("_books/library.json").then(function (data) {
 
         // Get docbook library list
@@ -592,14 +639,22 @@ async function intialiseApp() {
     }).then(function () {
         // Get hdocbook.json
         fetchJsonFile("_books/" + view.docId + "/hdocbook.json").then(function (data) {
-            console.log(view.docApp.library.books[0].nav_inline)
+            //console.log(view.docApp.library.books[0].nav_inline)
             view.docApp.book = data;
             view.bookId = data.docId;
             view.docApp.title = data.title || "";
             view.docApp.description = data.description || "";
 
-            if (view.docApp.library.books[0].nav_inline.text)
+
+            view.docApp.inlineDocumentItems = [];
+            view.docApp.inlinePopupDocumentHref = "";
+            view.docApp.showInlineDocumentsMarkup = false;
+            view.docApp.hasInlinePopupDocuments =  (view.docApp.library.books[0].nav_inline && view.docApp.library.books[0].nav_inline.items && view.docApp.library.books[0].nav_inline.items.length)?true:false
+            if(view.docApp.hasInlinePopupDocuments)
+            {
+                view.docApp.inlineDocumentItems = view.docApp.library.books[0].nav_inline.items;
                 view.docApp.book.navigation.items.push(view.docApp.library.books[0].nav_inline);
+            }
 
             //-- now render out the nav menu
             view.renderNavigation();