/ 
Text-TOC-0.10
River stage one • 1 direct dependent • 2 total dependents
/ Text::TOC::Role::Node

NAME

Text::TOC::Role::Node - A role for nodes

VERSION

version 0.10

DESCRIPTION

This role defines the API and partial implementation for nodes. A node represents an item of interest from the original document that will be included in the table of contents.

PARAMETERS

This role is parameterzed, and requires a single parameter:

  • contents_type

    This is the type of the contents attribute. It should be passed as either a string or a type constraint object.

ATTRIBUTES

This role provides the following attributes:

  • type

    This is a string. What this represents will depend on the class which consumes this role.

  • anchor_name

    The name of the anchor associated with this node.

  • source_file

    A Path::Class::File object representing the source file for the node.

  • contents

    The contents of the node. Exactly what this is depends on the class consuming this role.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Dave Rolsky.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.