Text::Markup::Pod(3pm) | User Contributed Perl Documentation | Text::Markup::Pod(3pm) |
Text::Markup::Pod - Pod parser for Text::Markup
use Text::Markup; my $pod = Text::Markup->new->parse(file => 'README.pod');
This is the Pod parser for Text::Markup. It runs the file through Pod::Simple::XHTML and returns the result. If the Pod contains any non-ASCII characters, the encoding must be declared either via a BOM or via the "=encoding" tag. Text::Markup::Pod recognizes files with the following extensions as Pod:
You may pass an arrayref of settings to this parser which changes the output returned. For example, to suppress an HTML header and footer, pass:
my $pod_fragment = Text::Markup->new->parse( file => 'README.pod', options => [ html_header => '', html_footer => '', ] );
This implementation makes method calls to the Pod::Simple::XHTML parser using the key as the method name and the value as the parameter list to pass.
See Pod::Simple::XHTML and Pod::Simple for the full list of options and inherited options which can be manipulated.
David E. Wheeler <david@justatheory.com>
Copyright (c) 2011-2019 David E. Wheeler. Some Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
2019-12-14 | perl v5.30.0 |