Class HtmlSplitOptions

Configures structural topic splitting and HTML artifact generation.

Inheritance

object

HtmlSplitOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Document

Assembly: DRIT.Document.dll

Syntax

public sealed class HtmlSplitOptions

Properties

AssetResolver

Gets or sets an optional asset path resolver.

Declaration

public Func<HtmlSplitAsset, string> AssetResolver { get; set; }

Property Value

Type	Description
Func<HtmlSplitAsset, string>

Remarks

The resolver returns a relative path under OutputDirectory.

ContentsFileName

Gets or sets the contents filename.

Declaration

public string ContentsFileName { get; set; }

Property Value

Type	Description
string

ContentsTitle

Gets or sets the contents page title.

Declaration

public string ContentsTitle { get; set; }

Property Value

Type	Description
string

Criteria

Gets or sets the structural split criterion.

Declaration

public DocumentSplitCriteria Criteria { get; set; }

Property Value

Type	Description
DocumentSplitCriteria

EmitContentsPage

Gets or sets whether a contents page is emitted.

Declaration

public bool EmitContentsPage { get; set; }

Property Value

Type	Description
bool

Encoding

Gets or sets the encoding used for generated HTML files.

Declaration

public Encoding Encoding { get; set; }

Property Value

Type	Description
Encoding

ExportImagesBesideTopic

Gets or sets whether image assets are written beside the topic HTML file.

Declaration

public bool ExportImagesBesideTopic { get; set; }

Property Value

Type	Description
bool

FileNamePolicy

Gets or sets the topic filename policy.

Declaration

public HtmlSplitFileNamePolicy FileNamePolicy { get; set; }

Property Value

Type	Description
HtmlSplitFileNamePolicy

HeadingLevel

Gets or sets the heading level used when Criteria is Heading.

Declaration

public int HeadingLevel { get; set; }

Property Value

Type	Description
int

HtmlTitle

Gets or sets the title written into each topic HTML document.

Declaration

public string HtmlTitle { get; set; }

Property Value

Type	Description
string

ImportFormatMode

Gets or sets the formatting policy used while importing topic nodes.

Declaration

public ImportFormatMode ImportFormatMode { get; set; }

Property Value

Type	Description
ImportFormatMode

OutputDirectory

Gets or sets the directory receiving generated HTML and asset files.

Declaration

public string OutputDirectory { get; set; }

Property Value

Type	Description
string

PreserveHeadersFooters

Gets or sets whether source headers and footers are copied to topics.

Declaration

public bool PreserveHeadersFooters { get; set; }

Property Value

Type	Description
bool

RelativeLinkPolicy

Gets or sets the policy used for topic and asset links.

Declaration

public HtmlSplitRelativeLinkPolicy RelativeLinkPolicy { get; set; }

Property Value

Type	Description
HtmlSplitRelativeLinkPolicy

Slugger

Gets or sets an optional custom title-to-slug converter.

Declaration

public Func<string, string> Slugger { get; set; }

Property Value

Type	Description
Func<string, string>