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.

Matching the displayed order in the DOM lets the caption take part in the layout where it is shown: in paged documents, a top caption stays with the first portion of an element split across pages, and a bottom one with the last.

Parameters

builder

builder of the tag hosting the captioned content

node

node to display the caption for

positionProvider

position of the caption relative to the content

captionTagName

tag name of the caption element. E.g. "figcaption" for figures, "caption" for tables

content

builder of the captioned content