RenderGatheredOutput
Related Doc:
package Render
the processor that merges the results from the individual render operations into a single output
the configuration for the render operation
The output operations that can be performed for a single input document.
The output operations that can be performed for a single input document.
The concrete implementation of the abstract Render type.
The concrete implementation of the abstract Render type.
The output operations that can be performed for an entire tree of input documents.
The output operations that can be performed for an entire tree of input documents.
The current configuration for this instance.
The current configuration for this instance.
Specifies the document tree to render.
Specifies the document tree to render.
the document tree to render
a new BatchOperation instance that allows to specify the outputs
Specifies the document to render.
Specifies the document to render.
the document to render
a new Operation instance that allows to specify the output
Specifies the element to render.
Specifies the element to render. This may be a RootElement instance
as well as any other type of Element, thus allowing to render document
fragments, too.
a new Operation instance that allows to specify the output
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the specified level of parallelism.
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the specified level of parallelism.
The recursive structure of document trees will be flattened before parsing and rendering and then get reassembled afterwards, therefore the parallel processing includes all subtrees of the document tree.
The actual transformation is a three phase process, the first (parsing) and third (rendering) can run in parallel. The second phase in the middle cannot, as this is the document tree model rewrite step where things like cross references or table of contents get processed that need access to more than just the current document.
the number of batches to be executed in parallel, 1 means sequential execution
the minimum number of operations required for parallel execution
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the default level of parallelism which corresponds to the number of CPUs.
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the default level of parallelism which corresponds to the number of CPUs.
The recursive structure of document trees will be flattened before parsing and rendering and then get reassembled afterwards, therefore the parallel processing includes all subtrees of the document tree.
The actual transformation is a three phase process, the first (parsing) and third (rendering) can run in parallel. The second phase in the middle cannot, as this is the document tree model rewrite step where things like cross references or table of contents get processed that need access to more than just the current document.
Renders the specified document tree to the given output.
Renders the specified document tree to the given output.
the tree to render
the output tree to render to
Renders the specified element to the given output.
Renders the specified element to the given output.
the element to render
the output to render to
the styles to apply to the elements during the render process
Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.
Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.
This method expects a function that returns a partial function as the result. The outer function allows to capture the writer instance to write to and will only be invoked once. The partial function will then be invoked for each element it is defined at.
Simple example for customizing the HTML output for emphasized text, adding a specific style class:
Transform from Markdown to HTML rendering { out =>
{ case Emphasized(content) => out << """<em class="big">""" << content << "</em>" }
} fromFile "hello.md" toFile "hello.html"
Renders without any formatting (line breaks or indentation).
Renders without any formatting (line breaks or indentation). Useful when storing the output in a database for example.
Returns a new instance with the specified extension bundles installed.
Returns a new instance with the specified extension bundles installed. Features in the new bundles may override features in already installed bundles.
Bundles are usually provided by libraries (by Laika itself or a 3rd-party extension library) or as re-usable building blocks by application code.
Returns a new instance with the specified configuration.
Returns a new instance with the specified configuration.
This method discards any previously specified options. It is usually meant to be used when copying over the configuration from a fully configured object to an unconfigured one.
Specifies the minimum required level for a system message to get included into the output by this renderer.
Specifies the minimum required level for a system message to get included into the output by this renderer.
(Since version 0.9.0) renamed to rendering for consistency
A render operation that gathers input from one or more input documents in an input tree structure to be rendered to a single output destination.
This is necessary for formats like PDF, where the output will be contained in a single file, but the input can still be conveniently organized in a full directory structure.