hdoc-tools 0.41.4 → 0.41.6

package/hdoc-build.js

@@ -98,6 +98,7 @@
 	let includes_success = 0;
 	let includes_failed = 0;
 	let work_path_content = "";
+	let mermaid_images_path = "";
 	let verbose = false;
 
 	const pdf_path_excluded = (relative_path) => {
@@ -532,7 +533,9 @@
 					if (lang === "mermaid" && process.env.GITHUB_ACTIONS !== 'true') {
 						try {
 							const tmpInput = tmp.fileSync({ postfix: ".mmd" });
-							const tmpOutput = tmp.fileSync({ postfix: ".svg" });
+							const outputFileName = `mermaid-${crypto.createHash("sha256").update(str).digest("hex").slice(0, 16)}.svg`;
+							const outputPath = path.join(mermaid_images_path, outputFileName);
+							const outputLink = `/_books/${doc_id}/mermaid-images/${outputFileName}`
 
 							if (!str.startsWith('---')) {
 								str = '---\n' + fs.readFileSync(mermaid_theme_path, {encoding: 'utf-8'}) + `\n---\n${str}`;
@@ -544,20 +547,19 @@
 							if (process.platform === "win32") {
 								cmd = `"${cmd}.cmd"`;
 							} 
-							cmd = `${cmd} -i "${tmpInput.name}" -o "${tmpOutput.name}" --backgroundColor transparent --puppeteerConfigFile ${mermaid_puppeteer_config_path}`;
-							console.log(`Generating Inline Mermaid SVG found in: ${file_path.relativePath}`);
+
+
+							cmd = `${cmd} -i "${tmpInput.name}" -o "${outputPath}" --backgroundColor transparent --puppeteerConfigFile ${mermaid_puppeteer_config_path}`;
+							console.log(`Generating Mermaid SVG found in ${file_path.relativePath} - ${outputPath}`);
 							execSync(cmd);
 							
-							if (!fs.existsSync(tmpOutput.name)) {
+							if (!fs.existsSync(outputPath)) {
 								throw new Error("mmdc did not generate output");
 							}
 
-							const svg = fs.readFileSync(tmpOutput.name, "utf8");
-
 							tmpInput.removeCallback();
-							tmpOutput.removeCallback();
 
-							return `<div class="text-body">${svg}</div>`;
+							return `<img class="mermaid-diagram" src="${outputLink}" alt="Mermaid Diagram">`;
 						} catch (err) {
 							mermaid_failures.push({path: file_path.relativePath, error: err.message});
 							return  ``;
@@ -1327,6 +1329,9 @@
 			process.exit(1);
 		}
 
+		mermaid_images_path = path.join(work_path_content, 'mermaid-images');
+		if (!fs.existsSync(mermaid_images_path)) fs.mkdirSync(mermaid_images_path);
+
 		// Create MD5 hash of content before build
 		console.log("Creating Hash...");
 

package/package.json

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

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

@@ -51,16 +51,27 @@ api-param-name {
     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-style: normal;
     font-weight: 400;
   }
+
+  /* If no default provided */
+  api-param-optional[no-default-value]:before {
+    content: "Optional";
+  }
+
+  api-param-optional[no-default-value]:after {
+    content: "";
+  }
   
   /* API parameter description block */
   api-param-desc {

package/ui/index.html

@@ -47,6 +47,16 @@
             }
             customElements.define("api-param-name", APIParamName);
 
+            class ApiParamOptional extends HTMLElement {
+                connectedCallback() {
+                    const text = (this.textContent || '').trim();
+                    if (!text) {
+                    this.innerHTML = ''; // remove content
+                    this.setAttribute('no-default-value', '');
+                    }
+                }
+            }
+            customElements.define('api-param-optional', ApiParamOptional);
 
             var ThemePreference = localStorage.getItem('hdocbook-theme-appearance') || '';
             const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches

package/ui/js/doc.hornbill.js

@@ -258,8 +258,12 @@ function loadContentUrl(
 	fromPopState,
 	fromBook = true,
 ) {
-	
-	
+	let downloadFile = false;
+	if (linkRef.includes('_books/')) {
+		downloadFile = linkRef.split('').length > 1;
+		console.log('downloadFile', downloadFile);
+	}
+
 	//-- clear table of contents
 	view.docApp.tableOfContents = [];
 	let clean_linkRef = linkRef;
@@ -271,23 +275,30 @@ function loadContentUrl(
 	clean_linkRef = removeTrailingSlash(clean_linkRef);
 	//-- remove starting / if link starts with it
 	clean_linkRef = removeStartingSlash(clean_linkRef);
-
-	//-- update url in browser
-	if (fromBook)
-		setBrowserViewUrl(clean_linkRef, {}, fromPageRefresh, fromPopState);
-	//-- destroy any existing content children and events properly
-	jqContentContainer.empty();
-	jqDocumentHeader.find(".document-title").empty();
-
-	//-- 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 = {};
+	
 	let booksLinkRef = clean_linkRef;
 	if (fromBook) {
 		booksLinkRef = clean_linkRef.includes("_books/")
 			? clean_linkRef
 			: `_books/${clean_linkRef}`;
 	}
-	fetch(booksLinkRef)
+
+	if (downloadFile) {
+		//-- open in new tab to download
+		window.open(booksLinkRef, '_blank');
+	} else {
+		//-- update url in browser
+		if (fromBook) {
+			setBrowserViewUrl(clean_linkRef, {}, fromPageRefresh, fromPopState);
+		}
+		
+		//-- destroy any existing content children and events properly
+		jqContentContainer.empty();
+		jqDocumentHeader.find(".document-title").empty();
+	
+		//-- 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(booksLinkRef)
 		.then((response) => {
 			if (response.headers.has("X-frontmatter")) {
 				frontmatterData = response.headers.get("X-frontmatter");
@@ -417,6 +428,8 @@ function loadContentUrl(
 
 			listenForHrefClicks();
 		});
+	}
+	
 }
 
 function setGitHubBookUrl(linkRef) {
@@ -625,6 +638,7 @@ Vue.component("nav-section-component", {
 	},
 });
 
+
 const hslDocLog = {
 	_entry: [],
 	log: function (strMessage, varData) {