diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3/Pod::ParseLink.3perl | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3/Pod::ParseLink.3perl')
-rw-r--r-- | upstream/archlinux/man3/Pod::ParseLink.3perl | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/Pod::ParseLink.3perl b/upstream/archlinux/man3/Pod::ParseLink.3perl new file mode 100644 index 00000000..f4869da8 --- /dev/null +++ b/upstream/archlinux/man3/Pod::ParseLink.3perl @@ -0,0 +1,135 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "Pod::ParseLink 3perl" +.TH Pod::ParseLink 3perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +Pod::ParseLink \- Parse an L<> formatting code in POD text +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 3 +\& use Pod::ParseLink; +\& my $link = get_link(); +\& my ($text, $inferred, $name, $section, $type) = parselink($link); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This module only provides a single function, \fBparselink()\fR, which takes the +text of an L<> formatting code and parses it. It returns the +anchor text for the link (if any was given), the anchor text possibly +inferred from the name and section, the name or URL, the section if any, +and the type of link. The type will be one of \f(CW\*(C`url\*(C'\fR, \f(CW\*(C`pod\*(C'\fR, or \f(CW\*(C`man\*(C'\fR, +indicating a URL, a link to a POD page, or a link to a Unix manual page. +.PP +Parsing is implemented per perlpodspec. For backward compatibility, +links where there is no section and name contains spaces, or links where the +entirety of the link (except for the anchor text if given) is enclosed in +double-quotes are interpreted as links to a section (L</section>). +.PP +The inferred anchor text is implemented per perlpodspec: +.PP +.Vb 3 +\& L<name> => L<name|name> +\& L</section> => L<"section"|/section> +\& L<name/section> => L<"section" in name|name/section> +.Ve +.PP +The name may contain embedded E<> and Z<> formatting codes, +and the section, anchor text, and inferred anchor text may contain any +formatting codes. Any double quotes around the section are removed as part +of the parsing, as is any leading or trailing whitespace. +.PP +If the text of the L<> escape is entirely enclosed in double +quotes, it's interpreted as a link to a section for backward +compatibility. +.PP +No attempt is made to resolve formatting codes. This must be done after +calling \fBparselink()\fR (since E<> formatting codes can be used to +escape characters that would otherwise be significant to the parser and +resolving them before parsing would result in an incorrect parse of a +formatting code like: +.PP +.Vb 1 +\& L<verticalE<verbar>barE<sol>slash> +.Ve +.PP +which should be interpreted as a link to the \f(CW\*(C`vertical|bar/slash\*(C'\fR POD page +and not as a link to the \f(CW\*(C`slash\*(C'\fR section of the \f(CW\*(C`bar\*(C'\fR POD page with an +anchor text of \f(CW\*(C`vertical\*(C'\fR. Note that not only the anchor text will need to +have formatting codes expanded, but so will the target of the link (to deal +with E<> and Z<> formatting codes), and special handling of +the section may be necessary depending on whether the translator wants to +consider markup in sections to be significant when resolving links. See +perlpodspec for more information. +.SH AUTHOR +.IX Header "AUTHOR" +Russ Allbery <rra@cpan.org> +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyright 2001, 2008, 2009, 2014, 2018\-2019, 2022 Russ Allbery <rra@cpan.org> +.PP +This program is free software; you may redistribute it and/or modify it +under the same terms as Perl itself. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +Pod::Parser +.PP +The current version of this module is always available from its web site at +<https://www.eyrie.org/~eagle/software/podlators/>. |