Parrot::Docs::Section - Documentation section
use Parrot::Docs::Section;
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.
Parrot::Docs::Section
Parrot::Docs::Group
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()
new($name, $index_path, @contents)
$name and $index_path are required, though $index_path defaults to index.html if undefined or an empty string is supplied.
$name
$index_path
@contents is one or more sections, groups and/or items.
@contents
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.
write_html()
An HTML link to the section's index is returned.
Parrot::Docs::Item
To install Parrot::Op, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Parrot::Op
CPAN shell
perl -MCPAN -e shell install Parrot::Op
For more information on module installation, please visit the detailed CPAN module installation guide.