NAME
Parrot::Docs::Section - Documentation section
SYNOPSIS
use Parrot::Docs::Section;DESCRIPTION
A documentation section is an HTML page containing links to one or more, grouped or ungrouped items.
Parrot::Docs::Section is a subclass of Parrot::Docs::Group.
Class Methods
root_section()-
Returns the root section.
new_section($name, $text, @items)-
Returns a new section.
Use this when creating subsections within a subclass's
new()method. new($name, $index_path, @contents)-
Returns a new section.
$nameand$index_pathare required, though$index_pathdefaults to index.html if undefined or an empty string is supplied.@contentsis one or more sections, groups and/or items.
Instance Methods
is_root_section()-
Returns whether the section is the root section.
html_link($path)-
Returns the HTML link for the section.
write_html($source, $target, $silent)-
Calls
write_html()on the contents of the section.An HTML link to the section's index is returned.