RenderablePageInterface
in
Common contract for nodes that are rendered as standalone HTML pages outside the main documentation tree.
Both PageNode (static pages) and ContentTypeItemNode (content-type collection items) implement this interface so that RenderPagesListener can iterate over all renderables uniformly.
Table of Contents
Methods
- getChildren() : Node[]
- Body nodes that make up the visible page content.
- getFilePath() : string
- Source file path relative to its source directory, without extension.
- getHeaderNodes() : MetadataNode[]
- Metadata nodes that should be rendered inside the HTML <head>.
- getOutputPath() : string
- Output path relative to the output root, without extension.
- getPageTitle() : string|null
- Title string for the HTML <title> element. May be null when no title metadata is present in the source file.
Methods
getChildren()
Body nodes that make up the visible page content.
public
getChildren() : Node[]
Return values
Node[]getFilePath()
Source file path relative to its source directory, without extension.
public
getFilePath() : string
Used to build a thin DocumentNode for RenderContext compatibility.
Return values
stringgetHeaderNodes()
Metadata nodes that should be rendered inside the HTML <head>.
public
getHeaderNodes() : MetadataNode[]
Return values
MetadataNode[]getOutputPath()
Output path relative to the output root, without extension.
public
getOutputPath() : string
This is the path at which the rendered HTML file is written.
Return values
stringgetPageTitle()
Title string for the HTML <title> element. May be null when no title metadata is present in the source file.
public
getPageTitle() : string|null