Pod::P...BaseTo(3perl)

📦
version 5.44.0 · 14 versions
, in arch rolling

💖 NAME 💖

Pod::Perldoc::BaseTo — bestie, it's the base class for the Pod::Perldoc formatters. The blueprint. The mother of all formatters. The template that the other formatter classes are literally built on top of. 👑

✨ SYNOPSIS ✨

Okay so this is how you actually use it, no cap:

package Pod::Perldoc::ToMyFormat;

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

Yup. You make your own package, you use parent qw( Pod::Perldoc::BaseTo ), and then you finish the rest yourself. The ... is doing a lot of heavy lifting there but that's the vibe. 💅

🌸 DESCRIPTION 🌸

So, this package is meant to be the base of all the Pod::Perldoc formatters — like Pod::Perldoc::ToText, Pod::Perldoc::ToMan, and the rest of the crew. It's giving "I raised all of y'all." 🫶

It hands you default implementations for these methods, already done, already slaying:

  • is_pageable
  • write_with_binmode
  • output_extension
  • _perldoc_elem

But here's the part where you have to show up and do your part, bestie. The concrete formatter — that's your formatter — must implement these:

  • new
  • parse_from_file

Like. These ones are not optional. The base class is giving you defaults on the easy stuff and looking at you expectantly for the real work. 🧚

🦋 SEE ALSO 🦋

  • perldoc — go read it, it's right there

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. So like. It's free, it's generous, but it's not promising you anything. 💀

💜 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>

Look at that contributor list. Legends only. 👑

okay that's the whole page bestie, mwah 💖

Signing off from perl v5.44.0, dated 2026-10-17 — this was Pod::Perldoc::BaseTo(3perl), and yes she ate. 🎀✨

📦 where this page comes from