package model
- Alphabetic
- Public
- All
Type Members
- case class BinaryInput[F[_]](path: Path, input: Resource[F, InputStream], sourceFile: Option[File] = None) extends Navigatable with Product with Serializable
-
case class
BinaryOutput[F[_]](path: Path, resource: Resource[F, OutputStream]) extends Product with Serializable
A resource for binary output.
A resource for binary output.
Most renderers write character data, but formats like PDF or EPUB require a binary stream to write to.
-
case class
DirectoryInput(directories: Seq[File], codec: Codec, docTypeMatcher: (Path) ⇒ DocumentType = DocumentTypeMatcher.base, fileFilter: (File) ⇒ Boolean = DirectoryInput.hiddenFileFilter) extends Product with Serializable
A directory in the file system containing input documents for a tree transformation.
A directory in the file system containing input documents for a tree transformation.
The specified
docTypeMatcher
is responsible for determining the type of input (e.g. text markup, template, etc.) based on the (virtual) document path. -
case class
DirectoryOutput(directory: File, codec: Codec) extends TreeOutput with Product with Serializable
A directory as a target for a rendering operation of a document tree.
A directory as a target for a rendering operation of a document tree.
The specified codec will be used for writing all character output.
- sealed trait InputReader extends Product with Serializable
- sealed trait OutputWriter extends Product with Serializable
-
case class
ParsedTree[F[_]](root: DocumentTreeRoot, staticDocuments: Seq[BinaryInput[F]]) extends Product with Serializable
The result of a parsing operation for an entire document tree.
The result of a parsing operation for an entire document tree.
The
DocumentTreeRoot
is the recursive structure of parsed inputs, like markup document, templates or other file types, represented by their AST.The static documents are merely a sequence of unprocessed inputs that have been discovered via directory scanning (or have been passed programmatically). The actual processing of these inputs is left to the render step, which might copy them into a target directory, or embed them into an output format like EPUB.
- case class PureReader(input: String) extends InputReader with Product with Serializable
-
sealed
trait
RenderContent extends Navigatable
A titled, positional element in the tree of rendered documents.
-
case class
RenderedDocument(path: Path, title: Seq[Span], sections: Seq[SectionInfo], content: String) extends RenderContent with Product with Serializable
A single rendered document with the content as a plain string in the target format.
A single rendered document with the content as a plain string in the target format.
The title and section info are still represented as an AST, so they be used in any subsequent step that needs to produce navigation structures.
-
case class
RenderedTree(path: Path, title: Seq[Span], content: Seq[RenderContent], titleDocument: Option[RenderedDocument] = None) extends RenderContent with Product with Serializable
Represents a node of the tree of rendered documents.
Represents a node of the tree of rendered documents.
- path
the full, absolute path of this (virtual) document tree
- title
the title of this tree, either obtained from the title document or configuration
- content
the rendered documents and subtrees in a recursive structure
- titleDocument
the optional title document of this tree
-
case class
RenderedTreeRoot[F[_]](tree: RenderedTree, defaultTemplate: TemplateRoot, config: Config, coverDocument: Option[RenderedDocument] = None, staticDocuments: Seq[BinaryInput[F]] = Nil, sourcePaths: Seq[String] = Nil) extends Product with Serializable
Represents the root of a tree of rendered documents.
Represents the root of a tree of rendered documents. In addition to the recursive structure of documents it holds additional items like static or cover documents, which may contribute to the output of a site or an e-book.
- tree
the recursive structure of documents, usually obtained from parsing text markup
- defaultTemplate
the default template configured for the output format, which may be used by a post-processor
- config
the root configuration of the rendered tree
- coverDocument
the cover document (usually used with e-book formats like EPUB and PDF)
- staticDocuments
the paths of documents that were neither identified as text markup, config or templates, and will potentially be embedded or copied as is to the final output, depending on the output format
- sourcePaths
the paths this document tree has been built from or an empty list if this ast does not originate from the file system
- case class StreamReader(input: Reader, sizeHint: Int) extends InputReader with Product with Serializable
- case class StreamWriter(output: Writer) extends OutputWriter with Product with Serializable
-
case class
TextInput[F[_]](path: Path, docType: TextDocumentType, input: Resource[F, InputReader], sourceFile: Option[File] = None) extends Navigatable with Product with Serializable
Character input for the various parsers of this library.
Character input for the various parsers of this library.
- path
The full virtual path of this input (does not represent the filesystem path in case of file I/O)
- docType
Indicates the type of the document, to distinguish between text markup, templates, configuration and style sheets, which all have a different kind of parser
- input
The resource to read the character input from
- sourceFile
The source file from the file system, empty if this does not represent a file system resource
-
case class
TextOutput[F[_]](path: Path, resource: Resource[F, OutputWriter], targetFile: Option[File] = None) extends Product with Serializable
Character output for the various renderers of this library
Character output for the various renderers of this library
- path
The full virtual path of this input (does not represent the filesystem path in case of file I/O)
- resource
The resource to write the character output to
- targetFile
The target file in the file system, empty if this does not represent a file system resource
-
case class
TreeInput[F[_]](textInputs: Seq[TextInput[F]], binaryInputs: Seq[BinaryInput[F]], sourcePaths: Seq[String] = Nil) extends Product with Serializable
A (virtual) tree of input documents, either obtained from scanning a directory recursively or constructed programmatically (or a mix of both).
A (virtual) tree of input documents, either obtained from scanning a directory recursively or constructed programmatically (or a mix of both).
Even though the documents are specified as a flat sequence, they logically form a tree based on their virtual path.
-
sealed
trait
TreeOutput extends AnyRef
A (virtual) tree of output documents.
Value Members
- object DirectoryInput extends Serializable
- object PureWriter extends OutputWriter with Product with Serializable
-
object
StringTreeOutput extends TreeOutput with Product with Serializable
Instructs the renderer to produce an in-memory representation of the tree of rendered outputs.
- object TextInput extends Serializable
- object TextOutput extends Serializable
-
object
TreeInput extends Serializable
Factory methods for creating
InputCollections
.