@pretextbook/pretext-html 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export { detectRenderTarget } from './target.js';
 export type { RenderTarget } from './target.js';
 export { injectRevealBridge, isRevealView, revealBridgeScript, } from './reveal.js';
 export type { RevealView, RevealViewOptions } from './reveal.js';
+export { openBornHiddenKnowls } from './knowls.js';
 export { rewriteAssetUrls } from './assets.js';
 export type { AssetKind, AssetUrlResolver } from './assets.js';
 export { describeAsset, missingAssetPlaceholder, missingAssetSvg, } from './missing-asset.js';

package/dist/index.js

@@ -1,28 +1,29 @@
-import { d as r, a as i, f as t, b as a, i as l, r as o, m as d, s as m, c as n, x as c } from "./cli-DZsyZERX.js";
-import { injectRevealBridge as p, isRevealView as f, revealBridgeScript as v } from "./reveal.js";
-import { describeAsset as E, missingAssetPlaceholder as S, missingAssetSvg as h, rewriteAssetUrls as x } from "./assets.js";
-import { PREVIEW_THEME_MESSAGE as u, injectThemeBridge as B, isPreviewTheme as M, previewThemeMessage as P, themeBridgeScript as R } from "./theme.js";
+import { d as r, a as i, f as t, b as a, i as o, o as l, r as n, m as d, s as m, c, x as p } from "./cli-DF7XOWN7.js";
+import { injectRevealBridge as f, isRevealView as v, revealBridgeScript as A } from "./reveal.js";
+import { describeAsset as S, missingAssetPlaceholder as h, missingAssetSvg as x, rewriteAssetUrls as B } from "./assets.js";
+import { PREVIEW_THEME_MESSAGE as u, injectThemeBridge as w, isPreviewTheme as M, previewThemeMessage as P, themeBridgeScript as R } from "./theme.js";
 export {
   u as PREVIEW_THEME_MESSAGE,
   r as defaultXslDir,
-  E as describeAsset,
+  S as describeAsset,
   i as detectRenderTarget,
   t as findSourceMapEntry,
   a as forcePortablePublication,
-  p as injectRevealBridge,
-  B as injectThemeBridge,
-  l as isJspiAvailable,
+  f as injectRevealBridge,
+  w as injectThemeBridge,
+  o as isJspiAvailable,
   M as isPreviewTheme,
-  f as isRevealView,
-  S as missingAssetPlaceholder,
-  h as missingAssetSvg,
+  v as isRevealView,
+  h as missingAssetPlaceholder,
+  x as missingAssetSvg,
+  l as openBornHiddenKnowls,
   P as previewThemeMessage,
-  o as renderHtml,
-  v as revealBridgeScript,
-  x as rewriteAssetUrls,
+  n as renderHtml,
+  A as revealBridgeScript,
+  B as rewriteAssetUrls,
   d as runCli,
   m as setAssetsBase,
-  n as setMountReader,
+  c as setMountReader,
   R as themeBridgeScript,
-  c as xpathStringLiteral
+  p as xpathStringLiteral
 };

package/dist/knowls.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Expand born-hidden knowls in a rendered preview.
+ *
+ * PreTeXt draws "born-hidden" blocks — solutions, hints, answers, and whatever
+ * else the publication file elects to hide — as a native `<details>` with the
+ * heading in a clickable `<summary>` and the content collapsed (see
+ * `mode="born-hidden"` in pretext-html.xsl). On a built page that is the point:
+ * the reader chooses what to reveal.
+ *
+ * In a live preview it works against the author. Editing a solution re-renders
+ * the page, and the fresh HTML has that solution collapsed again — so the one
+ * thing the author is looking at is the one thing they cannot see. Opening the
+ * knowls up front is what makes edit-and-watch work.
+ *
+ * Only `.born-hidden-knowl` is touched. The other `<details>` PreTeXt emits —
+ * footnotes, image descriptions, diagcess instructions, the print-options panel
+ * — are left collapsed, so the preview still reads like the built page.
+ *
+ * Done on the rendered HTML rather than in the preview stylesheet because a
+ * `<details>` is emitted from five separate upstream templates: an XSLT
+ * override would mean copying all five into the generated wrapper and keeping
+ * every one of them in step with upstream. Matching the class is one rule that
+ * cannot drift. Escaped text (a code sample showing `<details>`) is `&lt;` in
+ * the output and so cannot match.
+ *
+ * Safe with upstream's javascript: `SlideRevealer` in pretext-core.js binds a
+ * click handler that branches on whether the element already has `@open`, so a
+ * pre-opened knowl animates *closed* on the first click, exactly as it would
+ * had the reader opened it themselves.
+ */
+/**
+ * Add `@open` to every born-hidden knowl in `html`, leaving all other
+ * `<details>` alone.
+ *
+ * The knowl's `<summary>` is marked open too. That mirrors what pretext-core.js
+ * does when a reader clicks one (`triggerElement.setAttribute("open", "")`) and
+ * is what the theme's `.knowl__link:is(:hover,:focus,[open])` rule keys on for
+ * the summary's tinted background — without it a pre-opened knowl would be the
+ * only open knowl on the page whose heading is not highlighted. It is not a
+ * valid HTML attribute on `<summary>`; it is upstream's convention, matched
+ * here so the preview looks like the page a reader opened by hand.
+ */
+export declare function openBornHiddenKnowls(html: string): string;

package/dist/renderer.d.ts

@@ -137,6 +137,19 @@ export interface RenderOptions {
      * sourcemap.ts for the id contract with pretext-assembly.xsl.
      */
     sourceMap?: boolean;
+    /**
+     * Expand born-hidden knowls — solutions, hints, answers, and any block the
+     * publication file elects to hide — instead of leaving them collapsed.
+     * Defaults to **true**, because the pages this package renders are previews:
+     * an author editing a solution needs to see it without re-opening it after
+     * every re-render.
+     *
+     * Set it to false for a page meant to be read rather than authored against,
+     * which is then collapsed exactly as a real PreTeXt build would be. Other
+     * `<details>` (footnotes, image descriptions) are never affected. See
+     * knowls.ts.
+     */
+    openKnowls?: boolean;
     /**
      * Let the embedding app control the preview's light/dark theme. When set, a
      * small bridge script is injected into the page that applies this value as

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/pretext-html",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Convert PreTeXt documents to HTML in pure JavaScript using the official PreTeXt XSLT stylesheets via libxslt-wasm. No Python or PreTeXt installation required.",
   "author": "Oscar Levin",
   "license": "MIT",