SelectionConfig

laika.rewrite.nav.SelectionConfig

See theSelectionConfig companion object

case class SelectionConfig(name: String, choices: Type[ChoiceConfig], separateEbooks: Boolean)

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.

Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Returns the label of the choice with the specified name, if present.

Returns a copy of this instance where the specified choice is marked as selected.

Specifies that the choices of this selection should be rendered in entirely separate e-books and not below each other in the same output.

In this article

Generated with