#lang scribble/manual
@; SPDX-License-Identifier: BlueOak-1.0.0
@; This file is licensed under the Blue Oak Model License 1.0.0.
@(require "scribble-helpers.rkt")
@(require (for-label "../pollen.rkt"
"../crystalize.rkt"
"../cache.rkt"
racket/base
racket/contract
racket/string
txexpr
pollen/core
pollen/pagetree))
@title[#:tag "crystalize-rkt"]{Crystalize}
@defmodule["crystalize.rkt" #:packages ()]
“Crystalizing” is an extra layer in between docs and templates that destructures the @tt{doc} and
stores it in various pieces in a SQLite cache. Individual articles save chunks of rendered HTML to
the cache when their individual pages are rendered. When pulling together listings of articles in
different contexts that need to be filtered and sorted, a SQL query is much faster than trolling
through the Pollen cache for matching docs and regenerating the HTML.
@margin-note{These functions are designed to be used within templates, so that the rows in the cache
database for a page are updated right when that web page is rendered.}
@defproc[(parse-and-cache-article! [pagenode pagenode?] [doc txexpr?])
(values non-empty-string? non-empty-string?)]{
Returns two values: the “plain” title of the article, and a string containing the full HTML of
@racket[_doc], in that order.
The title is returned separately for use in the HTML @tt{<title>} tag. If the @racket[_doc] doesn’t
specify a title, a provisional title is constructed using @racket[default-title].
Privately, it does a lot of other work. The article is analyzed, additional metadata is constructed
and saved to the SQLite cache and saved using @racket[make-cache:article]. If the article specifies
a @racket['series] meta, information about that series is fetched and used in the rendering of the
article. If there are @racket[note]s or @racket[index] tags in the doc, they are parsed and saved
individually to the SQLite cache (using @racket[make-cache:note] and
@racket[make-cache:index-entry]). If any of the notes use the @code{#:disposition} attribute,
information about the disposition is parsed out and used in the rendering of the article.
}
@defproc[(cache-index-entries-only! [title string?] [page pagenode?] [doc txexpr?]) void?]{
Saves only the @racket[index] entres in @racket[_doc] to the cache database, so that they appear in
the keyword index.
This function allows pages that are not @tech{articles} to have their own keyword index entries, and
should be used in the templates for such pages.
As a side effect of calling this function, a minimal @racket[cache:article] is created for the page
with its @racket['conceal] meta set to @racket{all}, to exclude it from any listings.
}
