levineuwirth.org/build/Patterns.hs

152 lines
6.3 KiB
Haskell

{-# LANGUAGE GHC2021 #-}
{-# LANGUAGE OverloadedStrings #-}
-- | Canonical content-pattern definitions, shared across modules.
--
-- Several modules need to enumerate "all author-written content" or
-- "all essays". Historically each module hard-coded its own slightly
-- different list, which produced silent omissions (e.g. directory-form
-- essays not appearing on author pages). This module is the single source
-- of truth — every place that needs a content pattern should import from
-- here, not write its own.
module Patterns
( -- * Per-section patterns
essayPattern
, draftEssayPattern
, blogPattern
, poetryPattern
, fictionPattern
, musicPattern
, photographyPattern
, allPhotoEntries
, standalonePagesPattern
-- * Aggregated patterns
, allWritings -- essays + blog + poetry + fiction
, allContent -- everything that backlinks should index
, authorIndexable -- everything that should appear on /authors/{slug}/
, tagIndexable -- everything that should appear on /<tag>/
) where
import Hakyll
-- ---------------------------------------------------------------------------
-- Per-section
-- ---------------------------------------------------------------------------
-- | All published essays — flat files and directory-based (with co-located
-- assets). Drafts under @content/drafts/essays/**@ are intentionally NOT
-- included; 'Site.rules' unions them in conditionally when @SITE_ENV=dev@.
essayPattern :: Pattern
essayPattern = "content/essays/*.md" .||. "content/essays/*/index.md"
-- | In-progress essay drafts. Matches the flat and directory forms under
-- @content/drafts/essays/@. Only 'Site.rules' consumes this, gated on
-- @SITE_ENV=dev@ — every other module that enumerates content (Authors,
-- Tags, Backlinks, Stats, feeds) sees only 'essayPattern', so drafts are
-- automatically invisible to listings, tags, authors, backlinks, and stats.
draftEssayPattern :: Pattern
draftEssayPattern =
"content/drafts/essays/*.md"
.||. "content/drafts/essays/*/index.md"
-- | All blog posts. Currently flat-only; co-located blog assets would
-- require a directory variant analogous to 'essayPattern'.
blogPattern :: Pattern
blogPattern = "content/blog/*.md"
-- | All poetry: flat poems plus collection poems, excluding collection
-- index pages (which are landing pages, not poems).
poetryPattern :: Pattern
poetryPattern =
"content/poetry/*.md"
.||. ("content/poetry/*/*.md" .&&. complement "content/poetry/*/index.md")
-- | All fiction. Currently flat-only.
fictionPattern :: Pattern
fictionPattern = "content/fiction/*.md"
-- | Music compositions (landing pages live at @content/music/<slug>/index.md@).
musicPattern :: Pattern
musicPattern = "content/music/*/index.md"
-- | All photo entries — flat singles plus directory-form entries.
--
-- Phase 1 supports two shapes:
-- * flat: @content/photography/<slug>.md@
-- * directory: @content/photography/<slug>/index.md@
--
-- The section landing page at @content/photography/index.md@ is
-- excluded; it routes via 'Site.rules' as the catalog landing
-- (analogous to @content/music/index.md@), not as a photo entry.
--
-- Phase 5 will extend this pattern with collection-photo files
-- (@content/photography/<series>/<photo>.md@) when series support
-- lands; until then directory-form @index.md@ files are treated as
-- single-photo entries (a series is just a directory with siblings).
photographyPattern :: Pattern
photographyPattern =
("content/photography/*.md" .&&. complement "content/photography/index.md")
.||. "content/photography/*/index.md"
-- | Every photographic entry, including children of series. Distinct
-- from 'photographyPattern' (which enumerates only top-level entries
-- and series landings) for surfaces that should enumerate every
-- photograph individually:
--
-- * @/photography/by-year/<year>/@ — one frame per file
-- * @/photography/contact-sheet/@ — every frame in the roll
-- * @/photography/map.json@ — one pin per geotagged photo
-- * @/photography/feed.xml@ — one entry per shot
-- * Tag indexes — siblings have their own tags
--
-- The main @/photography/@ landing and the library shelf use
-- 'photographyPattern' instead, so a series shows up as a single
-- aggregate card rather than once for the landing plus once per child.
allPhotoEntries :: Pattern
allPhotoEntries =
photographyPattern
.||. ("content/photography/*/*.md" .&&. complement "content/photography/*/index.md")
-- | Top-level standalone pages (about, colophon, current, gpg, …) and
-- the curated routing pages under @content/cv/@ (which render with the
-- same @templates/page.html@ pipeline and need the same backlink and
-- content-indexing treatment).
standalonePagesPattern :: Pattern
standalonePagesPattern = "content/*.md" .||. "content/cv/*.md"
-- ---------------------------------------------------------------------------
-- Aggregations
-- ---------------------------------------------------------------------------
-- | All long-form authored writings.
allWritings :: Pattern
allWritings = essayPattern .||. blogPattern .||. poetryPattern .||. fictionPattern
-- | Every content file the backlinks pass should index. Includes music
-- landing pages and top-level standalone pages, in addition to writings.
allContent :: Pattern
allContent =
essayPattern
.||. blogPattern
.||. poetryPattern
.||. fictionPattern
.||. musicPattern
.||. standalonePagesPattern
-- | Content shown on author index pages — essays + blog posts.
-- (Poetry and fiction have their own dedicated indexes and are not
-- aggregated by author.)
authorIndexable :: Pattern
authorIndexable = (essayPattern .||. blogPattern) .&&. hasNoVersion
-- | Content shown on tag index pages — essays + blog posts + every
-- photographic entry (including sibling photos in series).
-- Photography sub-tags (@photography/landscape@, @photography/film@,
-- …) generate proper @/<sub-tag>/@ pages from this pattern; the
-- bare @photography@ top-level tag is filtered out in
-- 'Tags.getExpandedTags' to avoid colliding with the section
-- landing's route at @/photography/@.
tagIndexable :: Pattern
tagIndexable =
(essayPattern .||. blogPattern .||. allPhotoEntries)
.&&. hasNoVersion