Display notebook title in sidebar (not filename)

Author: dragonstyle

src/core/jupyter/jupyter-embed.ts

@@ -41,6 +41,7 @@ import {
 } from "./widgets.ts";
 import { globalTempContext } from "../temp.ts";
 import { isAbsolute } from "path/mod.ts";
+import { partitionMarkdown } from "../pandoc/pandoc-partition.ts";
 
 export interface JupyterNotebookAddress {
   path: string;
@@ -58,7 +59,7 @@ export interface JupyterMarkdownOptions
 interface JupyterNotebookOutputCache extends ObjectWithLifetime {
   cache: Record<
     string,
-    { outputs: JupyterCellOutput[] }
+    { outputs: JupyterCellOutput[]; title?: string }
   >;
 }
 
@@ -213,7 +214,7 @@ async function notebookMarkdown(
   options?: JupyterMarkdownOptions,
 ) {
   // Get the cell outputs for this notebook
-  const cellOutputs = await getCellOutputs(
+  const notebookInfo = await getCachedNotebookInfo(
     nbAddress,
     assets,
     context,
@@ -223,8 +224,13 @@ async function notebookMarkdown(
 
   // Wrap any injected cells with a div that includes a back link to
   // the notebook that originated the cells
-  const notebookMarkdown = (cells: JupyterCellOutput[]) => {
-    const markdown = ["", `:::{notebook="${nbAddress.path}"}`];
+  const notebookMarkdown = (cells: JupyterCellOutput[], title?: string) => {
+    const markdown = [
+      "",
+      `:::{notebook="${nbAddress.path}" ${
+        title ? `notebook-title="${title}"` : ""
+      }}`,
+    ];
     markdown.push("");
     markdown.push(cells.map((cell) => cell.markdown).join(""));
     markdown.push("");
@@ -237,7 +243,7 @@ async function notebookMarkdown(
     // those cells (cellIds can eiher be an explicitly set cellId, a label in the
     // cell metadata, or a tag on a cell that matches an id)
     const theCells = nbAddress.ids.map((id) => {
-      const cell = cellForId(id, cellOutputs);
+      const cell = cellForId(id, notebookInfo.outputs);
       if (cell === undefined) {
         throw new Error(
           `The cell ${id} does not exist in notebook`,
@@ -246,26 +252,26 @@ async function notebookMarkdown(
         return cell;
       }
     });
-    return notebookMarkdown(theCells);
+    return notebookMarkdown(theCells, notebookInfo.title);
   } else if (nbAddress.indexes) {
     // Filter and sort based upon cell indexes
     const theCells = nbAddress.indexes.map((idx) => {
-      if (idx < 0 || idx >= cellOutputs.length) {
+      if (idx < 0 || idx >= notebookInfo.outputs.length) {
         throw new Error(
           `The cell index ${idx} isn't within the range of cells`,
         );
       }
-      return cellOutputs[idx];
+      return notebookInfo.outputs[idx];
     });
-    return notebookMarkdown(theCells);
+    return notebookMarkdown(theCells, notebookInfo.title);
   } else {
     // Return all the cell outputs as there is no addtional
     // specification of cells
-    return notebookMarkdown(cellOutputs);
+    return notebookMarkdown(notebookInfo.outputs, notebookInfo.title);
   }
 }
 
-async function getCellOutputs(
+async function getCachedNotebookInfo(
   nbAddress: JupyterNotebookAddress,
   assets: JupyterAssets,
   context: RenderContext,
@@ -347,11 +353,26 @@ async function getCellOutputs(
       },
     );
 
+    // Compute the notebook title
+    const title = findTitle(result.cellOutputs);
+
     // Place the outputs in the cache
-    nbCache.cache[cacheKey] = { outputs: result.cellOutputs };
+    nbCache.cache[cacheKey] = { outputs: result.cellOutputs, title };
     lifetime.attach(nbCache, kNotebookCache);
   }
-  return nbCache.cache[cacheKey].outputs;
+  return nbCache.cache[cacheKey];
+}
+
+function findTitle(cells: JupyterCellOutput[]) {
+  for (const cell of cells) {
+    const partitioned = partitionMarkdown(cell.markdown);
+    if (partitioned.yaml?.title) {
+      return partitioned.yaml.title as string;
+    } else if (partitioned.headingText) {
+      return partitioned.headingText;
+    }
+  }
+  return undefined;
 }
 
 function notebookCacheKey(

src/format/html/format-html-bootstrap.ts

@@ -505,12 +505,15 @@ function processNotebookEmbeds(
 ) {
   const notebookDivNodes = doc.querySelectorAll("[data-notebook]");
   if (notebookDivNodes.length > 0) {
-    const nbPaths: string[] = [];
+    const nbPaths: { path: string; title: string | null }[] = [];
     notebookDivNodes.forEach((nbDivNode) => {
       const nbDivEl = nbDivNode as Element;
       const nbPath = nbDivEl.getAttribute("data-notebook");
       if (nbPath) {
-        nbPaths.push(nbPath);
+        nbPaths.push({
+          path: nbPath,
+          title: nbDivEl.getAttribute("data-notebook-title"),
+        });
       }
     });
 
@@ -525,25 +528,28 @@ function processNotebookEmbeds(
 
     const formatList = doc.createElement("ul");
     containerEl.appendChild(formatList);
-    ld.uniq(nbPaths).forEach((nbPath) => {
+    ld.uniqBy(nbPaths, (nbPath: { path: string; title?: string }) => {
+      return nbPath.path;
+    }).forEach((nbPath) => {
+      const filename = basename(nbPath.path);
       const li = doc.createElement("li");
 
       const link = doc.createElement("a");
-      link.setAttribute("href", nbPath);
-      link.setAttribute("download", basename(nbPath));
+      link.setAttribute("href", nbPath.path);
+      link.setAttribute("download", filename);
 
       const icon = doc.createElement("i");
       icon.classList.add("bi");
       icon.classList.add(`bi-journal-arrow-down`);
       link.appendChild(icon);
       link.appendChild(
-        doc.createTextNode(`${basename(nbPath)}`),
+        doc.createTextNode(`${nbPath.title || filename}`),
       );
 
       li.appendChild(link);
       formatList.appendChild(li);
 
-      resources.push(nbPath);
+      resources.push(nbPath.path);
     });
     let dlLinkTarget = doc.querySelector(`nav[role="doc-toc"]`);
     if (dlLinkTarget === null) {

src/resources/language/_language.yml

@@ -1,8 +1,8 @@
 toc-title-document: "Table of contents"
 toc-title-website: "On this page"
 
-related-formats-title: "Alternate Formats"
-related-notebooks-title: "Source Notebooks"
+related-formats-title: "Other Formats"
+related-notebooks-title: "Notebooks"
 
 section-title-abstract: "Abstract"
 section-title-appendices: "Appendices"