Pod::Perldoc::ToToc - Translate Pod to a Table of Contents

Pod-Perldoc-ToToc documentation Contained in the Pod-Perldoc-ToToc distribution.

Index

Code Index:

NAME

Top

Pod::Perldoc::ToToc - Translate Pod to a Table of Contents

SYNOPSIS

Top

Use this module with perldoc's -M switch.

	% perldoc -MPod::Perldoc::ToToc Module::Name

DESCRIPTION

Top

This module uses the Pod::Perldoc module to extract a table of contents from a pod file.

METHODS

Top

parse_from_file( FILENAME, OUTPUT_FH )

Parse the file named in FILENAME using Pod::TOC and send the results to the output filehandle OUTPUT_FH.

SEE ALSO

Top

Pod::Perldoc

SOURCE AVAILABILITY

Top

This source is part of a Google Code project which always has the latest sources in SVN.

	http://code.google.com/p/brian-d-foy/source

If, for some reason, I disappear from the world, one of the other members of the project can shepherd this module appropriately.

AUTHOR

Top

brian d foy, <bdfoy@cpan.org>

COPYRIGHT AND LICENSE

Top

Copyright (c) 2006-2008, brian d foy, All Rights Reserved.

You may redistribute this under the same terms as Perl itself.

Pod-Perldoc-ToToc documentation Contained in the Pod-Perldoc-ToToc distribution. 
 # $Id$
package Pod::Perldoc::ToToc;
use strict;

use base qw(Pod::Perldoc::BaseTo);

use subs qw();
use vars qw( $VERSION );

use Pod::TOC;

use warnings;
no warnings;

$VERSION = '1.09';

sub is_pageable        { 1 }
sub write_with_binmode { 0 }
sub output_extension   { 'toc' }

sub parse_from_file
	{
	my( $self, $file, $output_fh ) = @_; # Pod::Perldoc object

	my $parser = Pod::TOC->new();

	$parser->output_fh( $output_fh );

	$parser->parse_file( $file );
	}


1;