NAME
Perl::Examples::POD::Link - Show the various examples of links
VERSION
This document describes version 0.096 of Perl::Examples::POD::Link (from Perl distribution Perl-Examples), released on 2023-02-24.
SYNOPSIS
target link text syntax note
----------- ---- ------ ----
Perl module's POD no L<Foo::Bar>
Perl module's POD yes L<that module|Foo::Bar>
Perl module's POD + section no L<Foo::Bar/"SEE ALSO">
Perl module's POD + section yes L<that module's See Also section|Foo::Bar/"SEE ALSO">
section in the same POD no L</"SEE ALSO">
section in the same POD yes L<See Also section|/"SEE ALSO">
Perl script no L<httpthis>
Perl script yes L<that script|httpthis>
manpage no L<ls(1)> MetaCPAN renders this
URL no L<http://www.example.com/page>
URL yes L<that page|http://www.example.com/pages>
DESCRIPTION
Links to POD
Link to module
L<Perl::Examples>
Rendered result: Perl::Examples
Link to module + section
L<Perl::Examples/"SEE ALSO">
Rendered result: "SEE ALSO" in Perl::Examples
Link this page + section
L</"URL links">
Rendered result: "URL links"
Link to module with text
L<The Perl-Examples main module|Perl::Examples>
Rendered result: The Perl-Examples main module
Link to module with text + section
L<The description of Perl-Examples main module|Perl::Examples/"DESCRIPTION">
Rendered result: The description of Perl-Examples main module
Link this page with text + section
L<A collection of URL links|/"URL links">
Rendered result: A collection of URL links
Link to script
L<perl-example-die>
Rendered result: perl-example-die
Links to manpage
URL links
URL without text
L<http://www.example.com/page.html>
Rendered result: http://www.example.com/page.html
URL with text
L<An example page|http://www.example.com/page.html>
Rendered result: An example page
http scheme with port
L<http://www.example.com:8001/>
Rendered result: http://www.example.com:8001/
https scheme
L<https://www.example.com/>
Rendered result: https://www.example.com/
ftp scheme
L<ftp://ftp.example.com/>
Rendered result: ftp://ftp.example.com/
mailto scheme
L<mailto:example@example.com>
Rendered result: mailto:example@example.com
Some custom scheme
L<foo://bar>
Rendered result: foo://bar
POD link in head2
Rendered result: Perl::Examples
URL link in head2
http://www.example.com/head2.html
Rendered result: http://www.example.com/head2.html
Links in bullet points
Not links
L<link in verbatim is not link|Perl::Example>
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Perl-Examples.
SOURCE
Source repository is at https://github.com/perlancar/perl-Perl-Examples.
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
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.
COPYRIGHT AND LICENSE
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.
BUGS
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.