aboutsummaryrefslogtreecommitdiff
path: root/lib/render/view.mli
blob: d271641b9cb726f8ba63f5aeecc98353a536e555 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
(** Shapes a civil year of resolved days into the value a template renders
    against (spec section 4).

    This layer exists because a month grid needs leading blank cells, week
    bucketing and an "is this cell in the current month" test, and a logic-less
    template can compute none of it. Shaping the data here keeps the engine
    logic-less AND makes the grid template trivial. The view model IS the design.

    Both [weeks] and [days] are offered at every level: the booklet walks
    [days], the grid walks [weeks]. One model, two artefacts, no second code
    path that could drift.

    Colours are exposed as six booleans rather than a hex string: hex would bake
    a presentation policy into the engine, and LaTeX, groff and HTML each want a
    different colour expression. Exactly one of the six is true on every day. *)

val of_days :
  lang:Colitur_naming.Lang.t ->
  sigla:Colitur_citation.Sigla.t ->
  vocab:('s, 'r) Colitur_kernel.Vocab.t ->
  rite:string ->
  year:int ->
  ('s, 'r) Colitur_kernel.Liturgical_day.t list ->
  Template.value
(** [of_days ~lang ~sigla ~vocab ~rite ~year days] where [days] is one civil
    year, 1 January to 31 December, in order. Pure and total.

    [lang] resolves every display string -- a day's [name], its localised
    [weekday]/[rank_name]/[colour_name]/[season_name], each month's [name],
    and the top-level [term] vocabulary and [weekday_headings]. [name] is a
    PLAIN STRING, not the old lang-keyed object: a dotted [{{name.la}}]
    reference that misses falls back WHOLESALE to the enclosing scope (a
    month's own [name.la]), which is how a printed booklet came to show
    "Ianuarius" in place of a feast with no Latin name. A plain string has no
    dotted path to fall back through, so that hazard is unrepresentable.
    [slug] is untouched by [lang] -- it stays the stable machine key,
    identical between any two calls that differ only in [lang]. Pass
    {!Colitur_naming.Lang.raw} for the pre-naming behaviour, under which
    [name] equals [slug] exactly (this is what CLI [--raw] uses).

    [sigla] resolves the [first]/[gospel] citation fields (Task 9): each
    stored reference is passed through {!Colitur_citation.Sigla.format}
    rather than emitted verbatim. Pass {!Colitur_citation.Sigla.verbatim}
    alongside {!Colitur_naming.Lang.raw} for [--raw] -- a styled [Sigla.t]
    built over [Lang.raw] would still parse and reformat every citation,
    which defeats the byte-exact diffing [--raw] exists for. *)