Skip Navigation
Instance MethodMethod

buildSidebarDocument(includeSearch:)

Builds the standalone sidebar document shared by all documentation pages.

mutating func buildSidebarDocument(includeSearch: Bool) -> String

Parameters

includeSearch

Whether to load the client-side search scripts that add content matches below the tree while filtering.

Return Value

The complete HTML document.

Discussion

The document contains the navigation tree of every module with links relative to the output root, the filter field, and the scripts that enhance it when JavaScript is available. Its <base target="_top"> makes every link, including links created by scripts, navigate the window that embeds the document.