1Pod::Html::Util(3pm)   Perl Programmers Reference Guide   Pod::Html::Util(3pm)
2
3
4

NAME

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

SUBROUTINES

9       Note: While these functions are importable on request from
10       Pod::Html::Util, they are specifically intended for use within (a) the
11       Pod-Html distribution (modules and test programs) shipped as part of
12       the Perl 5 core and (b) other parts of the core such as the installhtml
13       program.  These functions may be modified or relocated within the core
14       distribution -- or removed entirely therefrom -- as the core's needs
15       evolve.  Hence, you should not rely on these functions in situations
16       other than those just described.
17
18   process_command_line()
19       Process command-line switches (options).  Returns a reference to a
20       hash.  Will provide usage message if "--help" switch is present or if
21       parameters are invalid.
22
23       Calling this subroutine may modify @ARGV.
24
25   usage()
26       Display customary Pod::Html usage information on STDERR.
27
28   unixify()
29       Ensure that Pod::Html's internals and tests handle paths consistently
30       across Unix, Windows and VMS.
31
32   relativize_url()
33       Convert an absolute URL to one relative to a base URL.  Assumes both
34       end in a filename.
35
36   html_escape()
37       Make text safe for HTML.
38
39   htmlify()
40           htmlify($heading);
41
42       Converts a pod section specification to a suitable section
43       specification for HTML. Note that we keep spaces and special characters
44       except "", ?" (Netscape problem) and the hyphen (writer's problem...).
45
46   anchorify()
47           anchorify(@heading);
48
49       Similar to htmlify(), but turns non-alphanumerics into underscores.
50       Note that anchorify() is not exported by default.
51
52   trim_leading_whitespace()
53       Remove any level of indentation (spaces or tabs) from each code block
54       consistently.  Adapted from:
55       https://metacpan.org/source/HAARG/MetaCPAN-Pod-XHTML-0.002001/lib/Pod/Simple/Role/StripVerbatimIndent.pm
56
57
58
59perl v5.38.2                      2023-11-30              Pod::Html::Util(3pm)
Impressum