@heroiclands/package-build 23.12.1 → 23.12.3

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @heroiclands/package-build
 
+## 23.12.3
+
+### Patch Changes
+
+In Foundry, every package's journals now show marked names in bold, mark links to pages no package publishes, and set captioned pictures, tables and verse with their labels, as the site and the preview do.
+
+Sites build again on Hugo 0.163, where a page without a definition list stopped the whole build.
+
+Site search no longer finds or quotes the text of secrets.
+
+A module's journals, scenes, macros and adventures load under any system; only its Actor and Item packs belong to the system it declares.
+
+## 23.12.2
+
+### Patch Changes
+
+A wikilink whose label also names a different note no longer asks for its full name first.
+
 ## 23.12.1
 
 ### Patch Changes

package/assets/styles/content-base.css

@@ -15,10 +15,12 @@
  * The base stylesheet every package ships, staged into the package root and
  * named first in the manifest's `styles`.
  *
- * It carries only what every package needs for its compiled content to be
- * legible, which today is the definition list: an infobox emits one, and so
- * does the ordinary markdown `Term` / `: definition` syntax. A package keeps
- * its own stylesheet for its own needs and overrides anything here from it.
+ * It carries what every package's compiled content needs to read in Foundry as
+ * it does in the preview and on the site: definition lists, poetry, alerts,
+ * inline spoilers, marked names, unresolved links and captioned blocks. Every
+ * class the Foundry renderer emits is styled here or exempted by name in
+ * `tests/base-styles.test.ts`. A package keeps its own stylesheet for its own
+ * needs and overrides anything here from it.
  *
  * `packageBuild.baseStyles: false` declines it.
  *
@@ -351,3 +353,83 @@
     outline: 2px solid currentColor;
     outline-offset: 2px;
 }
+
+/*
+ * A name the text marks is bold, as on the site, in the preview and in the book.
+ * Foundry's interface and a system's sheets use `.name` for their own elements,
+ * which the content roots leave untouched.
+ */
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .name {
+    font-weight: var(--pb-name-weight, 700);
+}
+
+/*
+ * A wikilink whose target no package publishes keeps its text and is marked, so
+ * the sentence still reads and a reader can tell a link was meant. Each value
+ * defers to a SoHL custom property, so the system's theme wins where it is
+ * installed. `light-dark()` follows the colour scheme Foundry sets, rather than
+ * the operating system's. The underline serves a reader who cannot separate
+ * the hue from body text.
+ */
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .sohl-unresolved-link {
+    font-weight: var(--sohl-unresolved-link-weight, 700);
+    color: var(--sohl-unresolved-link-color, light-dark(#b3261e, #ff8a80));
+    text-decoration: var(--sohl-unresolved-link-decoration, underline dotted currentcolor);
+    text-underline-offset: 0.15em;
+    cursor: help;
+}
+
+/*
+ * A captioned block: picture, table, verse or passage. Every kind is styled
+ * alike, so a kind added to the vocabulary arrives styled. The block owns the
+ * space around what it wraps, and its label reads as a caption rather than as
+ * another paragraph.
+ */
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) .content-figure {
+    margin: 1.5rem 0;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .content-figure
+    > :first-child {
+    margin-top: 0;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror) figure.note-image {
+    display: table;
+    max-width: 100%;
+    margin: 1.5rem 0;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .content-figure
+    > figure.note-image {
+    margin: 0;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    figure.note-image
+    img {
+    display: block;
+    max-width: 100%;
+    height: auto;
+    border: none;
+}
+
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .content-figure-label {
+    margin: 0.5rem 0 0;
+    font-size: 0.85em;
+    line-height: 1.4;
+    opacity: 0.75;
+}
+
+/* `.border` is the one class an author may write on a block, and it draws the
+ * block as a boxed aside. */
+:is(.journal-entry-page, .journal-entry-content, .editor-content, .prosemirror)
+    .content-figure.border {
+    padding: 1rem 1.25rem;
+    border: 1px solid var(--pb-figure-border, currentcolor);
+    border-radius: 4px;
+}

package/docs/configuration.md

@@ -718,17 +718,17 @@ packs:
   - { name: journals, type: JournalEntry, label: Journals }
 ```
 
-| Key (under `packs[]`) | Type                                                                  | Required | Default                                 |
-| --------------------- | --------------------------------------------------------------------- | -------- | --------------------------------------- |
-| `packs[].name`        | string                                                                | yes      | —                                       |
-| `packs[].type`        | one of `Actor`, `Adventure`, `Item`, `JournalEntry`, `Macro`, `Scene` | yes      | —                                       |
-| `packs[].label`       | string                                                                | no       | `packs[].name`                          |
-| `packs[].private`     | boolean                                                               | no       | `false`                                 |
-| `packs[].companions`  | array, same shape, one level only                                     | no       | `[]`                                    |
-| `packs[].mayBeEmpty`  | boolean                                                               | no       | `false`                                 |
-| `packs[].default`     | boolean                                                               | no       | `false`                                 |
-| `packs[].prebuilt`    | string (directory)                                                    | no       | `null`                                  |
-| `packs[].system`      | string                                                                | no       | `null` — falls back to `stats.systemId` |
+| Key (under `packs[]`) | Type                                                                  | Required | Default                                                                                                |
+| --------------------- | --------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
+| `packs[].name`        | string                                                                | yes      | —                                                                                                      |
+| `packs[].type`        | one of `Actor`, `Adventure`, `Item`, `JournalEntry`, `Macro`, `Scene` | yes      | —                                                                                                      |
+| `packs[].label`       | string                                                                | no       | `packs[].name`                                                                                         |
+| `packs[].private`     | boolean                                                               | no       | `false`                                                                                                |
+| `packs[].companions`  | array, same shape, one level only                                     | no       | `[]`                                                                                                   |
+| `packs[].mayBeEmpty`  | boolean                                                               | no       | `false`                                                                                                |
+| `packs[].default`     | boolean                                                               | no       | `false`                                                                                                |
+| `packs[].prebuilt`    | string (directory)                                                    | no       | `null`                                                                                                 |
+| `packs[].system`      | string                                                                | no       | `null` — an ActiveEffect, Actor or Item pack falls back to `stats.systemId`; any other pack names none |
 
 `private: true` restricts a Foundry compendium to GMs. A note tagged `gm`
 compiles only into private packs. Set `data.pack` to a private pack for the
@@ -1861,10 +1861,13 @@ Whether the package takes the shared base stylesheet. It defaults to `true`,
 is staged to `styles/package-build-base.css` under the stage root, and is
 named first in the generated manifest's `styles`.
 
-The sheet carries only what every package's compiled content relies on to be
-legible — the definition-list style an infobox and the markdown `Term` /
-`: definition` syntax both emit — and is scoped to the journal, enriched-field
-and editor containers so it cannot reach Foundry's own interface.
+The sheet carries what every package's compiled content needs to read in
+Foundry as it does in the preview and on the site: definition lists (an
+infobox and the markdown `Term` / `: definition` syntax both emit one),
+poetry, alerts, inline spoilers, marked names in bold, unresolved links and
+captioned blocks. It is scoped to the journal, enriched-field and editor
+containers so it cannot reach Foundry's own interface, where `.name` and `dl`
+style Foundry's and the system's own elements.
 
 It loads into the cascade layer Foundry reserves for the package kind,
 `system` or `modules`, which is the weakest layer a package can occupy. A

package/engine/base-styles.mjs

@@ -14,11 +14,11 @@
 /**
  * The **base stylesheet** every package ships, and where it lands.
  *
- * Compiled content relies on a handful of rules to be legible — a definition
- * list is the whole of it today — and five packages need them. Four of those
- * have no stylesheet at all, so writing the rules by hand means one edit and
- * four new files, each with a configuration entry, each free to diverge from
- * the first time one of them is touched. This repository already ships
+ * Compiled content relies on a handful of rules to read the same in Foundry as
+ * in the preview and on the site, and every package needs them. Most packages
+ * have no stylesheet of their own, so writing the rules by hand means a new
+ * file in each, each with a configuration entry, each free to diverge from the
+ * first time one of them is touched. This repository already ships
  * configuration to consumers and already generates the manifest that declares
  * a package's `styles`, so it can ship the sheet the same way: one file,
  * staged into every package, corrected in one place.

package/engine/content-blocks.mjs

@@ -290,7 +290,7 @@ export function renderBlocks(source, target) {
         } else {
             output.push(
                 "",
-                `<details ${attributes}>`,
+                `<details ${attributes} data-pagefind-ignore>`,
                 `<summary class="${escapeAttribute(block.name)}">${title}</summary>`,
                 "",
                 held,

package/engine/content-spans.mjs

@@ -307,7 +307,7 @@ export function renderSpans(source) {
         );
         const content =
             secret ?
-                `<span${attrs} data-inline-secret><button type="button" class="inline-secret-toggle" aria-label="Show spoiler" aria-expanded="false">Show spoiler</button><span class="inline-secret-content" hidden>${inner}</span></span>`
+                `<span${attrs} data-inline-secret data-pagefind-ignore><button type="button" class="inline-secret-toggle" aria-label="Show spoiler" aria-expanded="false">Show spoiler</button><span class="inline-secret-content" hidden>${inner}</span></span>`
             :   `<span${attrs}>${inner}</span>`;
         markdown = markdown.slice(0, span.start) + content + markdown.slice(span.end);
     }

package/engine/first-use.mjs

@@ -328,7 +328,7 @@ export function createFirstUseChecker({
                     `“${entry.full}” is linked or marked more than once`,
                 );
             // A resolved wikilink identifies its note, so its label may be any natural form.
-            const introduces = entry.fullUse || entry.key === event.preferred?.key;
+            const introduces = entry.fullUse || event.preferred !== undefined;
             if (!introduces && !fullUsed.has(entry.key))
                 add(
                     event.start,

package/hugo-theme/layouts/partials/dictionary-lists.html

@@ -1,53 +1,58 @@
 {{- /* Group the final Goldmark HTML. Quote-aware tokens preserve attributes,
      literal examples, comments and raw blocks; a stack gives each nested list
      its own rows. Existing grouped lists keep their authored divs. */ -}}
+{{- /* One return, at the end: Hugo 0.163, which the CI runners use, fails on
+     a `return` inside a block. */ -}}
 {{- $source := string . -}}
-{{- if not (findRE `(?i)<dl(?:\s|>)` $source) -}}{{- return ($source | safeHTML) -}}{{- end -}}
-{{- $pattern := `(?is)<!--.*?-->|<script\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</script\s*>|<style\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</style\s*>|<pre\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</pre\s*>|<textarea\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</textarea\s*>|<![^>]*>|</?[a-z][a-z0-9:-]*(?:[^"'<>]|"[^"]*"|'[^']*')*>|[^<]+|<` -}}
-{{- $parts := slice -}}
-{{- $lists := slice -}}
-{{- $elements := slice -}}
-{{- $tokens := findRE $pattern $source -}}
-{{- range $i, $token := $tokens -}}
-  {{- if and (gt (len $lists) 0) (gt $i 0) (lt (add $i 1) (len $tokens)) (findRE `^\s+$` $token) (findRE `(?i)^</dt\s*>$` (index $tokens (sub $i 1))) (findRE `(?i)^<dd(?:\s|>)` (index $tokens (add $i 1))) -}}
-    {{- $token = "" -}}
-  {{- end -}}
-  {{- if and (gt (len $lists) 0) (gt $i 0) (lt (add $i 1) (len $tokens)) (findRE `^\s+$` $token) (findRE `(?i)^<dd(?:\s[^>]*)?>$` (index $tokens (sub $i 1))) (findRE `(?i)^<p(?:\s|>)` (index $tokens (add $i 1))) -}}
-    {{- $token = "" -}}
-  {{- end -}}
-  {{- $tag := "" -}}
-  {{- $opaque := findRE `(?i)^<(?:!--|script\b|style\b|pre\b|textarea\b)` $token -}}
-  {{- if and (not $opaque) (findRE `(?i)^</?[a-z]` $token) -}}
-    {{- $tag = lower (replaceRE `(?is)^</?([a-z][a-z0-9:-]*).*` "$1" $token) -}}
-    {{- $closing := hasPrefix $token "</" -}}
-    {{- if and (eq $tag "dl") (not $closing) -}}
-      {{- $list := newScratch -}}
-      {{- $list.Set "row" false -}}
-      {{- $lists = $lists | append $list -}}
-      {{- if or (findRE `(?i)\sclass\s*=\s*["'](?:[^"']*\s)?dictionary(?:\s|["'])` $token) (findRE `(?i)\sclass\s*=\s*dictionary(?:\s|>)` $token) -}}
-      {{- else if findRE `(?i)\sclass\s*=\s*["']` $token -}}
-        {{- $token = replaceRE `(?i)(\sclass\s*=\s*["'])` "${1}dictionary " $token -}}
-      {{- else if findRE `(?i)\sclass\s*=` $token -}}
-        {{- $token = replaceRE `(?i)(\sclass\s*=\s*)([^\s>]+)` `${1}"dictionary ${2}"` $token -}}
-      {{- else -}}
-        {{- $token = replaceRE `(?i)^<dl` `<dl class="dictionary"` $token -}}
-      {{- end -}}
-    {{- else if and (eq $tag "dt") (not $closing) (gt (len $lists) 0) (eq (index $elements (sub (len $elements) 1)) "dl") -}}
-      {{- $list := index $lists (sub (len $lists) 1) -}}
-      {{- if $list.Get "row" -}}{{- $parts = $parts | append "</div>" -}}{{- end -}}
-      {{- $parts = $parts | append "<div>" -}}
-      {{- $list.Set "row" true -}}
-    {{- else if and (eq $tag "dl") $closing (gt (len $lists) 0) -}}
-      {{- $list := index $lists (sub (len $lists) 1) -}}
-      {{- if $list.Get "row" -}}{{- $parts = $parts | append "</div>" -}}{{- end -}}
-      {{- $lists = first (sub (len $lists) 1) $lists -}}
+{{- $result := $source -}}
+{{- if findRE `(?i)<dl(?:\s|>)` $source -}}
+  {{- $pattern := `(?is)<!--.*?-->|<script\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</script\s*>|<style\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</style\s*>|<pre\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</pre\s*>|<textarea\b(?:[^"'<>]|"[^"]*"|'[^']*')*>.*?</textarea\s*>|<![^>]*>|</?[a-z][a-z0-9:-]*(?:[^"'<>]|"[^"]*"|'[^']*')*>|[^<]+|<` -}}
+  {{- $parts := slice -}}
+  {{- $lists := slice -}}
+  {{- $elements := slice -}}
+  {{- $tokens := findRE $pattern $source -}}
+  {{- range $i, $token := $tokens -}}
+    {{- if and (gt (len $lists) 0) (gt $i 0) (lt (add $i 1) (len $tokens)) (findRE `^\s+$` $token) (findRE `(?i)^</dt\s*>$` (index $tokens (sub $i 1))) (findRE `(?i)^<dd(?:\s|>)` (index $tokens (add $i 1))) -}}
+      {{- $token = "" -}}
     {{- end -}}
-    {{- if $closing -}}
-      {{- if gt (len $elements) 0 -}}{{- $elements = first (sub (len $elements) 1) $elements -}}{{- end -}}
-    {{- else if not (or (findRE `/\s*>$` $token) (in (slice "area" "base" "br" "col" "embed" "hr" "img" "input" "link" "meta" "param" "source" "track" "wbr") $tag)) -}}
-      {{- $elements = $elements | append $tag -}}
+    {{- if and (gt (len $lists) 0) (gt $i 0) (lt (add $i 1) (len $tokens)) (findRE `^\s+$` $token) (findRE `(?i)^<dd(?:\s[^>]*)?>$` (index $tokens (sub $i 1))) (findRE `(?i)^<p(?:\s|>)` (index $tokens (add $i 1))) -}}
+      {{- $token = "" -}}
+    {{- end -}}
+    {{- $tag := "" -}}
+    {{- $opaque := findRE `(?i)^<(?:!--|script\b|style\b|pre\b|textarea\b)` $token -}}
+    {{- if and (not $opaque) (findRE `(?i)^</?[a-z]` $token) -}}
+      {{- $tag = lower (replaceRE `(?is)^</?([a-z][a-z0-9:-]*).*` "$1" $token) -}}
+      {{- $closing := hasPrefix $token "</" -}}
+      {{- if and (eq $tag "dl") (not $closing) -}}
+        {{- $list := newScratch -}}
+        {{- $list.Set "row" false -}}
+        {{- $lists = $lists | append $list -}}
+        {{- if or (findRE `(?i)\sclass\s*=\s*["'](?:[^"']*\s)?dictionary(?:\s|["'])` $token) (findRE `(?i)\sclass\s*=\s*dictionary(?:\s|>)` $token) -}}
+        {{- else if findRE `(?i)\sclass\s*=\s*["']` $token -}}
+          {{- $token = replaceRE `(?i)(\sclass\s*=\s*["'])` "${1}dictionary " $token -}}
+        {{- else if findRE `(?i)\sclass\s*=` $token -}}
+          {{- $token = replaceRE `(?i)(\sclass\s*=\s*)([^\s>]+)` `${1}"dictionary ${2}"` $token -}}
+        {{- else -}}
+          {{- $token = replaceRE `(?i)^<dl` `<dl class="dictionary"` $token -}}
+        {{- end -}}
+      {{- else if and (eq $tag "dt") (not $closing) (gt (len $lists) 0) (eq (index $elements (sub (len $elements) 1)) "dl") -}}
+        {{- $list := index $lists (sub (len $lists) 1) -}}
+        {{- if $list.Get "row" -}}{{- $parts = $parts | append "</div>" -}}{{- end -}}
+        {{- $parts = $parts | append "<div>" -}}
+        {{- $list.Set "row" true -}}
+      {{- else if and (eq $tag "dl") $closing (gt (len $lists) 0) -}}
+        {{- $list := index $lists (sub (len $lists) 1) -}}
+        {{- if $list.Get "row" -}}{{- $parts = $parts | append "</div>" -}}{{- end -}}
+        {{- $lists = first (sub (len $lists) 1) $lists -}}
+      {{- end -}}
+      {{- if $closing -}}
+        {{- if gt (len $elements) 0 -}}{{- $elements = first (sub (len $elements) 1) $elements -}}{{- end -}}
+      {{- else if not (or (findRE `/\s*>$` $token) (in (slice "area" "base" "br" "col" "embed" "hr" "img" "input" "link" "meta" "param" "source" "track" "wbr") $tag)) -}}
+        {{- $elements = $elements | append $tag -}}
+      {{- end -}}
     {{- end -}}
+    {{- $parts = $parts | append $token -}}
   {{- end -}}
-  {{- $parts = $parts | append $token -}}
+  {{- $result = delimit $parts "" -}}
 {{- end -}}
-{{- return (delimit $parts "" | safeHTML) -}}
+{{- return ($result | safeHTML) -}}

package/manifest.mjs

@@ -233,6 +233,9 @@ const MANIFEST_KEY_ORDER = Object.freeze([
     "download",
 ]);
 
+/** The pack types Foundry requires to name a system. */
+const SYSTEM_SPECIFIC_PACK_TYPES = Object.freeze(["ActiveEffect", "Actor", "Item"]);
+
 /**
  * The manifest's `packs`, derived from the one pack list the build already has.
  *
@@ -254,11 +257,12 @@ export function manifestPacks(config) {
     return config.packs.flatMap(flatten).map((pack) => {
         // Foundry requires `system` on ActiveEffect, Actor and Item packs and
         // on no others, so the value is per pack: its own declaration first,
-        // then the package-wide one. With neither, the key is omitted — an
-        // Adventure, Scene or JournalEntry pack that declares a system is
-        // hidden from every other system, which is rarely what a package that
-        // declined to name one meant.
-        const system = pack.system ?? config.stats.systemId;
+        // then, for those three types only, the package-wide one. Any other
+        // pack that declares a system is hidden from every other system, so it
+        // carries one only when it names one itself.
+        const system =
+            pack.system ??
+            (SYSTEM_SPECIFIC_PACK_TYPES.includes(pack.type) ? config.stats.systemId : undefined);
         return {
             label: pack.label,
             type: pack.type,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@heroiclands/package-build",
-    "version": "23.12.1",
+    "version": "23.12.3",
     "description": "Shared toolchain for building and shipping a HeroicLands Foundry VTT package — content compilation, manifest, localization, staging, bundle, release and deployment.",
     "license": "GPL-3.0-or-later",
     "type": "module",