HtmlFileTopic Class

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

Definition

Represents a documentation topic that is stored in an HTML file.
public class HtmlFileTopic : FileTopic
Inheritance

Remarks

The HtmlFileTopic class handles an HTML file as a documentation topic source. It automatically extracts the title from HTML <title> tag and attempts to convert the content of the <body> tag to the appropriate format of the documentation system.
If you need to include the entire HTML file as a topic, including the <head> tags, consider using the HtmlFileTopic class.

Thread Safety

Public static members of the type are guaranteed to be thread-safe. However, public instance members are not thread-safe.

Constructors

HtmlFileTopic(string, string)Initializes a new instance of the HtmlFileTopic class.

Properties

ContentFormatGets the format of the content in the topic.

Methods

CreateContentReader(IDocumentationContext)Creates a TextReader to read the content of the topic
GenerateTitle()Extracts the title of the topic from the HTML file.