diff options
| author | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-08-18 09:26:26 +0200 |
|---|---|---|
| committer | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-08-18 09:26:26 +0200 |
| commit | 051716cdee0197351fa966af1e13738c443045c4 (patch) | |
| tree | 4dc769f43cd17406f449c5c6ad2c024abebc77c7 /man | |
| parent | 4fc8afc45a7371fdfe32f0683f7f0e26ab766faa (diff) | |
| download | colitur-051716cdee0197351fa966af1e13738c443045c4.tar.gz colitur-051716cdee0197351fa966af1e13738c443045c4.zip | |
feat(data): ship a worked example overlay calendar
`--overlay` shipped last week with nothing to point at. The only example
was a test fixture, explicitly labelled invented and living where no user
would find it, so "colitur supports local calendars" was true but
undemonstrated.
data/ef/examples/diocesan-example.sexp is installed to
<prefix>/share/colitur/examples/ and is runnable documentation: every
celebration in it is invented, with example- slugs that cannot collide,
and its header explains the four directives, the three date shapes, and
the field vocabularies before showing any of them.
It demonstrates the range deliberately rather than the minimum: a
fixed-date local patron with its own propers; a movable dedication on the
first Sunday of October, I class because a church's own dedication
anniversary is I class in that church and at III it would lose to the
Sunday every year; an Easter-relative commemoration; an Edit raising a
universal feast for local use; and a Suppress shown commented out,
because suppressing a universal feast is a real liturgical act and an
example should not invite it casually.
Two things the header says plainly, since this is the one file that lets
someone change what colitur computes: an overlay is applied ON TOP of the
shipped calendar and never instead of it, and an overlay is applied, NOT
validated -- the five test layers assert things about the shipped data
and cannot vouch for a user's file.
A test asserts it loads against the real EF rank vocabulary, still
demonstrates at least four directives, and applies with NO diagnostics.
The last matters most: a directive naming a slug the universal calendar
lacks would warn, and an example that warns teaches the wrong lesson. It
deliberately does not pin which days it produces -- those celebrations
are invented, and pinning their dates would make an illustrative file
behave like calendar data.
Diffstat (limited to 'man')
| -rw-r--r-- | man/colitur.1 | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/man/colitur.1 b/man/colitur.1 index a18b299..8a52858 100644 --- a/man/colitur.1 +++ b/man/colitur.1 @@ -160,8 +160,15 @@ in days, or an .I Nth_weekday of a month \(em so a patronal feast on "the first Sunday of October" or a dedication anniversary reckoned from Easter are both expressible. See -.I test/fixtures/overlay\-example\-diocesan.sexp -in the source distribution for a worked example of both shapes. +.I <prefix>/share/colitur/examples/diocesan\-example.sexp +for a worked, runnable example of all four directives and all three date +shapes: +.RS +.nf + +.B colitur day 2026 \-\-overlay <prefix>/share/colitur/examples/diocesan\-example.sexp +.fi +.RE .PP Accepted on .B day @@ -199,6 +206,10 @@ mode this program refuses. The installed calendar data: the sanctoral calendar, its one hand\-authored overlay, the temporal lectionary and the Commons. Four S\-expression files. .TP +.I <prefix>/share/colitur/examples/diocesan\-example.sexp +A worked example overlay, shipped as runnable documentation. Every +celebration in it is invented; copy it and put your own calendar in its place. +.TP .I <exedir>/../data/ef/ The build\-tree location, used when running from a source checkout. .PP |
