A verse ref and a location in USJ space that point to a specific location in USJ. The location in
USJ space should be interpreted as starting from either the start of the book or the chapter
depending on the type of location used.
The USFM representation of the positions represented by this type are UsfmVerseLocation.
The locations in USJ space are specified as UsjDocumentLocations, which, on their own, are
relative to a specific USJ document. However, the other information in this type specifies which
USJ document the document location is relative to, meaning this location is an absolute verse
reference location.
The JSONPaths in these USJ-based locations are specified relative to the following USJ documents:
UsjBookLocation - a USJ document that contains the entire specified book. The first
content entry of the top-level USJ marker is the id marker of the book.
UsjChapterLocation - a USJ document that contains only the specified chapter in the
specified book. If the chapter number is 1, the first content entry of the top-level USJ
marker is the id marker of the book because the intro content before chapter 1 is part of
chapter 1. If the chapter number is greater than 1, the first content entry of the top-level
USJ marker is the c marker of the chapter.
This type intends to represent USFM positions (UsfmVerseLocation) in USJ space. However,
there are some USFM positions that are not currently representable with these types; see
UsjDocumentLocation for more information.
You can specify a particular kind of UsjDocumentLocation in the generic type
TDocumentLocation, and that will narrow documentLocation to that specific kind of location.
A verse ref and a location in USJ space that point to a specific location in USJ. The location in USJ space should be interpreted as starting from either the start of the book or the chapter depending on the type of location used.
The USFM representation of the positions represented by this type are UsfmVerseLocation.
The locations in USJ space are specified as UsjDocumentLocations, which, on their own, are relative to a specific USJ document. However, the other information in this type specifies which USJ document the document location is relative to, meaning this location is an absolute verse reference location.
The JSONPaths in these USJ-based locations are specified relative to the following USJ documents:
USJmarker is theidmarker of the book.USJmarker is theidmarker of the book because the intro content before chapter 1 is part of chapter 1. If the chapter number is greater than 1, the first content entry of the top-levelUSJmarker is thecmarker of the chapter.This type intends to represent USFM positions (UsfmVerseLocation) in USJ space. However, there are some USFM positions that are not currently representable with these types; see UsjDocumentLocation for more information.
You can specify a particular kind of
UsjDocumentLocationin the generic typeTDocumentLocation, and that will narrowdocumentLocationto that specific kind of location.