aboutsummaryrefslogtreecommitdiff
path: root/lib/citation/book.mli
diff options
context:
space:
mode:
Diffstat (limited to 'lib/citation/book.mli')
-rw-r--r--lib/citation/book.mli21
1 files changed, 16 insertions, 5 deletions
diff --git a/lib/citation/book.mli b/lib/citation/book.mli
index dd04e0d..8918bc3 100644
--- a/lib/citation/book.mli
+++ b/lib/citation/book.mli
@@ -15,11 +15,19 @@ val to_string : id -> string
(** Resolve one spelling as it appears in the data. Returns [None] for
anything not in {!tokens}.
- SEVEN books arrive in two spellings ([Isa]/[Isa.], [3 Kgs.]/[3 Kings],
- and five more). That inconsistency is INHERITED from lectio's own ini,
- which is itself generated from missalemeum/Divinum Officium -- it is not
- a colitur transcription error, and the data is deliberately left
- untouched. Both spellings resolve here instead. *)
+ SIXTEEN books arrive in more than one spelling, surveyed across all
+ three citation-bearing files ([lectionary.sexp], [sanctoral.sexp],
+ [commons.sexp] -- not the lectionary alone, which undercounts: the
+ sanctoral propers alone carry more citations than the lectionary does).
+ Most are a dotted/undotted pair ([Isa]/[Isa.], [3 Kgs.]/[3 Kings], and
+ others); two also carry a MODERN spelling sitting inside otherwise-
+ Vulgate data ([Sir] alongside [Ecclus]/[Eccli], [Rev] alongside [Apoc]).
+ All of this is INHERITED from lectio's own ini, which is itself
+ generated from missalemeum/Divinum Officium -- it is not a colitur
+ transcription error, and the data is deliberately left untouched. Every
+ accepted spelling resolves here to the same, single Vulgate id: [Sir]
+ resolves to [ecclesiasticus] and [Rev] to [apocalypse], never to the
+ tradition-only targets [sirach]/[revelation] -- see those below. *)
val of_token : string -> id option
(** Every id this build knows, for coverage checks. *)
@@ -44,6 +52,9 @@ val vulgate : tradition
{!unknown_fields} to report them. *)
val tradition_of_fields : (string * string) list -> tradition
+(** The fields {!tradition_of_fields} silently dropped -- either side naming
+ an id outside {!all}. Never raises; a caller that cares can report these,
+ a caller that does not can ignore the return value entirely. *)
val unknown_fields : (string * string) list -> string list
val map : tradition -> id -> id