NAME
    String::PodQuote - Escape/quote special characters that might be
    interpreted by a POD parser

VERSION
    This document describes version 0.003 of String::PodQuote (from Perl
    distribution String-PodQuote), released on 2019-12-17.

SYNOPSIS
     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";

    will output:

     =pod

     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>";

    will output:

     L<Some description containing <, E<gt>, E<verbar>, E<sol>|Some::Module>

DESCRIPTION
FUNCTIONS
  pod_escape
    Usage:

     $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>
     >                                            E<gt>
     |                                            E<verbar>
     /                                            E<sol>
     (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>

  pod_quote
    Alias for pod_escape.

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/String-PodQuote>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-String-PodQuote>.

BUGS
    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.

SEE ALSO
    perlpod

    Tangentially related modules: HTML::Entities, URI::Escape,
    String::ShellQuote, String::Escape, String::PerlQuote.

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2019 by perlancar@cpan.org.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.

