hdoc-tools 0.15.0 → 0.15.2

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/package.json

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

package/templates/pdf/css/hdocs-pdf.css

@@ -386,6 +386,69 @@ video {
   background-color: #224187;
 }
 
+.badge.badge-http-delete:after {
+  content: "DELETE";
+  white-space: nowrap;
+  border: solid 1px #C7004F;
+  background-color: #C7004F;
+}
+
+.badge.badge-http-get:after {
+  content: "GET";
+  white-space: nowrap;
+  border: solid 1px rgb(12, 139, 63);
+  background-color: rgb(12, 139, 63);
+}
+
+.badge.badge-http-head:after {
+  content: "HEAD";
+  white-space: nowrap;
+  border: solid 1px #51C17D;
+  background-color: #51C17D;
+}
+
+.badge.badge-http-options:after {
+  content: "OPTIONS";
+  white-space: nowrap;
+  border: solid 1px rgb(158, 28, 167);
+  background-color: rgb(158, 28, 167);
+}
+
+.badge.badge-http-patch:after {
+  content: "PATCH";
+  white-space: nowrap;
+  border: solid 1px #58178c;
+  background-color: #58178c;
+}
+
+.badge.badge-http-post:after {
+  content: "POST";
+  white-space: nowrap;
+  border: solid 1px #F18229;
+  background-color: #F18229;
+}
+
+.badge.badge-http-put:after {
+  content: "PUT";
+  white-space: nowrap;
+  border: solid 1px #1194DE;
+  background-color: #1194DE;
+}
+
+.badge.badge-rest:after {
+  content: "REST";
+  white-space: nowrap;
+  border: solid 1px #00B0E9;
+  background-color: #00B0E9;
+}
+
+.badge.badge-rpc:after {
+  content: "RPC";
+  white-space: nowrap;
+  border: solid 1px #4A536B;
+  background-color: #4A536B;
+}
+
 code {
   font-size: 0.9em;
 }