Pod::Html::Util(3p) Perl Programmers Reference Guide Pod::Html::Util(3p)

Pod::Html::Util(3p) Perl Programmers Reference Guide Pod::Html::Util(3p) #

Pod::Html::Util(3p) Perl Programmers Reference Guide Pod::Html::Util(3p)

NNAAMMEE #

 Pod::Html::Util - helper functions for Pod-Html

SSUUBBRROOUUTTIINNEESS #

 NNoottee:: While these functions are importable on request from
 _P_o_d_:_:_H_t_m_l_:_:_U_t_i_l, they are specifically intended for use within (a) the
 _P_o_d_-_H_t_m_l distribution (modules and test programs) shipped as part of the
 Perl 5 core and (b) other parts of the core such as the _i_n_s_t_a_l_l_h_t_m_l
 program.  These functions may be modified or relocated within the core
 distribution -- or removed entirely therefrom -- as the core's needs
 evolve.  Hence, you should not rely on these functions in situations
 other than those just described.

“"pprroocceessss__ccoommmmaanndd__lliinnee(())“” Process command-line switches (options). Returns a reference to a hash. Will provide usage message if “–help” switch is present or if parameters are invalid.

 Calling this subroutine may modify @ARGV.

“"uussaaggee(())“” Display customary Pod::Html usage information on STDERR.

“"uunniixxiiffyy(())“” Ensure that _P_o_d_:_:_H_t_m_l’s internals and tests handle paths consistently across Unix, Windows and VMS.

“"rreellaattiivviizzee__uurrll(())“” Convert an absolute URL to one relative to a base URL. Assumes both end in a filename.

“"hhttmmll__eessccaappee(())“” Make text safe for HTML.

“"hhttmmlliiffyy(())“” htmlify($heading);

 Converts a pod section specification to a suitable section specification
 for HTML. Note that we keep spaces and special characters except "", ?"
 (Netscape problem) and the hyphen (writer's problem...).

“"aanncchhoorriiffyy(())“” anchorify(@heading);

 Similar to "htmlify()", but turns non-alphanumerics into underscores.
 Note that "anchorify()" is not exported by default.

“"ttrriimm__lleeaaddiinngg__wwhhiitteessppaaccee(())“” Remove any level of indentation (spaces or tabs) from each code block consistently. Adapted from: https://metacpan.org/source/HAARG/MetaCPAN-Pod-XHTML-0.002001/lib/Pod/Simple/Role/StripVerbatimIndent.pm

perl v5.36.3 2023-02-15 Pod::Html::Util(3p)