String::PodQuote - Escape/quote special characters that might be interpreted by a POD parser
This document describes version 0.003 of String::PodQuote (from Perl distribution String-PodQuote), released on 2019-12-17.
use String::PodQuote qw(pod_escape);
Putting a text as-is in an ordinary paragraph:
print "=pod\n\n", pod_escape("First paragraph containing C<=>.\n\n Second indented paragraph.\n\n"), "=cut\n\n";
First paragraph containing CE<lt>=E<gt>.
E<32> Second indented paragraph.
Putting text inside a POD link:
print "L<", pod_escape("Some description containing <, >, |, /"), "|Some::Module>";
L<Some description containing <, E<gt>, E<verbar>, E<sol>|Some::Module>
$escaped = pod_escape($text);
Quote special characters that might be interpreted by a POD parser.
The following characters are escaped:
Character Escaped into
< (only when preceded by a capital letter) E<lt>
(Space) (only at beginning of string/line) E<32>
(Tab) (only at beginning of string/line) E<9>
= (only at beginning of string/line) E<61>
Alias for pod_escape.
Please visit the project's homepage at https://metacpan.org/release/String-PodQuote.
Source repository is at https://github.com/perlancar/perl-String-PodQuote.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=String-PodQuote
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Tangentially related modules: HTML::Entities, URI::Escape, String::ShellQuote, String::Escape, String::PerlQuote.
This software is copyright (c) 2019 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install String::PodQuote, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.