trait PathTranslator extends AnyRef

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.

Linear Supertypes
AnyRef, Any
Known Subclasses
NoOpPathTranslator, BasicPathTranslator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PathTranslator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def forReferencePath(path: Path): PathTranslator

    Creates a copy of this path translator that uses the specified reference path for resolving relative paths.

    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.

  2. abstract def getAttributes(path: Path): Option[PathAttributes]

    Retrieves the attributes for the specified path in the context of the current virtual tree of documents.

    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.

  3. abstract def translate(input: RelativePath): RelativePath

    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.

  4. abstract def translate(input: Path): Path

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

Concrete 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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. def translate(target: Target): Target

    Translates the specified target pointing to an input document to a target pointing to an output document.

    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.

  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped