HtmlAddressingOptions Class
- Namespace
- Kampute.DocToolkit.Routing
- Assembly
- Kampute.DocToolkit.dll
Definition
Provides options for HTML-based addressing and organizing documentation files.
public abstract class HtmlAddressingOptions : AddressingOptions- Inheritance
- object
- AddressingOptions
- HtmlAddressingOptions
- Inherited by
Remarks
This abstract class defines common configuration options for HTML addressing strategies that organize documentation files in a hierarchical structure. Derived classes should extend these options with additional configuration properties specific to particular HTML addressing schemes.
Constructors
| HtmlAddressingOptions() | Initializes a new instance of the HtmlAddressingOptions class. |
| HtmlAddressingOptions(string) | Initializes a new instance of the HtmlAddressingOptions class with a specified file extension. |
Properties
| ApiPath | Gets or sets the path of the API documentation files. |
| IndexTopicName | Gets or sets the filename (without extension) used for topics with subtopics and pinned topics. |
| PinnedIndexTopics | Gets the collection of pinned index topics, which are assigned specific paths relative to the documentation root. |
| TopicPath | Gets or sets the path of the topic files. |
Methods
| AddPinnedTopic(string, string) | Adds a topic to the collection of pinned topics. |
| RemovePinnedTopic(string) | Removes a topic from the collection of pinned topics. |