OurBigBook Docs
Makes includes render the included content in the same output file as the include is located, instead of the default behaviour of creating links.
For example given:
index.bigb
= Index
\Include[notindex]notindex.bigb
= Notindex
A paragraph in notindex.
== Notindex 2then for conversion with:then the output
ourbigbook --embed-includes index.bigbindex.html contains an output equivalent to if your input file were:= Index
== Notindex
A paragraph in notindex.
=== Notindex 2Note that a prior ID extraction pass is not required,
--embed-includes just makes \Include read files as they are found in the source.In addition to this:
- cross file internal links outside the included files are disabled, and the cross file ID database does not get updated.It should be possible to work around this, but we are starting with the simplest implementation that forbids it. TODO at: github.com/ourbigbook/ourbigbook/issues/343The problem those cause is that the IDs of included headers show as duplicate IDs of those in the ID database.This should be OK to start with because the more common use case with
--html-single-pageis that of including all headers in a single document. TODO: this option is gone.
Otherwise,
include only adds the headers of the other file to the table of contents of the current one, but not the body of the other file. The ToC entries then point to the headers of the included external files.You may want to use this option together with
--embed-resources to produce fully self-contained individual HTML files for your project.