HtmlAddressingStrategy Class

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

Definition

Provides an abstract base class for HTML-based addressing strategies that organize documentation files in a hierarchical structure.
public abstract class HtmlAddressingStrategy : AddressingStrategy
Inheritance
Inherited by

Remarks

This class defines the common properties and methods for HTML addressing strategies that organize documentation pages in a hierarchical file structure suitable for web-based documentation.

It includes properties for API and topic paths, index topic names, and pinned topics, which are used to determine how documentation pages are addressed and organized within the HTML documentation structure.

Thread Safety

All public members of the type are guaranteed to be thread-safe.

Constructors

HtmlAddressingStrategy(HtmlAddressingOptions)Initializes a new instance of the HtmlAddressingStrategy class.

Properties

ApiPathGets the path of the API documentation files.
IndexTopicNameGets the filename (without extension) used for topics with subtopics and pinned topics.
PinnedIndexTopicsGets the collection of pinned index topics, which are assigned specific paths relative to the documentation root.
TopicPathGets the path of the topic files.

Methods

GetApiPath(string)Constructs the API path for the specified subpath, ensuring it is relative to the configured API path.
GetTopicPath(ITopic, char)Constructs the path for the specified topic, replacing invalid characters with the provided replacement character.

Extension Methods

TryResolveAddressByCodeReference(this IDocumentAddressingStrategy, string, out IResourceAddress)Attempts to resolve the address of the documentation content for the specified code reference.