quarkdown-html/com.quarkdown.rendering.html.node/HtmlRendererHelper

HtmlRendererHelper

class HtmlRendererHelper(renderer: BaseHtmlNodeRenderer, context: Context)

Helper providing shared HTML-building utilities for HTML renderers.

Parameters

renderer

renderer this helper builds tags for

context

additional information produced by the earlier stages of the pipeline

Constructors

HtmlRendererHelper

constructor(renderer: BaseHtmlNodeRenderer, context: Context)

Functions

captionedContent

fun <T : CaptionableNode, LocationTrackableNode, LocalizedKind> captionedContent(builder: HtmlTagBuilder, node: T, positionProvider: CaptionPositionInfo.() -> CaptionPosition?, captionTagName: String = "figcaption", content: HtmlTagBuilder.() -> Unit): HtmlTagBuilder

Appends the given content along with the numbered caption of node (via numberedCaption), ordered according to the caption position.

numberedCaption

fun <T : CaptionableNode, LocationTrackableNode, LocalizedKind> numberedCaption(builder: HtmlTagBuilder, node: T, position: CaptionPosition, captionTagName: String = "figcaption", idPrefix: String = node.kindLocalizationKey): HtmlTagBuilder

Retrieves the location-based label of the node, displays an optional caption preceded by the label, and also applies the label as its ID. The label is pre-formatted according to the current NumberingFormat.

resolveCaptionPosition

fun resolveCaptionPosition(positionProvider: CaptionPositionInfo.() -> CaptionPosition?): CaptionPosition

Resolves the position of a caption, falling back to the document's default position.

withLocalizedKind

fun withLocalizedKind(builder: HtmlTagBuilder, node: LocalizedKind): HtmlTagBuilder

Adds a data-localized-kind attribute to the localizable node. The kind name is localized according to the current locale.

withLocationLabel

fun withLocationLabel(builder: HtmlTagBuilder, node: LocationTrackableNode): HtmlTagBuilder

Adds a data-location attribute to the location-trackable node, if its location is available. The location is formatted according to the current NumberingFormat.