Class HelpTopic

Namespace

Kuestenlogik.Bowire.Help

Assembly

Kuestenlogik.Bowire.dll

A single help topic in its full form. The body ships in two shapes: the raw Markdown source (kept for back-compat + tools that want the original) and BodyHtml — sanitised HTML the provider produced so the workbench can innerHTML it without re-parsing markdown in the browser. The mini-renderer the drawer used to ship choked on embedded HTML (DocFX <dl>, <picture>, theme-aware SVG hero) and showed it as escaped text. Pipeline rendering on the server side keeps the UI thin and lets DocFX-shaped pages render correctly.

public sealed record HelpTopic : IEquatable<HelpTopic>

Inheritance

object

HelpTopic

Implements

IEquatable<HelpTopic>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

HelpTopic(string, string, string?, string, string, string?)

A single help topic in its full form. The body ships in two shapes: the raw Markdown source (kept for back-compat + tools that want the original) and BodyHtml — sanitised HTML the provider produced so the workbench can innerHTML it without re-parsing markdown in the browser. The mini-renderer the drawer used to ship choked on embedded HTML (DocFX <dl>, <picture>, theme-aware SVG hero) and showed it as escaped text. Pipeline rendering on the server side keeps the UI thin and lets DocFX-shaped pages render correctly.

public HelpTopic(string Id, string Title, string? Summary, string Markdown, string BodyHtml, string? CategoryId)

Parameters

Id string

Stable identifier — used in URLs + cross-references.

Title string

Short display title for the topic tree (one to three words).

Summary string

Optional longer description shown under the title in nav rows. Sourced from front-matter summary:. null when not provided.

Markdown string

Raw markdown body. May include relative links to other topics by id.

BodyHtml string

Server-rendered HTML body. Workbench prefers this when present.

CategoryId string

Optional grouping key for the topic tree. null = top level.

Properties

BodyHtml

Server-rendered HTML body. Workbench prefers this when present.

public string BodyHtml { get; init; }

Property Value

string

CategoryId

Optional grouping key for the topic tree. null = top level.

public string? CategoryId { get; init; }

Property Value

string

Id

Stable identifier — used in URLs + cross-references.

public string Id { get; init; }

Property Value

string

Markdown

Raw markdown body. May include relative links to other topics by id.

public string Markdown { get; init; }

Property Value

string

Summary

Optional longer description shown under the title in nav rows. Sourced from front-matter summary:. null when not provided.

public string? Summary { get; init; }

Property Value

string

Title

Short display title for the topic tree (one to three words).

public string Title { get; init; }

Property Value

string

Methods

Deconstruct(out string, out string, out string?, out string, out string, out string?)

public void Deconstruct(out string Id, out string Title, out string? Summary, out string Markdown, out string BodyHtml, out string? CategoryId)

Parameters

Id string

Title string

Summary string

Markdown string

BodyHtml string

CategoryId string

Equals(HelpTopic?)

public bool Equals(HelpTopic? other)

Parameters

other HelpTopic

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(HelpTopic?, HelpTopic?)

public static bool operator ==(HelpTopic? left, HelpTopic? right)

Parameters

left HelpTopic

right HelpTopic

Returns

bool

operator !=(HelpTopic?, HelpTopic?)

public static bool operator !=(HelpTopic? left, HelpTopic? right)

Parameters

left HelpTopic

right HelpTopic

Returns

bool