Package

laika

render

Permalink

package render

Visibility
  1. Public
  2. All

Type Members

  1. trait FOProperties extends AnyRef

    Permalink

    Mapping of XSL-FO tag names to their supported properties.

    Mapping of XSL-FO tag names to their supported properties. All properties not supported by Apache FOP are omitted.

  2. class FOWriter extends TagWriter with FOProperties

    Permalink

    API for renderers that produce XSL-FO output.

  3. class HTML extends RendererFactory[HTMLWriter]

    Permalink

    A renderer for HTML output.

    A renderer for HTML output. May be directly passed to the Render or Transform APIs:

    Render as HTML from document toFile "hello.html"
    
    Transform from Markdown to HTML fromFile "hello.md" toFile "hello.html"
  4. class HTMLWriter extends TagWriter

    Permalink

    API for renderers that produce HTML output.

  5. class PrettyPrint extends RendererFactory[TextWriter]

    Permalink

    A renderer for PrettyPrint output, primarily useful for debugging purposes.

    A renderer for PrettyPrint output, primarily useful for debugging purposes. May be directly passed to the Render or Transform APIs:

    Render as PrettyPrint from document toString
    
    Transform from Markdown to PrettyPrint fromFile "hello.md" toConsole
  6. abstract class TagWriter extends TextWriter

    Permalink

    Base type for writers that produce tag-based output formats like XML or HTML.

    Base type for writers that produce tag-based output formats like XML or HTML. Extends the base TextWriter and adds methods for writing text with special characters as entities and for conveniently writing tags with attributes.

  7. class TextWriter extends AnyRef

    Permalink

    API for renderers that produce character output.

  8. class XSLFO extends RendererFactory[FOWriter]

    Permalink

    A renderer for XSL-FO output.

    A renderer for XSL-FO output. May be directly passed to the Render or Transform APIs:

    Render as XSLFO from document toFile "hello.fo"
    
    Transform from Markdown to XSLFO fromFile "hello.md" toFile "hello.fo"

    This renderer is usually used as an interim format for producing a PDF, where you do not deal with this format directly. But it can alternatively also be used as the final output and then get processed by external tools.

Value Members

  1. object FOWriter

    Permalink

    Companion providing tree elements specific to the XSL-FO renderer.

    Companion providing tree elements specific to the XSL-FO renderer. These are usually not part of the document AST produced by a parser, but only inserted dynamically during the render process to drive features specific to FO output.

  2. object HTML extends HTML

    Permalink

    The default instance of the HTML renderer.

  3. object PrettyPrint extends PrettyPrint

    Permalink
  4. object XSLFO extends XSLFO

    Permalink

    The default instance of the XSL-FO renderer.

Ungrouped