IUrlTransformer Interface

Namespace
Kampute.DocToolkit.Routing
Assembly
  • Kampute.DocToolkit.dll

Definition

Provides a mapping between references and their corresponding URLs.
public interface IUrlTransformer
Implemented by

Remarks

The IUrlTransformer interface addresses a key challenge in documentation systems: maintaining valid cross-references when URL structures change. It serves as a mapping layer between source paths and their target URLs, allowing documentation to adapt to format changes or different addressing strategies without breaking existing references.

When documentation topics reference other topics, the actual URLs may change due to format changes or shifts in addressing strategy. This interface ensures that references remain valid by providing a centralized mapping mechanism that translates between different addressing schemes.

Properties

MayTransformUrlsGets a value indicating whether the URL transformer is active and performs any URL transformations.

Methods

TryTransformUrl(string, out Uri)Attempts to transform a URL string to a different URL.