Embed PDF scripts and browse examples

Replace the example dropdown with a collapsible list on the right.
Load bundled scripts on first use and take names from Info comments.

prompt: Add right-side examples; embed docs/scripts in scripts.js

Author: kjk

cmd/gen-docs.ts

@@ -7,6 +7,7 @@ import { join, resolve } from "node:path";
 import { commands as commandsDef } from "./gen-commands";
 import { checkCdnImages } from "./r2";
 import { copyFileNormalized, websiteDocsDir } from "./util.js";
+import { genPDFScripts } from "./gen-pdf-scripts";
 
 const docsDir = "docs";
 const manualOutDir = join(".work", "docs");
@@ -157,7 +158,7 @@ function copyScriptExamples(outDir: string, pages: string[]): void {
       throw new Error(`${kScriptExamplesPage}: duplicate script ${name}`);
     }
     names.add(name);
-    copyFileNormalized(join(outDir, "scripts", name), join(scriptsDir, name));
+    copyFileNormalized(join(outDir, "scripts", name), join(docsDir, "scripts", name));
   }
   for (const file of readdirSync(scriptsDir, { withFileTypes: true })) {
     if (file.isFile() && file.name.endsWith(".js") && !names.has(file.name)) {
@@ -292,6 +293,7 @@ export type GenDocsOptions = {
 export async function main(opts: GenDocsOptions = {}) {
   const timeStart = performance.now();
   console.log("gen-docs starting");
+  genPDFScripts();
 
   // CI has no (private) sumatra-website checkout; the exe ships without the manual
   if (!existsSync(mdDir)) {

cmd/gen-pdf-scripts.ts

@@ -1,29 +1,32 @@
-import { readFileSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
+import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
+import { join, resolve } from "node:path";
 
-const scripts = {
-  "load-a-pdf.js": "Load a PDF",
-  "create-a-pdf.js": "Create a PDF",
-  "add-an-annotation.js": "Add an annotation",
-  "convert-pdf-to-plain-text.js": "Convert PDF to plain text",
-  "convert-pdf-to-images.js": "Convert PDF to images",
-  "create-pdf.js": "Create PDF",
-  "create-pdf-low-level.js": "Create PDF (low level)",
-  "merge-pdfs.js": "Merge PDFs",
-  "create-pdf-with-thumbnails.js": "Create PDF with thumbnails",
-  "draw-graphics-with-device.js": "Draw graphics with Device",
-  "trace-device.js": "Trace device",
-  "pdf-dejpx.js": "Replace JPEG 2000 images",
-  "copy-outline.js": "Copy outline",
-  "pdf-bake.js": "Bake annotations",
-};
+const root = resolve(import.meta.dir, "..");
+const kDefaultScript = "load-a-pdf.js";
+const kScriptSeparator = "// ---";
 
-const root = join(import.meta.dir, "..");
-let out = "// Generated by cmd/gen-pdf-scripts.ts.\nstatic const PDFScriptExample kPDFScripts[] = {\n";
-for (const [file, title] of Object.entries(scripts)) {
-  const source = readFileSync(join(root, "src/pdf-scripts", file), "utf8").replaceAll("\r\n", "\n");
-  if (source.includes(')JS"')) throw new Error(`Raw-string delimiter in ${file}`);
-  out += `    {StrL(${JSON.stringify(title)}), StrL(R"JS(${source})JS")},\n`;
+export function genPDFScripts(inputRoot = root): string {
+  const scriptsDir = join(inputRoot, "docs/scripts");
+  const names = readdirSync(scriptsDir, { withFileTypes: true })
+    .filter((file) => file.isFile() && file.name.endsWith(".js"))
+    .map((file) => file.name)
+    .sort();
+  const first = names.indexOf(kDefaultScript);
+  if (first >= 0) names.unshift(...names.splice(first, 1));
+  const scripts = names.map((name) => {
+    const source = readFileSync(join(scriptsDir, name), "utf8").replaceAll("\r\n", "\n").trimEnd();
+    if (source.includes(kScriptSeparator)) throw new Error(`${name}: contains the script separator`);
+    if (!source.trim()) throw new Error(`${name}: empty script`);
+    return source;
+  });
+  if (!scripts.length) throw new Error("No PDF scripts found");
+  const bundle = scripts.join(`\n${kScriptSeparator}\n`) + "\n";
+  const output = join(inputRoot, ".work/scripts.js");
+  mkdirSync(join(inputRoot, ".work"), { recursive: true });
+  if (!existsSync(output) || readFileSync(output, "utf8") !== bundle) writeFileSync(output, bundle);
+  return output;
+}
+
+if (import.meta.main) {
+  console.log(genPDFScripts());
 }
-out += "};\n";
-writeFileSync(join(root, "src/shared/PDFScriptExamples.inc"), out);

cmd/helper/embedded.ts

@@ -12,6 +12,7 @@ import {
 } from "node:fs";
 import { dirname, join, relative, resolve, sep } from "node:path";
 import type { Toolchain } from "./ng-toolchain";
+import { genPDFScripts } from "../gen-pdf-scripts";
 
 const root = resolve(import.meta.dir, "../..");
 export const fontPatterns: [string, string[]][] = [
@@ -75,6 +76,7 @@ export async function packEmbedded(
   const staging = join(dir, "embedded");
   const archive = join(dir, "embedded.lzsa");
   const inputs = new Map<string, string>();
+  inputs.set("scripts.js", genPDFScripts(inputRoot));
   const docs = join(inputRoot, ".work/docs");
   if (opts.manual) {
     for (const src of filesUnder(docs)) inputs.set(relative(docs, src), src);

cmd/helper/ng-shared.ts

@@ -115,7 +115,6 @@ export const sharedFiles = [
   "src/shared/AdvancedSettingsDialogCommon.h",
   "src/shared/PDFScript.h",
   "src/shared/PDFScriptCommon.cpp",
-  "src/shared/PDFScriptExamples.inc",
   "src/shared/RestrictedUseConfig.cpp",
   "src/shared/RestrictedUseConfig.h",
   "src/shared/AnnotEditToolbarCommon.cpp",

cmd/pack-embedded-prebuild.cmd

@@ -73,6 +73,7 @@ if exist "%WORK%\docs\" (
 )
 if not exist "%STAGING%\" mkdir "%STAGING%"
 copy /y "%WORK%\translations.txt" "%STAGING%\translations.txt" >nul || exit /b 1
+copy /y "%WORK%\scripts.js" "%STAGING%\scripts.js" >nul || exit /b 1
 copy /y "%ROOT%\ext\marked.min.js" "%STAGING%\marked.min.js" >nul || exit /b 1
 copy /y "%ROOT%\ext\mermaid.min.js" "%STAGING%\mermaid.min.js" >nul || exit /b 1
 

docs/scripts/add-an-annotation.js

@@ -0,0 +1,15 @@
+// Info: Add a free-text annotation to the first page.
+// Arg: Input PDF
+// Arg: Output PDF
+
+var doc = Document.openDocument(scriptArgs[0]);
+
+var page = doc.loadPage(0);
+
+var annot = page.createAnnotation("FreeText");
+annot.setRect([10, 10, 200, 100]);
+annot.setContents("Hello, world!");
+
+page.update();
+
+doc.save(scriptArgs[1]);

docs/scripts/convert-pdf-to-images.js

@@ -0,0 +1,10 @@
+// Info: Render every page as a PNG at 96 DPI.
+// Arg: Input PDF
+// Arg: Output filename prefix (folder must exist)
+
+var doc = Document.openDocument(scriptArgs[0]);
+for (var i = 0; i < doc.countPages(); ++i) {
+  var page = doc.loadPage(i);
+  var pixmap = page.toPixmap(Matrix.scale(96 / 72, 96 / 72), ColorSpace.DeviceRGB);
+  pixmap.saveAsPNG(scriptArgs[1] + "-" + (i + 1) + ".png");
+}

docs/scripts/convert-pdf-to-plain-text.js

@@ -0,0 +1,9 @@
+// Info: Print the text of every page.
+// Arg: Input PDF
+
+var doc = Document.openDocument(scriptArgs[0]);
+for (var i = 0; i < doc.countPages(); ++i) {
+  var page = doc.loadPage(i);
+  var text = page.toStructuredText().asText();
+  print(text);
+}

docs/scripts/copy-outline.js

@@ -0,0 +1,40 @@
+// Info: Copy bookmarks from another document.
+// Arg: Input PDF
+// Arg: Output PDF
+// Arg: Outline source PDF
+
+// Copy an outline from one document to another PDF file.
+// Can be used to transfer outlines when converting from another format into PDF.
+// Can also be used to change outlines to use page numbers instead of named destinations.
+
+if (scriptArgs.length != 3) {
+  print("arguments: input.pdf output.pdf outline-source.pdf");
+  quit();
+}
+
+function copy_outline_rec(cursor, input, list) {
+  list.forEach(function (node) {
+    var page = input.resolveLink(node.uri);
+    cursor.insert({ title: node.title, uri: "#page=" + (page + 1) });
+    if (node.down) {
+      cursor.prev();
+      cursor.down();
+      copy_outline_rec(cursor, input, node.down);
+      cursor.up();
+      cursor.next();
+    }
+  });
+}
+
+function copy_outline(output, input, list) {
+  var cursor = output.outlineIterator();
+  while (cursor.item()) cursor.delete();
+  copy_outline_rec(cursor, input, list);
+}
+
+var input = Document.openDocument(scriptArgs[2]);
+var output = Document.openDocument(scriptArgs[0]);
+
+copy_outline(output, input, input.loadOutline());
+
+output.save(scriptArgs[1], "compress");

docs/scripts/create-a-pdf.js

@@ -0,0 +1,7 @@
+// Info: Create a PDF with one blank page.
+// Arg: Unused (leave empty)
+// Arg: Output PDF
+
+var doc = new PDFDocument();
+doc.insertPage(-1, doc.addPage([0, 0, 595, 842], 0, null, ""));
+doc.save(scriptArgs[1]);