Selects the configuration options available for PDF generation.
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
pdf.type
Members list
Value members
Inherited methods
Attributes
- Inherited from:
- CopyOps (hidden)
Attributes
- Inherited from:
- CopyOps (hidden)
Attributes
- Inherited from:
- CopyOps (hidden)
Specifies one or more cover images for the PDF document.
Specifies one or more cover images for the PDF document.
Multiple cover images are only relevant when the @:select directive is used to generate different versions of the same e-book which can all have their own cover image. See the documentation for the @:select directive in the chapter "Standard Directives" in the manual for details.
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- PDFOps (hidden)
Specifies which font family to use for the body text, for headlines and for inline code and code blocks.
Specifies which font family to use for the body text, for headlines and for inline code and code blocks.
All specified fonts need to be made available for the theme first by using the fontResources method. The body font needs to be available at least as regular, italic, bold and bold italic. The headline font needs to support bold and bold italic. For the code font a regular font weight is sufficient.
Attributes
- Inherited from:
- SingleConfigOps (hidden)
Adds one or more font resources to the theme, either based on a local classpath or file system resource, or a web font URL, or both.
Adds one or more font resources to the theme, 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.
When using this method, all default fonts of the Helium theme will be de-registered.
Attributes
- Inherited from:
- PDFOps (hidden)
Configure the theme's font sizes. Most property names are self-explanatory, the small font is currently only used for footnote references in PDF output.
Configure the theme's font sizes. Most property names are self-explanatory, the small font is currently only used for footnote references in PDF output.
Attributes
- Inherited from:
- SingleConfigOps (hidden)
Allows to override the defaults for Helium's PDF layout.
Allows to override the defaults for Helium's PDF layout.
You can use the constructors found in the LengthUnit companion to create length values, e.g. LengthUnit.px(12). It's usually most convenient to import laika.ast.LengthUnit._ for your configuration code.
Most arguments should be self-explanatory. The keepTogetherDecoratedLines value controls the number of lines for decorated blocks like code examples or callouts that should always be kept on the same page. With a setting of 12 for example only blocks with more than 12 lines are allowed to be split across multiple pages. If you choose very high numbers for this setting you might see pages with a lot of blank space when it has to move a large block to the next page.
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- ColorOps (hidden)
Allows to define a small set of metadata that describes the output.
Allows to define a small set of metadata that describes the output.
In the generated site it will be used to populate the <head> section of the HTML output, for EPUB and PDF it will be used to embed the information into the generated files in a way that the respective readers understand.
When using the sbt plugin the title, description and version metadata will be pre-populated by the standard sbt settings name, description and version respectively. When using the library API no medata will be defined by default. It is recommended to always define the language and title as the minimum set of metadata.
Value parameters
- authors
-
one or more author names
- dateModified
-
the modification date as a UTC date-time
- datePublished
-
the publication date as a UTC date-time
- description
-
a short description of the site and/or e-book
- identifier
-
a unique identifier for the e-book, not used for site generation
- language
-
the language of the site and/or e-book, should always be defined
- title
-
the title of the site and/or e-book
- version
-
the version string for the output
Attributes
- Inherited from:
- SingleConfigOps (hidden)
The navigation depth of the main navigation structure provided to the PDF reader.
The navigation depth of the main navigation structure provided to the PDF reader.
This is a navigation structure that will usually be displayed in a separate pane by PDF reader software. For including a table of content right in the page flow, so that is also available when printing the document, see the tableOfContent method.
The depth value counts all elements that form the hierarchy, directories, documents and sections within documents.
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- ColorOps (hidden)
Adds a dedicated page for a table of content, in addition to the reader-native navigation structure.
Adds a dedicated page for a table of content, in addition to the reader-native navigation structure.
Value parameters
- depth
-
the navigation depth which may be different than the one for the reader-native navigation structure
- title
-
the title to display on the page and in navigation that links to the page
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- ColorOps (hidden)
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- PDFOps (hidden)
Attributes
- Inherited from:
- PDFOps (hidden)