ITopic.Title Property

Namespace
Kampute.DocToolkit.Topics
Assembly
  • Kampute.DocToolkit.dll

Definition

Gets the title of the topic.
string Title { get; }

Property Value

string
The title of the topic, which is a human-readable string that describes the topic.

Remarks

The ITopic.Title is a human-readable string that describes the topic. It is typically used as the heading or title in the rendered documentation. However, based on the selected addressing strategy, it may also be used as the URL or filename for the topic. Therefore, it is recommended to keep the title concise and descriptive, avoiding special characters that could interfere with URL or file naming conventions.