Matt S Trout > Rakudo-Star-2012.08_001 > Parrot::Docs::HTMLPage

Download:
Rakudo-Star-2012.08_001.tar.gz

Dependencies

Annotate this POD

Source  

NAME ^

Parrot::Docs::HTMLPage - HTML Documentation Page

DESCRIPTION ^

Parrot::Docs::HTMLPage gives Parrot documentation pages the Parrot house-style.

This just provides header() and footer() class methods for now, to prevent code being duplicated in Parrot::Docs::POD2HTML and Parrot::Docs::Section.

Class Methods

header($title, $navigation, $resources, $version)

Returns the page header with the specified title and navigation bar. $resources should be the relative path from the page to docs/resources, the image and CSS file directory.

body(@html)

Returns the html code, e.g., links, passed to it.

@html is a simple array to hold the html links passed to this subroutine.

footer($navigation, $resources)

Returns the page footer.

$navigation is currently unused.

$resources should be the relative path from the page to docs/resources, the image and CSS file directory.

syntax highlighting: