Docbooks support an enhanced cross-referencing among
docbook collections, using a link style called "olink".
Olinks allow cross-referencing and
hyperlinking among documents, using extra saved information about the
target document (being linked to, as contrasted with plain href style
links, which only have the link url). For instance, in PDFs, there's
extra info enabling the referring doc to say "page 123 in document abc".
For PDF and HTML, olinks allow the referring text to include a hyperlink
which includes target document's element title, and maybe a number (if it
has numbered items - such as our chapter / section numbers in the main
UIMA documentation). So you can get a link that looks like this:
where the 1.5.1 was generated by docbook processing, and the "Annotator
Methods" was the title of that section.
- see Section 1.5.1, ?Annotator Methods?
To make olinks work, each time a docbook is processed, an extra database
of info for that docbook is created, containing just the things needed for
this. This database, together with some other data about how the
multiple interlinking docbooks are arranged, is then
used when processing a docbook.
Olink data for all UIMA docbooks is stored in one additional project,
uima-docbook-olink, that has an attached artifact: a zip file of all
This project is at the level 1-SNAPSHOT, and will stay there.
Because it's a snapshot, it is updated whenever it is "deployed".
Each docbook processing run updates that docbook's olink data.
Committers should deploy the snapshot to share updates of olink
data with others.