hdoc-tools 0.18.6 → 0.19.1

package/hdoc-build.js

@@ -447,12 +447,12 @@
       }
       if (pdf_size > 0) pdf_created++;
 
-      if (inline_content) html_txt = `${fm_header_content}\n${html_txt}`;
-      else html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
-
       // Wrap h2 and h3 tags, plus content, in id'd divs
       html_txt = hdoc.wrapHContent(html_txt);
 
+      if (inline_content) html_txt = `${fm_header_content}\n${html_txt}`;
+      else html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
+
       let relative_path = file_path.relativePath;
       if (
         !bc[relative_path.replace(".html", "")] &&
@@ -808,11 +808,12 @@
       }
       if (pdf_size > 0) pdf_created++;
 
+      // Wrap h2 and h3 tags, plus content, in id'd divs
+      html_txt = hdoc.wrapHContent(html_txt);
+
       if (inline_content) html_txt = `${fm_header}\n${html_txt}`;
       else html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
 
-      // Wrap h2 and h3 tags, plus content, in id'd divs
-      html_txt = hdoc.wrapHContent(html_txt);
 
       // Save HTML into HTML file
       const target_file = file_path.path.replace(

package/package.json

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

package/ui/css/theme-default/styles/components/api-doc.css

@@ -0,0 +1,106 @@
+/* GERRY: adding styling for semantic markup elements for documenting JavaScript (and other) API's */
+api-param-name {
+    display: inline;
+    border-radius: 4px;
+    padding: 3px 6px;
+    color: var(--htl-c-text-code);
+    background-color: var(--htl-c-bg-mute);
+    margin-right: 0.5em;
+    font-size: 1.3em;
+    font-family: "courier new";
+    font-weight: 700;
+  }
+  
+  api-param-name-optional {
+    display: inline;
+    border-radius: 4px;
+    padding: 3px 6px;
+    color: var(--htl-c-text-code);
+    background-color: var(--htl-c-bg-mute);
+    margin-right: 0.5em;
+    font-size: 1.3em;
+    font-style: italic;
+    font-family: "courier new";
+    font-weight: 700;
+  }
+  api-param-type {
+    display: inline;
+    border-radius: 4px;
+    padding: 3px 6px;
+    margin-right: 0.5em;
+    color: var(--htl-custom-block-tip-text);
+    background-color: var(--htl-custom-block-tip-bg);
+    border: 1px solid var(--htl-custom-block-tip-border);
+    font-style: italic;
+    font-weight: 600;
+  }
+  api-param-type:before {
+    font-style: normal;
+    font-weight: 400;
+    content: "data type: "
+  }
+  
+  api-param-optional {
+    display: inline;
+    border-radius: 4px;
+    padding: 3px 6px;
+    margin-right: 0.5em;
+    color: var(--htl-custom-block-tip-text);
+    background-color: var(--htl-custom-block-tip-bg);
+    border: 1px solid var(--htl-custom-block-tip-border);
+    font-style: italic;
+    font-weight: 600;
+  }
+  api-param-optional:before {
+    content: "Optional [default=";
+    font-style: normal;
+    font-weight: 400;
+  }
+  api-param-optional:after {
+    font-style: normal;
+    content: "]";
+    font-weight: 400;
+  }
+  
+  /* API parameter description block */
+  api-param-desc {
+    display: block;
+    padding-top: 1em; 
+    padding-bottom: 2em;
+    padding-left: 2em;
+  }
+
+  /* GS: We need this for now as the custom element above does 
+     not work when you have line breaks in description */
+  .api-param-desc {
+    display: block;
+    padding-top: 1em; 
+    padding-bottom: 2em;
+    padding-left: 2em;
+  }
+
+  api-prop-name {
+    display: inline;
+    border-radius: 4px;
+    padding: 3px 6px;
+    color: var(--htl-c-text-code);
+    background-color: var(--htl-c-bg-mute);
+    margin-right: 0.5em;
+    font-size: 1.0em;
+    font-family: "courier new";
+    font-weight: 700;
+  }
+  
+  api-prop-name-optional {
+    display: inline;
+    border-radius: 4px;
+    padding: 3px 6px;
+    color: var(--htl-c-text-code);
+    background-color: var(--htl-c-bg-mute);
+    margin-right: 0.5em;
+    font-size: 1.0em;
+    font-style: italic;
+    font-family: "courier new";
+    font-weight: 700;
+  }
+

package/ui/css/theme-default/styles/components/htl-doc.css

@@ -20,7 +20,7 @@
 }
 
 .HTL-doc h2 {
-  margin: 48px 0 16px;
+  margin: 16px 0 16px;
   padding-top: 24px;
   letter-spacing: -0.02em;
   line-height: 32px;
@@ -845,9 +845,31 @@
 .HTL-doc .hljs {
   background: #494949;
   width: 100%;
+  font-size: 0.9em !important;
+  line-height: 1.4em;
 }
 
 .dark .HTL-doc .hljs {
   background: #000000;
   width: 100%;
+  font-size: 0.9em !important;
+
+}
+
+/* image sizing for icon library */
+.HTL-doc .hb-icon-td {
+  text-align: center;
+}
+
+.HTL-doc .hb-icon-img {
+  min-width: 80px;
+  max-width: 80px;
+}
+
+/* imge sizing for ITOM and iBridge content packs */
+.HTL-doc .hb-floated-image img {
+  float: left;
+  width: 110px;
+  margin-top: -5px;
+  padding-right: 5px;
 }

package/ui/css/theme-default/styles/vars.css

@@ -318,7 +318,6 @@
   --htl-custom-block-info-bg: #d7eaf8;
   --htl-custom-block-info-code-bg: var(--htl-c-gray-light-4);
 
-
   --htl-custom-block-tip-border: var(--htl-c-green-dimm-1);
   --htl-custom-block-tip-text: var(--htl-c-green-darker);
   --htl-custom-block-tip-bg: var(--htl-c-green-dimm-3);

package/ui/index.html

@@ -36,6 +36,7 @@
             }
         </style>
         <script>
+
             var ThemePreference = localStorage.getItem('hdocbook-theme-appearance') || '';
             const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches
             if (!ThemePreference || ThemePreference === 'auto' ? prefersDark : ThemePreference === 'dark') {
@@ -381,6 +382,7 @@
         "css/theme-default/styles/components/sidebar.css",
         "css/theme-default/styles/components/content.css",
         "css/theme-default/styles/components/custom-block.css",
+        "css/theme-default/styles/components/api-doc.css",
 
         "js/highlightjs/styles/vs2015.css"
     ], function () {