dhmakeperl::podparser(3pm) [debian man page]
DhMakePerl::PodParser(3pm) User Contributed Perl Documentation DhMakePerl::PodParser(3pm) NAME
DhMakePerl::PodParser - internal helper module for DhMakePerl SYNOPSIS
DhMakePerl::PodParser is used by DhMakePerl to extract some information from the module-to-be-packaged. It subclasses from Pod::Parser - Please refer to it for further documentation. METHODS
set_names Defines the names of the sections that should be fetched from the POD get Gets the contents for the specified POD section. The single argument should be one of the values given to "set_names". cleanup Empties the information held by the parser object command Overrides base class' Pod::Parser command method. Gets each of the POD's commands (sections), and defines how it should react to each of them. In this particular implementation, it basically filters out anything except for the "=head" sections defined in "set_names". add_text Hands back the text it received as it ocurred in the input stream (see the Pod::Parser's documentation for verbatim, textblock and interior_sequence). Content is ignored if more than 15 lines away from the section start. verbatim Called by Pod::Parser for verbatim paragraphs. Redirected to "add_text". textblock Called by Pod::Parser for ordinary text paragraphs. Redirected to "add_text". interior_sequence interior_sequence() is called by Pod::Parser when, eh, an interiorsquence occureds in the text. Interior sequences are things like I<...>. This implementation decodes "gt", "lt", "sol", "verbar" and numeric character codes, all used by "E" escape. SEE ALSO
Pod::Parser AUTHOR
Paolo Molaro Documentation added by Gunnar Wolf and Damyan Ivanov COPYRIGHT &; LICENSE Copyright (C) 2001, Paolo Molaro <lupus@debian.org> Copyright (C) 2008, Gunnar Wolf <gwolf@debian.org> Copyright (C) 2008, Damyan Ivanov <dmn@debian.org> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. perl v5.14.2 2012-01-15 DhMakePerl::PodParser(3pm)
Check Out this Related Man Page
Pod::ParseLink(3pm) Perl Programmers Reference Guide Pod::ParseLink(3pm) NAME
Pod::ParseLink - Parse an L<> formatting code in POD text SYNOPSIS
use Pod::ParseLink; my ($text, $inferred, $name, $section, $type) = parselink ($link); DESCRIPTION
This module only provides a single function, parselink(), 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 "url", "pod", or "man", indicating a URL, a link to a POD page, or a link to a Unix manual page. 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>). The inferred anchor text is implemented per perlpodspec: L<name> => L<name|name> L</section> => L<"section"|/section> L<name/section> => L<"section" in name|name/section> 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. 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. No attempt is made to resolve formatting codes. This must be done after calling parselink() (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: L<verticalE<verbar>barE<sol>slash> which should be interpreted as a link to the "vertical|bar/slash" POD page and not as a link to the "slash" section of the "bar" POD page with an anchor text of "vertical". 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. SEE ALSO
Pod::Parser The current version of this module is always available from its web site at <http://www.eyrie.org/~eagle/software/podlators/>. AUTHOR
Russ Allbery <rra@stanford.edu>. COPYRIGHT AND LICENSE
Copyright 2001, 2008, 2009 Russ Allbery <rra@stanford.edu>. This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself. perl v5.16.2 2012-08-26 Pod::ParseLink(3pm)