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

laika.rewrite.link

package laika.rewrite.link

Members list

Type members

Classlikes

case object AnonymousSelector extends SequenceSelector

An anonymous selector (usually matched by position).

An anonymous selector (usually matched by position).

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Selector
class Object
trait Matchable
class Any
Show all
Self type
case class ApiLinks(baseUri: String, packagePrefix: String, packageSummary: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ApiLinks.type
case object AutonumberSelector extends SequenceSelector

An auto-number selector (usually matched by position).

An auto-number selector (usually matched by position).

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Selector
class Object
trait Matchable
class Any
Show all
Self type
case object AutosymbolSelector extends SequenceSelector

An auto-symbol selector (usually matched by position).

An auto-symbol selector (usually matched by position).

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Selector
class Object
trait Matchable
class Any
Show all
Self type
case class DocumentTargets(document: Document, slugBuilder: String => String)

Collects all tree elements from a document that can be referenced from other elements, like images, footnotes, citations and other inline targets.

Collects all tree elements from a document that can be referenced from other elements, like images, footnotes, citations and other inline targets.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IconRegistry(icons: Map[String, Icon])

Registers Icon AST elements for use with the @:icon directive and the IconReference AST element.

Registers Icon AST elements for use with the @:icon directive and the IconReference AST element.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class InvalidTarget(message: String) extends TargetValidation

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class LinkAliasResolver(sourceSelector: TargetIdSelector, targetSelector: TargetIdSelector, referenceResolver: LinkSource => Option[Span], formats: TargetFormats) extends TargetResolver

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class LinkConfig(targets: Seq[TargetDefinition], excludeFromValidation: Seq[Path], apiLinks: Seq[ApiLinks], sourceLinks: Seq[SourceLinks])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
LinkConfig.type
case class LinkDefinitionSelector(id: String) extends UniqueSelector

A selector for a definition for an internal or external link.

A selector for a definition for an internal or external link.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Selector
class Object
trait Matchable
class Any
Show all
class LinkResolver(root: DocumentTreeRoot, slugBuilder: String => String) extends RewriteRulesBuilder

The default rewrite rules responsible for resolving link references that get applied to the raw document tree after parsing.

The default rewrite rules responsible for resolving link references that get applied to the raw document tree after parsing.

These rules resolve references to images, footnotes, citations and other inline targets, and generate the identifiers for targets with auto-generated ids like auto-number footnotes.

The rules replace references pointing to internal or external targets with the corresponding resolved link elements, as well as the targets themselves with nodes that contain their final ids.

In case of duplicate target ids or unresolvable references runtime messages get inserted into the final document tree.

Attributes

Supertypes
class Object
trait Matchable
class Any
case class LinkSource(span: Span, path: Path)

Represents the source of a link, its document path and the actual inline span that is representing the link.

Represents the source of a link, its document path and the actual inline span that is representing the link.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PathSelector(path: Path) extends UniqueSelector

A selector based on a path, optionally including a fragment component.

A selector based on a path, optionally including a fragment component.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Selector
class Object
trait Matchable
class Any
Show all
case class RecoveredTarget(message: String, recoveredTarget: ResolvedInternalTarget) extends TargetValidation

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Selector

Represents a selector used for matching reference nodes to target nodes. The selectors often differ from both, the ids rendered in the final document and the ids used for display.

Represents a selector used for matching reference nodes to target nodes. The selectors often differ from both, the ids rendered in the final document and the ids used for display.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AnonymousSelector.type
object AutonumberSelector.type
object AutosymbolSelector.type
class PathSelector
Show all
sealed trait SequenceSelector extends Selector

A selector that can be used for a sequence of targets.

A selector that can be used for a sequence of targets.

Attributes

Supertypes
trait Selector
class Object
trait Matchable
class Any
Known subtypes
object AnonymousSelector.type
object AutonumberSelector.type
object AutosymbolSelector.type
object SlugBuilder

Default implementation for the logic that transforms section titles, document names and user-provided ids to a slug that is compatible with HTML/XML ids, URLs and file names.

Default implementation for the logic that transforms section titles, document names and user-provided ids to a slug that is compatible with HTML/XML ids, URLs and file names.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class SourceLinks(baseUri: String, suffix: String, packagePrefix: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TargetDefinition(id: String, target: Target)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TargetIdSelector(id: String) extends UniqueSelector

A selector for a rendered target in a document.

A selector for a rendered target in a document.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Selector
class Object
trait Matchable
class Any
Show all
object TargetReplacer

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class TargetResolver(val selector: Selector, val targetFormats: TargetFormats, val precedence: Int)

Represents a resolver for a target that has its final identifier generated (if necessary) and can be used to resolve matching reference nodes.

Represents a resolver for a target that has its final identifier generated (if necessary) and can be used to resolve matching reference nodes.

Value parameters

precedence

the precedence in comparison to other resolvers with the same selector

selector

the selector to use to identify reference nodes matching this target

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TargetResolver

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
case class TargetSequenceResolver(targets: Seq[TargetResolver], sel: Selector) extends TargetResolver

Represents a resolver for a sequence of targets where matching reference nodes get determined by position. The resolveReference and resolveTarget methods can be invoked as many times as this sequence contains elements.

Represents a resolver for a sequence of targets where matching reference nodes get determined by position. The resolveReference and resolveTarget methods can be invoked as many times as this sequence contains elements.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TargetValidation

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ValidTarget.type
class TreeTargets(root: DocumentTreeRoot, slugBuilder: String => String)

Collects all elements from a document tree that can be referenced from other elements, like images, footnotes, citations and other inline targets.

Collects all elements from a document tree that can be referenced from other elements, like images, footnotes, citations and other inline targets.

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed trait UniqueSelector extends Selector

A selector that can is a globally unique identifier.

A selector that can is a globally unique identifier.

Attributes

Supertypes
trait Selector
class Object
trait Matchable
class Any
Known subtypes
class PathSelector
case object ValidTarget extends TargetValidation

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Generated with