Help language development. Donate to The Perl Foundation

Pod::To::Anything cpan:TYIL last updated on 2020-01-17

README.pod6
=begin pod

=NAME    Pod::To::Anything
=AUTHOR  Patrick Spek <[email protected]>
=VERSION 0.0.0

=head1 Synopsis

=begin code
use Pod::To::Anything;
use Pot::To::Anything::Subsets;
=end code

=head1 Description

A base class to easily build RakuN<Formerly known as Perl 6> Pod converters
with.

=head1 Installation

=head2 Through C<zef>

L<zef|https://github.com/ugexe/zef> is the standard distribution manager for
L<Raku|https://raku.org>. If you're using an end-user distribution like
L<Rakudo Star|https://rakudo.org/files/star>, it will be installed for you by
default.

C<zef> will install the latest available version from
L<CPAN|http://www.cpan.org/modules/index.html>.

=begin code :lang<sh>
zef install Pod::To::Anything
=end code

=head1 Usage

You will need to include the two packages exposed by this module.

=begin input
use Pod::To::Anything;
use Pot::To::Anything::Subsets;
=end input

Now you can make a new class that implements the C<Pod::To::Anything> role.

=begin input
class Foo does Pod::To::Anything { }
=end input

You will need to implement all the supported L<Pod6
elements|https://docs.raku.org/language/pod#Block_types>. Don't worry too much
about missing one, as the compiler will complain about any you missed. For
reference, you will need to implement the following methods.

=begin code
multi method render (Pod::Block::Code:D $ --> Str) { … }
multi method render (Pod::Block::Declarator:D $ --> Str) { … }
multi method render (Pod::Block::Named::Author:D $ --> Str) { … }
multi method render (Pod::Block::Named::Name:D $ --> Str) { … }
multi method render (Pod::Block::Named::Subtitle:D $ --> Str) { … }
multi method render (Pod::Block::Named::Title:D $ --> Str) { … }
multi method render (Pod::Block::Named::Version:D $ --> Str) { … }
multi method render (Pod::Block::Named::Pod:D $ --> Str) { … }
multi method render (Pod::Block::Para:D $ --> Str) { … }
multi method render (Pod::Block::Table:D $ --> Str) { … }
multi method render (Pod::FormattingCode::B:D $ --> Str) { … }
multi method render (Pod::FormattingCode::C:D $ --> Str) { … }
multi method render (Pod::FormattingCode::E:D $ --> Str) { … }
multi method render (Pod::FormattingCode::I:D $ --> Str) { … }
multi method render (Pod::FormattingCode::K:D $ --> Str) { … }
multi method render (Pod::FormattingCode::L:D $ --> Str) { … }
multi method render (Pod::FormattingCode::N:D $ --> Str) { … }
multi method render (Pod::FormattingCode::P:D $ --> Str) { … }
multi method render (Pod::FormattingCode::R:D $ --> Str) { … }
multi method render (Pod::FormattingCode::T:D $ --> Str) { … }
multi method render (Pod::FormattingCode::U:D $ --> Str) { … }
multi method render (Pod::FormattingCode::V:D $ --> Str) { … }
multi method render (Pod::FormattingCode::X:D $ --> Str) { … }
multi method render (Pod::Heading:D $ --> Str) { … }
multi method render (Pod::Item:D $ --> Str) { … }
=end code

There are two convenience methods exposed by C<Pod::To::Anything>: C<.traverse>
and C<.unpod>. The former will traverse all the Pod6 elements contained in a
given Pod6 element. The latter will do almost the same, except it will turn
everything into plain strings, losing all markup value from Pod6 elements.

=head2 Examples

=item L<C<Pod::To::HTML::Section>|https://home.tyil.nl/git/raku/Pod::To::HTML::Section/>

=head1 Contributing

=head2 Reporting bugs or other feedback

Any bugs or other feedback can be sent to my email address. I generally try to
respond to all mail within 24 hours.

=head2 Proposing code patches

Code patches can also be sent in through email. If you need help to send git
patches through email, you may want to read up on
L<git-send-email.io|https://git-send-email.io/>.

=head1 License

This module is distributed under the terms of the GNU AGPL, version 3.0.

=end pod