hdoc-tools 0.64.0 → 0.66.0

package/hdoc-toc.js

@@ -118,12 +118,17 @@ class TocModel {
 	}
 
 	// Resolve a leaf link (path without extension) to a source-relative file.
+	// Links may carry a leading slash (both "/docId/page" and "docId/page"
+	// appear in real books) — the returned rel is normalized to the
+	// slash-free, forward-slash form list_files() produces, or the linked
+	// flags and file labels built from it never match.
 	_resolve_file(link) {
-		const rel = `${link}.md`;
+		const clean = String(link).replace(/^\/+/, "");
+		const rel = `${clean}.md`;
 		if (fs.existsSync(path.join(this.source_path, rel))) {
 			return { file: rel, fileExists: true };
 		}
-		const rel_index = path.join(link, "index.md");
+		const rel_index = `${clean}/index.md`;
 		if (fs.existsSync(path.join(this.source_path, rel_index))) {
 			return { file: rel_index, fileExists: true };
 		}
@@ -258,8 +263,13 @@ class TocModel {
 		if (segs.includes("..") || segs.includes(".")) {
 			throw new Error("Invalid path");
 		}
-		if (segs.some((s) => s.startsWith("_"))) {
-			throw new Error("Cannot operate inside special (_) folders");
+		// Special "_" folders are off-limits, with one exception: _inline
+		// directly under the book root holds real, editable inline-help pages
+		// (they render in serve/build and are exempt from the nav tree).
+		for (let i = 0; i < segs.length; i++) {
+			if (segs[i].startsWith("_") && !(i === 1 && segs[i] === "_inline")) {
+				throw new Error("Cannot operate inside special (_) folders");
+			}
 		}
 		if (!dir && exts) {
 			const lower = norm.toLowerCase();
@@ -288,32 +298,43 @@ class TocModel {
 		return set;
 	}
 
-	// Every file on disk under the book (excluding "_" folders), each tagged with
+	// Every file on disk under the book (excluding "_" folders, except _inline
+	// at the book root — those are real inline-help pages), each tagged with
 	// its kind (page/image/other). Pages also carry a linked flag (in nav or not).
 	list_files() {
 		const linked = this.linked_files();
 		const root = path.join(this.source_path, this.docId);
 		const files = [];
 		const dirs = [];
-		const walk = (absDir) => {
+		const walk = (absDir, in_inline) => {
 			for (const e of fs.readdirSync(absDir, { withFileTypes: true })) {
-				if (e.name.startsWith("_")) continue; // skip special folders/files
+				if (e.name.startsWith("_")) {
+					// _inline at the book root is editable content; every other
+					// _ entry stays hidden (and blocked by _safe_rel)
+					if (!(absDir === root && e.name === "_inline" && e.isDirectory()))
+						continue;
+				}
 				const abs = path.join(absDir, e.name);
 				const rel = path.relative(this.source_path, abs).split(path.sep).join("/");
+				const inline = in_inline || e.name === "_inline";
 				if (e.isDirectory()) {
 					dirs.push(rel);
-					walk(abs);
+					walk(abs, inline);
 				} else {
 					const kind = kind_of(e.name);
 					files.push({
 						file: rel,
 						kind,
-						linked: kind === "page" ? linked.has(rel) : false,
+						// _inline pages are referenced from app help contexts, never
+						// the contents tree — report them linked so the unlinked
+						// badge/filter stays meaningful
+						linked:
+							kind === "page" ? (inline ? true : linked.has(rel)) : false,
 					});
 				}
 			}
 		};
-		if (fs.existsSync(root)) walk(root);
+		if (fs.existsSync(root)) walk(root, false);
 		files.sort((a, b) => a.file.localeCompare(b.file));
 		dirs.sort((a, b) => a.localeCompare(b));
 		return { docId: this.docId, dirs, files };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hdoc-tools",
-	"version": "0.64.0",
+	"version": "0.66.0",
 	"description": "Hornbill HDocBook Development Support Tool",
 	"main": "hdoc.js",
 	"bin": {
@@ -23,6 +23,7 @@
 		"hdoc-mermaid.js",
 		"hdoc-module.js",
 		"hdoc-serve.js",
+		"hdoc-serve-validate.js",
 		"hdoc-spell.js",
 		"hdoc-stats.js",
 		"hdoc-toc.js",

package/ui/index.html

@@ -413,7 +413,9 @@
                           <i v-bind:class="{'bi bi-chevron-right': !asection.expand,'bi bi-chevron-down': asection.expand}" class="bi"></i>
                       </div>
                   </div>
-                  <span class="title-text">{{asection.text}}</span>
+                  <!-- LOCAL PREVIEW PATCH: draft/inline badges so authors can see unpublished
+                       sections in `hdoc serve`/`hdoc edit` - keep on live-site re-sync -->
+                  <span class="title-text"><i v-if="asection.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This section is set to draft."></i><i v-if="asection.inline" class="bi bi-files-alt text-warning" title="This section is set to inline."></i> {{asection.text}}</span>
               </div>
               <!-- A collapsed group now renders NOTHING instead of hidden DOM. With v-show, every
                    descendant of every collapsed group stayed in the document: on a large book that
@@ -429,7 +431,8 @@
 
                       <div v-if="!navSectionItem.items">
                           <a class="DocLink link noitems" v-bind:href="navSectionItem.link" v-bind:target="navSectionItem.target || ''" style="padding-left: 0px;">
-                              <span class="link-text">{{navSectionItem.text}} <i v-if="navSectionItem.target" class="bi bi-box-arrow-up-right"></i> </span>
+                              <!-- LOCAL PREVIEW PATCH: draft badge on leaf links - keep on live-site re-sync -->
+                              <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> {{navSectionItem.text}} <i v-if="navSectionItem.target" class="bi bi-box-arrow-up-right"></i> </span>
                           </a>
                       </div>
 

package/ui/js/bootstrap.js

@@ -82,7 +82,8 @@ function loadJS(arrFiles,callback)
             "js/doc.hornbill.js",
             "js/highlightjs/highlight.pack.js",
             "js/highlightjs-badge.js",
-            "js/hdoc-edit-inline.js" //-- LOCAL PREVIEW PATCH: inline edit for `hdoc serve` (no-op unless the server enables it) - keep on live-site re-sync
+            "js/hdoc-edit-inline.js", //-- LOCAL PREVIEW PATCH: inline edit for `hdoc serve` (no-op unless the server enables it) - keep on live-site re-sync
+            "js/hdoc-edit-book.js" //-- LOCAL PREVIEW PATCH: Edit Mode suite (contents/files management) for `hdoc serve` - keep on live-site re-sync
             ],function()
     {
         intialiseApp();

package/ui/js/doc.hornbill.js

@@ -839,7 +839,21 @@ var docAppMethods = {
             view.docApp.book = data;
             view.docApp.title = data.title || "";
             view.docApp.description = data.description || "";
-                      
+
+            //-- LOCAL PREVIEW PATCH: `hdoc serve`/`hdoc edit` publish the book's _inline/
+            //-- content as a nav_inline fragment on the library.json book entry (see
+            //-- hdoc-content-routes.js build_nav_inline). Append it to the nav tree so
+            //-- inline help pages are reachable from the menu - keep on live-site re-sync.
+            //-- look the book up in the library rather than trusting aBook: some call
+            //-- sites (e.g. search result clicks) pass a bare {docId} stub.
+            var libBook = getLibraryBooksIndex().get(data.docId) || aBook;
+            var navInline = libBook && libBook.nav_inline;
+            if(navInline && Array.isArray(navInline.items) && navInline.items.length &&
+               data.navigation && Array.isArray(data.navigation.items))
+            {
+                data.navigation.items.push(navInline);
+            }
+
 
             view.docApp.loadingBookInfo = false; //-- move this here into timeout to avoid loading glitch that shows main landing page