Packages

p

laika

render

package render

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. class FOforPDF extends AnyRef

    Responsible for rendering the XSL-FO for an entire document tree as an interim result to be consumed by the PDF post processor.

    Responsible for rendering the XSL-FO for an entire document tree as an interim result to be consumed by the PDF post processor.

    On top of the regular XSL-FO renderer in laika-core this renderer inserts tree titles, bookmarks and a table of contents into the document tree before rendering.

  2. class PDF extends RenderResultProcessor[FOWriter]

    A post processor for PDF output, based on an interim XSL-FO renderer.

    A post processor for PDF output, based on an interim XSL-FO renderer. May be directly passed to the Render or Transform APIs:

    val document: Document = ...
    Render as PDF from document toFile "hello.pdf"
    
    Transform from Markdown to PDF fromDirectory "book-src" toFile "book.pdf"

    In the second example above the input from an entire directory gets merged into a single output directory.

  3. case class PDFConfig(insertTitles: Boolean = true, bookmarkDepth: Int = Int.MaxValue, tocDepth: Int = Int.MaxValue, tocTitle: Option[String] = None) extends Product with Serializable

    Configuration options for the generated PDF output.

    Configuration options for the generated PDF output.

    insertTitles

    indicates whether a title will be inserted for each tree, subtree, and document, relying on titles specified in the configuration file for the tree or document, but only if there is no Title element in the document already

    bookmarkDepth

    the number of levels bookmarks should be generated for, use 0 to switch off bookmark generation

    tocDepth

    the number of levels to generate a table of contents for, use 0 to switch off toc generation

    tocTitle

    the title for the table of contents

Value Members

  1. object FOforPDF extends FOforPDF

    The default FOforPDF instance using a PDFConfig with all optional features like document titles, bookmarks and table of content enabled.

  2. object PDF extends PDF

    The default instance of the PDF renderer.

  3. object PDFConfig extends Serializable

    Companion for the creation of PDFConfig instances.

Ungrouped