Type Members

1.  case class BookConfig(metadata: DocumentMetadata = DocumentMetadata(), navigationDepth: Option[Int] = None, fonts: Seq[FontDefinition] = Nil, coverImage: Option[Path] = None) extends Product with Serializable

   Captures common configuration element of e-books, used by both EPUB and PDF renderers.

   Captures common configuration element of e-books, used by both EPUB and PDF renderers.

   metadata

   metadata to be embedded in the document in a way that respective reader software can surface

   navigationDepth

   the number of levels to provide navigation structure for

   fonts

   the fonts that should be embedded in the e-book output

   coverImage

   the path to the cover image within the virtual document tree

2.  sealed abstract class Color extends AnyRef

   Represent a color value in a format compatible with CSS.

   Represent a color value in a format compatible with CSS.

   Use the constructors of the companion for creating instances.

3.  sealed trait CrossOrigin extends AnyRef
4.  sealed trait EmbeddedFont extends AnyRef

   Base trait for the types of embedded fonts Laika supports, which are either a file-system or classpath resource.

5.  case class EmbeddedFontFile(file: FilePath) extends EmbeddedFont with Product with Serializable

   Represent a font resource from the file system.

6.  case class EmbeddedFontResource(name: String) extends EmbeddedFont with Product with Serializable

   Represent a font files as a classpath resource.

7.  case class Font extends Product with Serializable

   Represents a font resource, either based on a local classpath or file system resource, or a web font URL, or both.

   Represents a font resource, either based on a local classpath or file system resource, or a web font URL, or both.

   E-book formats like EPUB or PDF require a local font file to be available for embedding. A web font URL can only be used for website generation.

8.  case class FontDefinition(resource: Font, family: String, weight: FontWeight, style: FontStyle) extends Product with Serializable

   Represent a full font definition, combining the font resource (file and/or web URL) plus the mapping to a family name, font weight and style.

   Represent a full font definition, combining the font resource (file and/or web URL) plus the mapping to a family name, font weight and style.

   When providing multiple different weights and styles for the same font, a separate FontDefinition instance needs to be built for each of them.

9.  sealed abstract class FontStyle extends AnyRef

   Enumeration for the valid font styles that can be assigned to a font resource, compatible with CSS properties.

10.  sealed abstract class FontWeight extends AnyRef

    Enumeration for the valid font weights that can be assigned to a font resource, compatible with CSS properties.

11.  sealed abstract class ScriptAttributes extends AnyRef

    Configuration API for specifying attributes to set for script tags in conjunction with the Helium API for script includes.

12.  sealed abstract class StyleAttributes extends AnyRef

    Configuration API for specifying attributes to set for script tags in conjunction with the Helium API for script includes.