Perl::Examples::POD::Escape - Show the various examples of escaping
This document describes version 0.096 of Perl::Examples::POD::Escape (from Perl distribution Perl-Examples), released on 2023-02-24.
To make the whole paragraph as verbatim, thus avoiding any interior sequences from being interpreted, you indent the paragraph with at least one whitespace, example:
This is a verbatim paragraph. Interior sequences like I<italic> and B<bold> will not be interpreted but shown as is.
They are akin to <PRE> in HTML.
<PRE>
To escape a character, use the E<> interior sequence, which is similar to &foo; entities in HTML. For example: E<gt> (will be rendered as >), E<lt> (will be rendered as <). See perlpod for the full list.
&foo;
E<gt>
E<lt>
To make an inline text as verbatim, you use the C<> interior sequence, for example: C<literal> (will be rendered as literal), C<>> (will be rendered as >). This is similar to <CODE> in HTML.
C<>
C<literal>
literal
C<>>
>
<CODE>
Interior sequence can be written with a single angle bracket pair (C<foo>, C<foo>) or double angle bracket + whitespace (C<< foo >>, B<< foo >>). The latter is useful if you have literal < and > inside the sequence, e.g. C<< <TAG> >> (will be rendered as <TAG>).
C<foo>
C<< foo >>
B<< foo >>
C<< <TAG> >>
<TAG>
The interior sequence can contain one another, so another way to write verbatim:
<foo>
aside from:
C<< <foo> >>
is:
C<E<lt>fooE<gt>>
Another example:
I<E<lt>italicE<gt>>
(will be rendered as <italic>).
Please visit the project's homepage at https://metacpan.org/release/Perl-Examples.
Source repository is at https://github.com/perlancar/perl-Perl-Examples.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2023, 2020, 2018, 2016, 2015 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Examples
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.
To install Perl::Examples, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl::Examples
CPAN shell
perl -MCPAN -e shell install Perl::Examples
For more information on module installation, please visit the detailed CPAN module installation guide.