Pod::Elemental::Transformer::Verbatim - Transform :verbatim regions into verbatim paragraphs
version 0.001
In your weaver.ini:
[-Transformer / Verbatim]
transformer = Verbatim
Or in a plugin bundle:
sub mvp_bundle_config {
return (
...
[ '@Author::YOU/Verbatim', _exp('-Transformer'), { 'transformer' => 'Verbatim' } ],
);
}
This module acts as a pod transformer, using :verbatim
regions to mark sections of text for treatment as if they were verbatim paragraphs. The transformer indents the contained text by four columns, allowing the pod parser to treat them properly; see "Verbatim Paragraph" in perlpod.
That is, this pod:
=begin :verbatim
Here is some text.
=end :verbatim
Is transformed to:
Here is some text
Note that a single paragraph can be simply noted with =for :verbatim
rather than using =begin :verbatim
and =end :verbatim
lines.
This attribute (defaulting to verbatim
) is the region format that will be processed by this transformer.
Given a pod document object, returns the object with all its children with :verbatim
directives removed and appropriate content replaced with Pod::Elemental::Element::Pod5::Verbatim objects.
Bugs may be submitted through the RT bug tracker (or bug-Pod-Elemental-Transformer-Verbatim@rt.cpan.org). I am also usually active on irc, as 'ether' at irc.perl.org
.
Karen Etheridge <ether@cpan.org>
This software is copyright (c) 2015 by Karen Etheridge.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.