laika-core/laika.ast/PathReference

PathReference

trait PathReference extends Reference

A reference to content within the virtual input tree, the path pointing to the source path. Only part of the unresolved document tree and then removed by the rewrite rule that replace the source path with the final target path of the output document, which might differ in more than just the file suffix, depending on configuration.

trait Reference
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Type members

Inherited types

type Self <: Reference
Inherited from:
Reference

Value members

Abstract methods

def path: VirtualPath

The content (section or document or image) this reference points to.

The content (section or document or image) this reference points to.

def resolve(target: Target): Link

Creates the final AST element based on the resolved target.

Creates the final AST element based on the resolved target.

Inherited methods

def canEqual(that: Any): Boolean
Inherited from:
Equals
def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Inherited from:
Element
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Inherited from:
Element
def mergeOptions(opt: Options): Self

Returns a new instance of this element with its options merged with the specified options.

Returns a new instance of this element with its options merged with the specified options.

Inherited from:
Element
def modifyOptions(f: Options => Options): Self

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Inherited from:
Element
def options: Options
Inherited from:
Element
def productArity: Int
Inherited from:
Product
def productElement(n: Int): Any
Inherited from:
Product
def productElementName(n: Int): String
Inherited from:
Product
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def productPrefix: String
Inherited from:
Product
def source: SourceFragment

The fragment from the input source that produced this element. Can be used to report the line of the error or to render a fallback that simply renders back the consumed input.

The fragment from the input source that produced this element. Can be used to report the line of the error or to render a fallback that simply renders back the consumed input.

Inherited from:
Unresolved
def unresolvedMessage: String

An error message to display when this element remains unresolved until after the final AST transformation step.

An error message to display when this element remains unresolved until after the final AST transformation step.

Inherited from:
Unresolved
def withId(id: String): Self

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Inherited from:
Element
def withOptions(options: Options): Self

Returns a new instance of this element with the specified options replacing the current value.

Returns a new instance of this element with the specified options replacing the current value.

Inherited from:
Element
def withStyle(name: String): Self

Returns a new instance of this element with the specified style added to its existing styles.

Returns a new instance of this element with the specified style added to its existing styles.

Inherited from:
Element
def withStyles(styles: Iterable[String]): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Inherited from:
Element
def withStyles(style: String, styles: String*): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Inherited from:
Element
def withoutId: Self

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Inherited from:
Element