ResolvedContent Pennington.DocSite.Services

Rendered content plus the surrounding locale/fallback metadata needed to render a page.

Properties

Description string?: Default: null
Page description from front matter.
FallbackDefaultDisplayName string?: Default: null
Display name for the locale actually served, shown in the fallback notice.
FallbackRequestedDisplayName string?: Default: null
Display name for the requested locale, shown in the fallback notice.
Html string: Rendered HTML body.
IsFallback bool: Default: false
True when content from the default locale was served because the requested locale had no match.
Locale string: Default: ""
Locale used to render the page (may differ from the requested locale when falling back).
Metadata Pennington.FrontMatter.IFrontMatter: Parsed front matter for the page.
Outline Pennington.Pipeline.OutlineEntry[]: Headings extracted from the body for the on-page outline.
RequestedLocale string?: Default: null
Locale the user originally requested, when different from Locale.
Route Pennington.Routing.ContentRoute: Canonical route for the resolved page.
Title string: Page title from front matter.

Constructors

.ctor

public record ResolvedContent(
    ContentRoute Route,
    string Title,
    string? Description,
    string Html,
    OutlineEntry[] Outline,
    IFrontMatter Metadata,
    string Locale = "",
    bool IsFallback = false,
    string? RequestedLocale = null,
    string? FallbackRequestedDisplayName = null,
    string? FallbackDefaultDisplayName = null
);

Rendered content plus the surrounding locale/fallback metadata needed to render a page.

Parameters

Route ContentRoute: Canonical route for the resolved page.
Title string: Page title from front matter.
Description string?: Page description from front matter.
Html string: Rendered HTML body.
Outline OutlineEntry[]: Headings extracted from the body for the on-page outline.
Metadata IFrontMatter: Parsed front matter for the page.
Locale string (optional): Locale used to render the page (may differ from the requested locale when falling back).
IsFallback bool (optional): True when content from the default locale was served because the requested locale had no match.
RequestedLocale string? (optional): Locale the user originally requested, when different from Locale.
FallbackRequestedDisplayName string? (optional): Display name for the requested locale, shown in the fallback notice.
FallbackDefaultDisplayName string? (optional): Display name for the locale actually served, shown in the fallback notice.

Pennington.DocSite.Services.ResolvedContent

namespace Pennington.DocSite.Services;

/// Rendered content plus the surrounding locale/fallback metadata needed to render a page.
public record ResolvedContent
{
    /// Rendered content plus the surrounding locale/fallback metadata needed to render a page.
    public record ResolvedContent(
    ContentRoute Route,
    string Title,
    string? Description,
    string Html,
    OutlineEntry[] Outline,
    IFrontMatter Metadata,
    string Locale = "",
    bool IsFallback = false,
    string? RequestedLocale = null,
    string? FallbackRequestedDisplayName = null,
    string? FallbackDefaultDisplayName = null
);

    /// Page description from front matter.
    string? Description;

    /// Display name for the locale actually served, shown in the fallback notice.
    string? FallbackDefaultDisplayName = null;

    /// Display name for the requested locale, shown in the fallback notice.
    string? FallbackRequestedDisplayName = null;

    /// Rendered HTML body.
    string Html;

    /// True when content from the default locale was served because the requested locale had no match.
    bool IsFallback = false;

    /// Locale used to render the page (may differ from the requested locale when falling back).
    string Locale = ""

    /// Parsed front matter for the page.
    IFrontMatter Metadata;

    /// Headings extracted from the body for the on-page outline.
    OutlineEntry[] Outline;

    /// Locale the user originally requested, when different from Locale.
    string? RequestedLocale = null;

    /// Canonical route for the resolved page.
    ContentRoute Route;

    /// Page title from front matter.
    string Title;
}