Cross file reference

Reference to the first header of another file:

\x[not-index]

which renders as:

not the index

Reference to a non-first header of another file:

\x[h2-in-not-the-index]

which renders as:

h2 in not the index

To make toplevel links cleaner, if the target header is the very first element of the other page, then the link does not get a fragment, e.g.: \x[not-index] rendered as:

<a href="not-index"

and not:

<a href="not-index#not-index"

while \x[h2-in-not-the-index] is rendered with the fragment:

<a href="not-index#h2-in-not-the-index"

Reference to the first header of another file that is a second inclusion:

\x[included-by-not-index]

which renders as:

included by not the index

Reference to another header of another file, with full:

\x[h2-in-not-the-index]{full}.

which renders as:

Section "h2 in not the index".

Note that when full is used with references in another file in multi page mode, the number is not rendered as explained at: Section "\x full argument in cross file references".

Reference to an image in another file:

\x[image-not-index-xi]{full}.

which renders as:

Figure "Figure in not the index".

Reference to an image in another file:

\x[image-figure-in-not-the-index-without-explicit-id]{full}.

which renders as:

Figure "Figure in not the index without explicit id".

Remember that the ID of the toplevel header is automatically derived from its file name, that's why we have to use:

\x[not-index]

which renders as:

not the index

instead of:

\x[not-the-index]

Reference to a subdirectory:

\x[subdir]

\x[subdir/h2]

\x[subdir/notindex]

\x[subdir/notindex-h2]

which renders as:

subdir index
h2
subdir/notindex
notindex h2

Implemented at: github.com/ourbigbook/ourbigbook/issues/116

Reference to an internal header of another file: h2 in not the index. By default, That header ID gets prefixed by the ID of the top header.

When using --embed-includes mode, the cross file references end up pointing to an ID inside the current HTML element, e.g.:

<a href="#not-index">

rather than:

<a href="not-index.html/#not-index">

This is why IDs must be unique for elements across all pages.

Table of contents 881 3

 Ancestors (4)

 Incoming links (10)

 Synonyms (1)

Internal cross file reference