Translates paths of input documents to the corresponding output path. The minimum translation that usually has to happen is to replace the suffix from the input document the path has been obtained from to the suffix of the output format. Further translations are allowed to happen based on user configuration.
- Companion:
- object
Value members
Abstract 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.
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.
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.
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.
Concrete methods
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.