Perl 5 version 24.3 documentation

Pod::Perldoc::BaseTo

NAME

Pod::Perldoc::BaseTo - Base for Pod::Perldoc formatters

SYNOPSIS

  1.     package Pod::Perldoc::ToMyFormat;
  3.     use parent qw( Pod::Perldoc::BaseTo );
  4.     ...

DESCRIPTION

This package is meant as a base of Pod::Perldoc formatters, like Pod::Perldoc::ToText, Pod::Perldoc::ToMan, etc.

It provides default implementations for the methods

  1.     is_pageable
  2.     write_with_binmode
  3.     output_extension
  4.     _perldoc_elem

The concrete formatter must implement

  1.     new
  2.     parse_from_file

SEE ALSO

perldoc

COPYRIGHT AND DISCLAIMERS

Copyright (c) 2002-2007 Sean M. Burke.

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

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

AUTHOR

Current maintainer: Mark Allen <mallen@cpan.org>

Past contributions from: brian d foy <bdfoy@cpan.org> Adriano R. Ferreira <ferreira@cpan.org> , Sean M. Burke <sburke@cpan.org>