summaryrefslogtreecommitdiff
path: root/docs/generation.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-07-18 12:19:40 +0300
committerPaul Buetow <paul@buetow.org>2026-07-18 12:19:40 +0300
commit3c35381b71f992eb7a86552697ea647bb76b68b1 (patch)
tree56e478547e0cb47ac7403304c997846fb3fea8a4 /docs/generation.md
parenta7588bf270ef2c2f6dd2893d0129e526cbf8d89c (diff)
Add DETAILS_PAGE setting to make per-photo details pages optional
Album owners can now set DETAILS_PAGE=no (or pass --no-details) to skip generating each photo's *-details.html EXIF summary page and its "Details" navigation redirects, without touching the normal thumbnail overview, per-photo view pages, EXIF tooltips, or STATS_PAGE, which all stay independently controlled. Every "Details" link (on view pages and stats filter mini-album view pages) and every "-details" redirect stub is gated on the setting so no generated page ever links to a file that was not rendered. Wired the new field through CONFIG_SPECS (registry-driven defaults/validation/print-config/CLI override), the --details/--no-details CLI flags, usage() help, the verbose effective-config log, shuriken.json generation metadata, and the dry-run plan. DETAILS_PAGE=yes (the default) keeps prior output byte-for-byte identical. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Diffstat (limited to 'docs/generation.md')
-rw-r--r--docs/generation.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/generation.md b/docs/generation.md
index 4d29840..126f2bd 100644
--- a/docs/generation.md
+++ b/docs/generation.md
@@ -45,6 +45,20 @@ the site favicon) using the existing `photos` and `blurs` output, so it avoids
reprocessing images and rerendering album pages. It requires `SPLASH_PAGE=yes`;
pass `--random-seed VALUE` when you need a repeatable pick.
+## Details pages
+
+Every photo gets a `*-details.html` page by default: a dedicated view with the
+full EXIF summary table, reachable via the "Details" link on that photo's
+normal view page. Set `DETAILS_PAGE=no` or pass `--no-details` to skip
+generating these pages; the "Details" link (on the normal view pages and, when
+`STATS_PAGE=yes`, on the filter mini-album view pages) is removed along with
+it, so no generated page links to a missing file.
+
+`DETAILS_PAGE=no` only affects the details pages and their links. It does not
+disable the per-photo EXIF tooltip (the `title=""` attribute shown on hover
+over a photo) or `STATS_PAGE`: both stay independently controlled and keep
+working exactly as configured.
+
## Stats site
`shuriken` can also generate a no-JavaScript stats site with EXIF-derived
@@ -97,8 +111,9 @@ metadata records:
* generated photo, thumbnail, and HTML file counts;
* tarball status (included + file);
* effective settings (title, height, thumbheight, maxpreviews, subdivide
- percent, feature percent, image jobs, random seed, shuffle, splash page, stats
- page, original basepath) useful for debugging a published album.
+ percent, feature percent, image jobs, random seed, shuffle, splash page,
+ details page, stats page, original basepath) useful for debugging a published
+ album.
## Favicon