perldoc > Pod::Perldoc::BaseTo

man perldoc info pydoc3 ri search

📘 NAME

Pod::Perldoc::BaseTo — Base for Pod::Perldoc formatters

🚀 Quick Reference

Use Case	Command	Description
Create a new formatter	Pod::Perldoc::ToMyFormat->new()	🔧 Instantiate a concrete formatter (must implement new)
Parse POD from a file	$formatter->parse_from_file($file)	📄 Parse POD input and produce output (must implement)
Check if output is pageable	$formatter->is_pageable()	📄 Returns true if output can be paged (e.g., man pages)
Write with binmode	$formatter->write_with_binmode()	💾 Controls binary mode for output filehandle
Get output file extension	$formatter->output_extension()	📁 Returns the file extension for the output format (e.g., .txt)
Access internal perldoc elements	$formatter->_perldoc_elem($key)	🔍 Retrieve internal configuration elements from perldoc

📖 SYNOPSIS

package Pod::Perldoc::ToMyFormat;

use parent qw( Pod::Perldoc::BaseTo );
...

📝 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:

• 🔹 is_pageable — determines if output can be paged
• 🔹 write_with_binmode — controls binary mode on output
• 🔹 output_extension — returns the file extension for the output format
• 🔹 _perldoc_elem — access to internal perldoc elements

The concrete formatter must implement:

• 🔸 new — constructor
• 🔸 parse_from_file — parse POD input from a 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 AT cpan.org>"

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

📘 NAME 🚀 Quick Reference 📖 SYNOPSIS 📝 DESCRIPTION 🔗 SEE ALSO ©️ COPYRIGHT AND DISCLAIMERS 👤 AUTHOR