laika-core
API
Generated with
laika-core/laika/laika.rewrite/laika.rewrite.nav

laika.rewrite.nav

package laika.rewrite.nav

Members list

Type members

Classlikes

case class AutonumberConfig(documents: Boolean, sections: Boolean, maxDepth: Int)

Configuration for autonumbering of documents and sections.

Configuration for autonumbering of documents and sections.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AutonumberConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ChoiceConfig(name: String, label: String, selected: Boolean)

Configuration for a single choice within a selection.

Configuration for a single choice within a selection.

Value parameters

label

the label to be used on tabs or on download pages describing this choice

name

the name of the selection as used in text markup, e.g. @:choice(name).

selected

indicates whether this choice is one of the selected choices in the current render operation

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChoiceConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Classifiers(value: Seq[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ConfigurationException(msg: String) extends RuntimeException

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class CoverImage(path: Path, classifier: Option[String])

Configuration for a cover image for e-books (EPUB or PDF).

Configuration for a cover image for e-books (EPUB or PDF).

The optional classifier can be used if the @:select directive is used to produce multiple e-books with slightly different content. The classifier would refer to the name of the configured choice, or in case of multiple choices, to the combination of their names concatenated with -.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CoverImage

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CoverImage.type
case class CoverImages(default: Option[Path], classified: Map[String, Path])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CoverImages

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object NavigationOrder

Responsible for applying the navigation order to the contents of a document tree, either based on user-specified configuration or by the alphabetical order of the names of the documents and subtrees.

Responsible for applying the navigation order to the contents of a document tree, either based on user-specified configuration or by the alphabetical order of the names of the documents and subtrees.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object NoOpPathTranslator extends PathTranslator

Path translator implementation that returns all paths unmodified.

Path translator implementation that returns all paths unmodified.

Used in scenarios where only a single document gets rendered and there is no use case for cross references or static or versioned documents.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class PathAttributes(isStatic: Boolean, isVersioned: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait PathTranslator

Translates paths of input documents to the corresponding output path. The minimum translation that usually has to happen is to replace the suffix from the input document the path has been obtained from to the suffix of the output format. Further translations are allowed to happen based on user configuration.

Translates paths of input documents to the corresponding output path. The minimum translation that usually has to happen is to replace the suffix from the input document the path has been obtained from to the suffix of the output format. Further translations are allowed to happen based on user configuration.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NoOpPathTranslator.type
object PathTranslator

Builders that apply additional functionality to existing path translator instances.

Builders that apply additional functionality to existing path translator instances.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object PrettyURLs extends ExtensionBundle

Extension specific to site rendering that translates the output path, producing "pretty URLs" that do not contain the html file suffix.

Extension specific to site rendering that translates the output path, producing "pretty URLs" that do not contain the html file suffix.

A path like foo/bar.html for example would be translated to foo/bar/index.html so that links can be simply rendered as foo/bar/.

When the render format is anything other than HTML, this extension has no effect.

The extension can be added to a transformer like any other extension:

val transformer = Transformer
 .from(Markdown)
 .to(HTML)
 .using(GitHubFlavor)
 .using(SyntaxHighlighting)
 .using(PrettyURLs)
 .build

or via the laikaExtensions setting when using the sbt plugin:

 laikaExtensions += PrettyURLs

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
PrettyURLs.type
sealed trait Scope

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object All.type
object Documents.type
object None.type
object Sections.type
object Scope

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Scope.type
object SectionBuilder extends RewriteRulesBuilder

Rewrite rules responsible for building the section structure of a document based on the header elements it contains and their level.

Rewrite rules responsible for building the section structure of a document based on the header elements it contains and their level.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class SelectionConfig(name: String, choices: Type[ChoiceConfig], separateEbooks: Boolean)

Configuration for a single kind of selection and its choices available for the user.

Configuration for a single kind of selection and its choices available for the user.

Value parameters

choices

the configuration for one or more choices that are available in each of the directives

name

the name of the selection as used in text markup, e.g. @:select(name).

separateEbooks

whether the selection should render all its choices in the same output or produce separate e-books where in each of them only one of the choice is displayed. This way separate e-books for Scala vs. Java code samples or sbt vs. Maven build examples can be produced. Keep in mind that multiple selections having this property set to true would result in the cartesian product of available e-book versions, it is therefore unusual to have more than one or two.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SelectionConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Selections(selections: Seq[SelectionConfig])

Groups configuration for multiple @:select directives.

Groups configuration for multiple @:select directives.

The @:select directive is a special directive that allows to create alternative versions of the same documentation, for example one with Scala code examples and one with Java. Or as in the case of Laika's own documentation, one showing configuration setup with sbt and the other through the library API.

When using the default Helium theme these alternatives will be rendered as tabs in the website.

While for EPUB and PDF output it triggers the generation of separate books for each of the alternatives and offers them on the download page to cater for the fact that tabs do not work well on paper.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Selections

Companion for creating selection config instances that can be passed to Laika configuration and builders that produce configuration of all possible combinations of @:select directives.

Companion for creating selection config instances that can be passed to Laika configuration and builders that produce configuration of all possible combinations of @:select directives.

See the documentation for the @:select directive in the manual for the full context of this feature.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Selections.type
sealed trait TargetFormats

Describes the supported target (output) formats of a resource.

Describes the supported target (output) formats of a resource.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object All.type
object None.type
class Selected
object TargetFormats

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object TitleDocumentConfig

Configuration for the names of title documents in the input and output trees.

Configuration for the names of title documents in the input and output trees.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Deprecated classlikes

case class BasicPathTranslator(outputSuffix: String) extends PathTranslator

Attributes

Deprecated
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with