HtmlAddressingStrategy.GetTopicPath Method

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Constructs the path for the specified topic, replacing invalid characters with the provided replacement character.

protected virtual string GetTopicPath(ITopic topic, char replacement)

Parameters

topic ITopic: The topic for which the path is being constructed.
replacement char: The character used to replace invalid characters in the topic path.

Returns

string: A string representing the constructed path for the topic.

Exceptions

ArgumentNullException: Thrown when topic is null.

Remarks

If the topic is pinned in HtmlAddressingStrategy.PinnedIndexTopics, the pinned path is used as the base path. Otherwise, the path is constructed recursively from the topic's parent hierarchy. Invalid characters in each segment are replaced with the specified replacement character.