BasicPathTranslator

laika.rewrite.nav.BasicPathTranslator
case class BasicPathTranslator(outputSuffix: String) extends PathTranslator

Attributes

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

Members list

Value members

Concrete methods

Creates a copy of this path translator that uses the specified reference path for resolving relative paths. All other aspect of translation logic should behave the same as in this instance.

Creates a copy of this path translator that uses the specified reference path for resolving relative paths. All other aspect of translation logic should behave the same as in this instance.

Attributes

def getAttributes(path: Path): Option[PathAttributes]

Retrieves the attributes for the specified path in the context of the current virtual tree of documents. If there is no document or tree associated with the specified path, the result will be empty.

Retrieves the attributes for the specified path in the context of the current virtual tree of documents. If there is no document or tree associated with the specified path, the result will be empty.

Mostly used by implementations of this trait, but accessible publicly for some less common scenarios, e.g. in directive implementations.

Attributes

def translate(input: Path): Path

Translates the specified path of an input document to the corresponding output path.

Translates the specified path of an input document to the corresponding output path.

Attributes

Translates the specified relative path of an input document to the corresponding output path.

Translates the specified relative path of an input document to the corresponding output path.

Translator implementations resolve the relative path in relation to a reference path, which implies that there is a dedicated path translator instance per output document. Using forReferencePath a copy of this translator that uses a different path as reference can be created cheaply.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def translate(target: Target): Target

Translates the specified target pointing to an input document to a target pointing to an output document. Might turn an internal target into an external one in cases where it points to a document that is not rendered for the current target format, but for the site output. In this case it will point to the corresponding location of the hosted site, in case a siteBaseURL is configured.

Translates the specified target pointing to an input document to a target pointing to an output document. Might turn an internal target into an external one in cases where it points to a document that is not rendered for the current target format, but for the site output. In this case it will point to the corresponding location of the hosted site, in case a siteBaseURL is configured.

Attributes

Inherited from:
PathTranslator