summaryrefslogtreecommitdiff
path: root/lib/citation/book.mli
diff options
context:
space:
mode:
Diffstat (limited to 'lib/citation/book.mli')
-rw-r--r--lib/citation/book.mli20
1 files changed, 19 insertions, 1 deletions
diff --git a/lib/citation/book.mli b/lib/citation/book.mli
index 0ca229c..4e91c6c 100644
--- a/lib/citation/book.mli
+++ b/lib/citation/book.mli
@@ -30,7 +30,18 @@ val to_string : id -> string
tradition-only targets [sirach]/[revelation] -- see those below. *)
val of_token : string -> id option
-(** Every id this build knows, for coverage checks. *)
+(** Every id surveyed against the EF's own three citation-bearing files
+ (lectionary, sanctoral propers, commons) -- for coverage checks: every
+ SHIPPED language file's [\[bible\]] section is asserted complete over
+ this list (test_lang_coverage.ml). NOT every id {!of_token} can resolve:
+ book.ml's own [of_lectionary_table] adds a further ~25 ids the OF's
+ English-canonical lectionary cites that no EF file ever needed and that
+ no primary EF source attests a Latin title for -- resolvable ([of_token]/
+ {!default_spelling} both cover them) but deliberately excluded here,
+ rather than either fabricating an uncited Latin name or weakening this
+ list's own completeness promise for the ids that DO have one. Such a
+ book still renders, in its own English spelling ({!default_spelling}'s
+ own fallback), never a raw internal id. *)
val all : id list
(** Every accepted spelling paired with its id. *)
@@ -77,3 +88,10 @@ val tradition_of_fields : (string * string) list -> tradition
val unknown_fields : (string * string) list -> string list
val map : tradition -> id -> id
+
+(** Whether [id] names a book with exactly one chapter (Jude, Philemon,
+ 2 John, 3 John), conventionally cited by verse alone with no chapter
+ number ("Jude 17", not "Jude 1:17"). {!Colitur_citation.Parse.parse}
+ consults this to avoid misreading a leading verse number as a chapter
+ -- see book.ml's own citation for the real citation this was found on. *)
+val is_single_chapter : id -> bool