PDFNavigation

laika.render.pdf.PDFNavigation$

Prepares a document tree for the PDF rendering step by inserting PDF bookmark elements.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Concrete methods

def generateBookmarks[F[_]](result: RenderedTreeRoot[F], depth: Option[Int]): Map[String, Element]

Generates bookmarks for the structure of the DocumentTree.

Generates bookmarks for the structure of the DocumentTree.

Individual bookmarks can stem from tree or subtree titles, document titles or document sections, depending on which recursion depth is configured. The configuration key for setting the recursion depth is pdf.bookmarks.depth.

Attributes

depth

the recursion depth through trees, documents and sections

result

the rendered result tree to generate bookmarks for

Returns:

a fragment map containing the generated bookmarks