o

laika.directive.std

NavigationTreeDirectives

object NavigationTreeDirectives

Implementation of the navigationTree directive for templates and markup blocks.

This directive supports the generation of navigation trees which can be any combination of auto-generated trees from the input tree and manual entries, optionally to external targets, too.

For full documentation see the section about the navigationTree Directive in the manual.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NavigationTreeDirectives
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class GeneratedNavigationNode(target: PathBase, title: Option[SpanSequence] = None, depth: Option[Int] = None, excludeRoot: Option[Boolean] = None, excludeSections: Option[Boolean] = None) extends NavigationNodeConfig with Product with Serializable

    The configuration for an automatically generated navigation tree.

    The configuration for an automatically generated navigation tree.

    target

    the target to use as the root node for navigation tree based on a relative or absolute path in the virtual input tree

    title

    the title for this entry when getting rendered as a link

    depth

    the depth to recurse from the root node

    excludeRoot

    indicates whether the root node should be excluded in which case the first-level children will be inserted into the parent node

    excludeSections

    indicates whether sections within documents should be excluded in automatic entries

  2. case class ManualNavigationNode(title: SpanSequence, target: Option[ExternalTarget] = None, children: Seq[NavigationNodeConfig] = Nil) extends NavigationNodeConfig with Product with Serializable

    The configuration for a manual entry in the navigation tree.

    The configuration for a manual entry in the navigation tree. The entry can have further children which may in turn be either manual or automatically generated nodes.

    title

    the title for this entry when getting rendered as a link

    target

    the external link for this node (if missing this node just generates a navigation header as a separator within the tree)

    children

    the children of this node, either manual or automatically generated

  3. case class NavigationBuilderConfig(entries: Seq[NavigationNodeConfig], source: SourceFragment, defaultDepth: Int = Int.MaxValue, itemStyles: Set[String] = Set(), excludeRoot: Boolean = false, excludeSections: Boolean = false, excludeSelf: Boolean = false, options: Options = NoOpt) extends Element with BlockResolver with Product with Serializable

    A block resolver that replaces itself with a navigation list according to this instances configuration.

    A block resolver that replaces itself with a navigation list according to this instances configuration. The resulting navigation tree can either be automatically generated from specified root nodes of the input tree or by specifying entries manually (or a combination of both).

    Serves as the implementation for the navigationTree directive, but can also be inserted into the AST manually.

    entries

    the list of manual and automatic entries to insert into the navigation tree

    source

    the source fragment that produced this navigation builder, for error reporting

    defaultDepth

    the depth for automatically generated entries (unless overridden in the entries' config)

    itemStyles

    the styles to apply to all navigation items in the list as a render hint

    excludeRoot

    indicates whether the root node should be excluded in automatic entries (may be overridden in the entries' config)

    excludeSections

    indicates whether sections within documents should be excluded in automatic entries (may be overridden in the entries' config)

    excludeSelf

    indicates whether the current document should be included

    options

    optional styles and/or an id for the final navigation list

  4. sealed trait NavigationNodeConfig extends AnyRef

    Represents the configuration for a single node in a navigation tree.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. lazy val forBlocks: Blocks.Directive

    Implementation of the navigationTree directive for block elements in markup documents.

  10. lazy val forTemplates: Templates.Directive

    Implementation of the navigationTree directive for templates.

  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. object NavigationBuilderConfig extends Serializable

    Companion with a decoder for obtaining instances from HOCON.

  23. object NavigationNodeConfig

    Companion with a decoder for obtaining instances from HOCON.

Inherited from AnyRef

Inherited from Any

Ungrouped