lib/Marek/Pod/HTML.pm

filter: Statementstmt 9.2% 66 / 717 Branchbran 2.0% 6 / 300 Conditioncond 0.0% 0 / 121 MC/DCmcdc 0.0% 0 / 63 Subroutinesub 24.3% 10 / 41 Podpod 42.8% 6 / 14 totaltotal 7.0% 88 / 1256 CC 212 SCAR 66.5
CC
212
Cov
6%
pod2html
1928.0
command
1190.0
_expand_ptree
1190.0
CRAP 770.9
↑ Summary script/mpod2html »
1 # -*- perl -*-
2 #############################################################################
3 # Pod/HTML.pm -- converts Pod to HTML
4 #
5 # Copyright (C) 1999,2000 by Marek Rouchal. All rights reserved.
6 # This package is free software; you can redistribute it and/or modify
7 # it under the same terms as Perl itself.
8 #############################################################################
9  
10 package Marek::Pod::HTML;
11  
12 =head1 NAME
13  
14 Marek::Pod::HTML - convert Perl POD documents to HTML
15  
16 =head1 SYNOPSIS
17  
18 use Marek::Pod::HTML;
19 pod2html( { -dir => 'html' },
20 { '/usr/lib/perl5/Pod/HTML.pm' => 'Pod::HTML' });
21  
22 =head1 DESCRIPTION
23  
24 THIS IS PRELIMINARY SOFTWARE! The C<Marek::> namespace is strictly
25 preliminary until a regular place in CPAN is found.
26  
27 B<Marek::Pod::HTML> converts one or more Pod documents into individual HTML
28 files. This is meant to be a successor of Tom Christiansen's original
29 Pod::HTML. However it is not a plug-in replacement as there are
30 significant differences.
31  
32 When no document is specified, this script acts as a filter
33 (from STDIN to STDOUT). No index or table of contents is generated.
34 In any other case one or more corresponding F<.html> file(s) is/are
35 created.
36  
37 Optionally B<Marek::Pod::HTML> can generate a table of contents and an index.
38 As it makes use of the L<HTML::Element|HTML::Element> module, it can
39 also generate Postscript output using L<HTML::FormatPS|HTML::FormatPS>.
40  
41 There is a hook for customization of the translation result before
42 writing the actual HTML.
43  
44 =head2 Pod directives and their translation
45  
46 The following section gives an overview of the translation equivalences.
47  
48 =over 4
49  
50 =item C<=head>I<n>
51  
52 A heading is turned into a HTML heading, e.g. C<=head1> corresponds to
53 C<E<lt>H2E<gt>>. The C<E<lt>H1E<gt>> heading is reserved for page titles.
54  
55 =item S<C<=over> I<n>>, C<=item>, C<=back>
56  
57 Itemized lists are turned into either C<E<lt>OLE<gt>> (numbered list),
58 C<E<lt>ULE<gt>> (buletted list), or C<E<lt>DLE<gt>> (definition list),
59 depending on whether the first item in the list starts with a digit,
60 a number or nothing, or anything else, respectively.
61  
62 =item C<S<=for html>>, C<S<=begin html>>, C<=end>
63  
64 Paragraphs starting with C<=for html> or encapsulated in
65 C<S<=begin html>> are parsed as HTML and included into the document.
66 All other C<=for>/C<=begin> paragraphs are ignored.
67  
68 =item C<BE<lt>...E<gt>>
69  
70 Turned into bold text using E<lt>BE<gt>...E<lt>/BE<gt>.
71  
72 =item C<IE<lt>...E<gt>>
73  
74 Turned into italic text using E<lt>IE<gt>...E<lt>/IE<gt>.
75  
76 =item C<CE<lt>...E<gt>> C<FE<lt>...E<gt>>
77  
78 Turned into monospaced (typewriter) text using
79 E<lt>CODEE<gt>...E<lt>/CODEE<gt>.
80  
81 =item C<EE<lt>...E<gt>>
82  
83 Pod entities are mapped to the corresponding HTML characters or
84 entities. The most important HTML entities (e.g. C<EE<lt>copyE<gt>>)
85 are recognized. See also L<HTML::Entities>.
86  
87 =item C<SE<lt>...E<gt>>
88  
89 All whitespace in this sequence is turned into C<&nbsp;>, i.e.
90 non-breakable spaces.
91  
92 =item C<XE<lt>...E<gt>>
93  
94 The text of this sequence is included in the index (along with all
95 non-trivial C<=item> entries), pointing to the place of its ocurrence
96 in the text.
97  
98 =item C<LE<lt>...E<gt>>
99  
100 Pod hyperlinks are turned into active HTML hyperlinks if the destination
101 has been found in the Pod documents processed in this conversion session.
102 Otherwise the link text is simply underlined.
103  
104 Note: There is no caching mechanism for deliberate reasons: a) One does
105 not run huge conversion jobs three times a day, so performance is not
106 the most important goal, b) caching is hard to code, and c) although
107 following conversion jobs could make profit of the existing cache of
108 destination nodes in the already converted documents, these will not
109 notice that some of their previously unresolved links may now be ok
110 because the required document has been converted. Conclusion: Run
111 B<pod2html> over I<all> your Pod documents after adding new ones and
112 you will have a consistent state.
113  
114 As a special unofficial feature HTML hyperlinks are also supported:
115 C<LE<lt>http://www.perl.comE<gt>>.
116  
117 =back
118  
119 =head2 Options
120  
121 B<mpod2html> recognizes the following options. Those passed to the
122 B<Marek::Pod::HTML> class directly are marked with (*).
123  
124 =over 4
125  
126 =item B<-converter> I<module>
127  
128 The converter class to use, defaults to C<Marek::Pod::HTML>. This hook allows
129 for simple customization, see also L<"Customizing">.
130  
131 =item B<-suffix> I<string>
132  
133 Use this string for links to other converted Pod documents. The default
134 is C<.html> and also sets the filename suffix unless B<-filesuffix> has
135 been specified. The dot must be included!
136  
137 =item B<-filesuffix> I<string>
138  
139 Use this string as a suffix for the output HTML files. This does not
140 change the suffix used in the hyperlinks to different documents. This
141 feature is meant to be used if some (Makefile based) postprocessing
142 of the generated files has to be performed, but without having to
143 adapt the links.
144  
145 =item B<-dir> I<path>
146  
147 Write the generated HTML files (can be a directory hierarchy) to this
148 path. The default is the current working directory.
149  
150 =item B<-libpods> I<name1,name2,...>
151  
152 This option activates a highly magical feature: The C<=item> nodes of
153 the specified Pod documents (given by Pod name, e.g. C<Pod::Parser>)
154 serve as destinations for highlighted text in all converted Pod
155 documents. Typical usage: When converting your Perl installation's
156 documentation, you may want to say
157  
158 pod2html -libpods perlfunc,perlvar,perlrun -script -inc
159  
160 then you will get a hyperlink to L<perlvar|perlvar> in the text
161 C<IE<lt>$|E<gt>>.
162  
163 =item B<-localtoc> I<bool>
164  
165 This is by default true, so that at the top of the page a local
166 table of contents with all the C<=head>I<n> lines is generated.
167  
168 =item B<-navigation> I<bool>
169  
170 When using the default customization, this flag enables or disables
171 the navigation in the header of each Pod document.
172  
173 =item B<-toc> I<bool>
174  
175 If true, a table of contents is built from the processed Pod documents.
176  
177 =item B<-idx> I<bool>
178  
179 If true, an index is built from all C<=item>s of the processed Pod
180 documents.
181  
182 =item B<-idxopt> I<options>
183  
184 Options for index building. Default is "item,x", which means that
185 item strings as well as text marked up with C<XE<lt>...E<gt>>
186 generate entries in the index.
187  
188 =item B<-tocname> I<name>
189  
190 Use I<name> as the filename of the table of contents. Default is
191 F<podtoc>. The general file suffix is added to this name.
192  
193 =item B<-idxname> I<name>
194  
195 Use I<name> as the filename of the index. Default is
196 F<podindex>. The general file suffix is added to this name.
197  
198 =item B<-toctitle> I<string>
199  
200 The string that is used as the heading of the table of contents.
201 Default is `Table of Contents'.
202  
203 =item B<-idxtitle> I<string>
204  
205 The string that is used as the heading of the table of contents.
206 Default is `Index'.
207  
208 =item B<-ps> I<bool>
209  
210 In addition to HTML, generate also Postscript output. The suffix is
211 F<.ps>.
212  
213 =item B<-psdir>
214  
215 The root directory where to write Postscript files. Defaults to the
216 same as B<-dir>.
217  
218 =item B<-psfont> I<fontname>
219  
220 Generate Postscript files using the font I<fontname>. Default is
221 `Helvetica'.
222  
223 =item B<-papersize> I<size>
224  
225 Generate Postscript files using the paper size I<size>. Default is
226 `A4'.
227  
228 =item B<-warnings> I<bool>
229  
230 When processing the first pass, print warnings. See L<Pod::Checker>
231 for more information on warnings. Note: This can procude a lot of
232 output if the Pod source does not correspond to strict guidelines.
233  
234 =item B<-stylesheet> I<link>
235  
236 The (optional) link to a style sheet, which is included in the resulting HTML
237 as
238  
239 <LINK TYPE="text/css" REL="stylesheet" HREF=$link>
240  
241 =item B<-banner> I<bool>
242  
243 If true, a banner is included at the bottom of the generated
244 page. Default is true.
245  
246 =back
247  
248 =cut
249  
250 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
251 4 ▶use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
Subroutine BEGIN: called CC=1 SCAR=0.0
252  
253 4 require Exporter;
254 4 ▶use File::Basename;
Subroutine BEGIN: called CC=1 SCAR=0.0
255 4 ▶use File::Path;
Subroutine BEGIN: called CC=1 SCAR=0.0
256 4 ▶use Pod::Parser;
Subroutine BEGIN: called CC=1 SCAR=0.0
257 4 ▶use Pod::Checker;
Subroutine BEGIN: called CC=1 SCAR=0.0
258 4 ▶use HTML::Entities;
Subroutine BEGIN: called CC=1 SCAR=0.0
259 4 ▶use HTML::TreeBuilder;
Subroutine BEGIN: called CC=1 SCAR=0.0
260  
261 4 $VERSION = '0.49';
262 4 @ISA = qw(Exporter Pod::Parser);
263  
264 4 @EXPORT = qw();
265 4 @EXPORT_OK = qw(&pod2html &_construct_file_name);
266  
267 ##############################################################################
268  
269 # this is used everywhere
270 4 my $NBSP = HTML::Entities::decode_entities('&nbsp;');
271  
272 # This makes HTML::Element print properly opened and closed <P> tags
273 4 $HTML::Tagset::optionalEndTag{'p'} = 0;
274  
275 ##---------------------------------
276 ## Function definitions begin here
277 ##---------------------------------
278  
279 2 ▶sub pod2html {
Subroutine pod2html: called CC=54 SCAR=75.6
Pod undocumented
280 2 my (%opts,%PODS);
281 # options hash
282 2 ▶ if(ref $_[0]) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $_[0]) 2 0 2
283 2 %opts = %{shift()};
284 }
285 # PODs hash
286 2 ▶ if(ref $_[0]) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $_[0]) { } 2 0 2
287 2 %PODS = %{shift()};
288 }
289 else {
290 0 %PODS = map { $_ => do {
291 0 ▶ my $name = ref($_) ? 'STDIN' : $_;
Branch: 1 branch
BranchTrueFalseTotal
ref $_ ? : 0 0 0
292 0 $name =~ s:^.*/::;
293 0 $name =~ s:\.(pod|pm|pl)$::i;
294 0 ▶ $name =~ s:\.(bat|exe|cmd)$::i if($^O =~ /win|os2/i);
Branch: 1 branch
BranchTrueFalseTotal
if $^O =~ /win|os2/i 0 0 0
295 0 $name;
296 } } @_;
297 }
298 # set defaults
299 2 _default(\%opts, '-converter', 'Marek::Pod::HTML');
300 2 _default(\%opts, '-filter', 0);
301 2 _default(\%opts, '-suffix', '.html');
302 2 _default(\%opts, '-filesuffix', $opts{-suffix});
303 2 _default(\%opts, '-dir', '.');
304 2 _default(\%opts, '-libpods', '');
305 2 _default(\%opts, '-localtoc', 1);
306 2 _default(\%opts, '-navigation', 1);
307 2 _default(\%opts, '-toc', 1);
308 2 _default(\%opts, '-idx', 1);
309 2 _default(\%opts, '-tocname', 'podtoc');
310 2 _default(\%opts, '-idxname', 'podindex');
311 2 _default(\%opts, '-toctitle', 'Table of Contents');
312 2 _default(\%opts, '-idxtitle', 'Index');
313 2 _default(\%opts, '-ps', 0);
314 2 _default(\%opts, '-psdir', $opts{-dir});
315 2 _default(\%opts, '-psfont', 'Helvetica');
316 2 _default(\%opts, '-papersize', 'A4');
317 2 _default(\%opts, '-warnings', 0);
318 2 _default(\%opts, '-verbose', 0);
319 2 _default(\%opts, '-stylesheet', '');
320 2 _default(\%opts, '-banner', 1);
321 2 _default(\%opts, '-idxopt', 'item,x');
322 # only a single file?
323 2 ▶ if($opts{-filter}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-filter"}) 0 2 2
324 0 $opts{-toc} = $opts{-idx} = 0;
325 }
326 # nothing to do
327 2 ▶ return 0 unless(keys %PODS);
Branch: 1 branch
BranchTrueFalseTotal
unless keys %PODS 0 2 2
328  
329 ###################################################
330 # first pass: run Pod::Checker on all the files
331 # and extract hyperlink nodes
332 ###################################################
333  
334 2 my $cache = Pod::Cache->new();
335 0 foreach my $infile (sort keys %PODS) {
336 0 ▶ warn "\n+++ Scanning $infile\n" if($opts{-verbose});
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-verbose"} 0 0 0
337 ## Now create a pod scanner, based on Pod::Checker
338 my $scanner = Pod::Checker->new(-warnings => $opts{'-warnings'},
339 0 ▶ -name => $PODS{$infile} || 'STDIN');
Condition0%0/2
$PODS{$infile} || 'STDIN'
l!l
00
MC/DC0%0/1
$PODS{$infile} || 'STDIN'
$PODS{$infile}
Truth table0%0/2
A
A= $PODS{$infile}
Aresult
11
00
340  
341 ## Now check the pod document for errors
342 0 $scanner->parse_from_file($infile, \*STDERR);
343
344 ## Return the number of errors found
345 0 my $errs = $scanner->num_errors();
346 0 ▶ if($errs == -1) {
Branch: 2 branches
BranchTrueFalseTotal
if ($errs == -1) { } 0 0 0
elsif ($errs > 0) { } 0 0 0
347 warn "Warning: No POD in `$infile', skipping\n"
348 0 ▶ if($opts{'-warnings'});
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-warnings"} 0 0 0
349 0 next;
350 }
351 elsif($errs > 0) {
352 0 warn "Warning: Conversion may be garbled because of errors above\n";
353 }
354  
355 0 my $name = $scanner->name();
356 # also allow X<> entries as link destinations
357 0 my @nodes = _unique_ids($scanner->node()); #,$scanner->idx());
358  
359 # hack for perlrun - get the nodes for all switches
360 0 ▶ if($name eq 'perlrun') {
Branch: 1 branch
BranchTrueFalseTotal
if ($name eq "perlrun") 0 0 0
361 0 my @addnodes = ();
362 0 my %have = map { $_->[0] => 1 } @nodes;
363 0 foreach(@nodes) {
364 0 ▶ if($_->[0] =~ /^(-\w)\S/ && !$have{$1}++) {
Branch: 1 branch
BranchTrueFalseTotal
if ($_->[0] =~ /^(-\w)\S/ and not $have{$1}++) 0 0 0
Condition0%0/3
$_->[0] =~ /^(-\w)\S/ and not $have{$1}++
!ll&&!rl&&r
000
MC/DC0%0/2
$_->[0] =~ /^(-\w)\S/ and not $have{$1}++
$_->[0] =~ /^(-\w)\S/ not $have{$1}++
Truth table0%0/3
A and not(B)
A= $_->[0] =~ /^(-\w)\S/B= not $have{$1}++
ABresult
0X0
100
111
365 0 push(@addnodes, [ $1 , $_->[1] ]);
366 }
367 }
368 0 push(@nodes,@addnodes);
369 }
370
371 ## remember settings
372 $cache->item(
373 0 -file => $infile,
374 -page => $name,
375 -nodes => [ @nodes ],
376 -idx => [ _unique_ids($scanner->idx()) ]);
377 } # end first pass
378  
379 # build lookup table for libpods
380 0 my %lib;
381 0 foreach my $pod (split(/,/, $opts{-libpods})) {
382 0 warn "\n+++ Adding $pod to autolink lookup table\n";
383 0 my $have_it = $cache->find_page($pod);
384 0 ▶ unless($have_it) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($have_it) 0 0 0
385 0 warn "Error: Could not find the library POD '$pod'.\n";
386 0 next;
387 }
388 0 foreach ($have_it->nodes()) {
389 0 my ($name,$id) = @$_;
390 # only add significant nodes. The first libpod takes precedence
391 0 ▶ if($name ne '*' && !defined $lib{$name}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($name ne "*" and not defined $lib{$name}) 0 0 0
Condition0%0/3
$name ne "*" and not defined $lib{$name}
!ll&&!rl&&r
000
MC/DC0%0/2
$name ne "*" and not defined $lib{$name}
$name ne "*" not defined $lib{$name}
Truth table0%0/3
A and not(B)
A= $name ne "*"B= not defined $lib{$name}
ABresult
0X0
100
111
392 0 $lib{$name} = [ $have_it->page(), $id ];
393 }
394 }
395 }
396  
397 #######################################################
398 # second pass: do the conversion
399 #######################################################
400  
401 # Schwartzian transform to reduce sort effort
402 # compare case-insensitively, only in case of equality compare
403 # case sensitively
404 0 ▶ my @cache = map { $_->[0] } sort { $a->[1] cmp $b->[1] || $a->[0]->page() cmp $b->[0]->page() }
Condition0%0/3
$Marek::Pod::HTML::a->[1] cmp $Marek::Pod::HTML::b->[1] || $Marek::Pod::HTML::a->[0]->page cmp $Marek::Pod::HTML::b->[0]->page
l!l&&r!l&&!r
000
MC/DC0%0/2
$Marek::Pod::HTML::a->[1] cmp $Marek::Pod::HTML::b->[1] || $Marek::Pod::HTML::a->[0]->page cmp $Marek::Pod::HTML::b->[0]->page
$Marek::Pod::HTML::a->[1] cmp $Marek::Pod::HTML::b->[1] $Marek::Pod::HTML::a->[0]->page cmp $Marek::Pod::HTML::b->[0]->page
Truth table0%0/3
A || B
A= $Marek::Pod::HTML::a->[1] cmp $Marek::Pod::HTML::b->[1]B= $Marek::Pod::HTML::a->[0]->page cmp $Marek::Pod::HTML::b->[0]->page
ABresult
1X1
011
000
405 0 map { [ $_ , lc($_->page()) ] } $cache->item();
406 0 my @index;
407 # propagate some of the options
408 my %conv_opts;
409 0 for(qw(-suffix -navigation -localtoc -toc -tocname -toctitle -idx
410 -idxname -idxtitle -idxopt -stylesheet -verbose -banner)) {
411 0 $conv_opts{$_} = $opts{$_};
412 }
413
414 0 $conv_opts{-cache} = $cache;
415 0 $conv_opts{-lib} = \%lib;
416 0 $conv_opts{-mycache} = '';
417 0 $conv_opts{'-next'} = '';
418 0 $conv_opts{-prev} = '';
419  
420 0 ▶ for(my $i = 0; $i< scalar(@cache); $i++) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i < scalar @cache) 0 0 0
421 ## Now create a pod converter
422 0 $_ = $cache[$i];
423 0 my $infile = $_->file();
424 0 ▶ warn "\n+++ Converting $infile\n" if($opts{-verbose});
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-verbose"} 0 0 0
425  
426 0 my %current_opts = %conv_opts;
427 0 $current_opts{-name} = $_->page();
428 0 $current_opts{-mycache} = $_;
429 $current_opts{'-next'} = ($i < $#cache) ? $cache[$i+1]->page() :
430 0 ▶ ($current_opts{-idx} ? $current_opts{-idxname} : '');
Branch: 2 branches
BranchTrueFalseTotal
$i < $#cache ? : 0 0 0
$current_opts{'-idx'} ? : 0 0 0
431 $current_opts{-prev} = ($i > 0) ? $cache[$i-1]->page() :
432 0 ▶ ($current_opts{-toc} ? $current_opts{-tocname} : '');
Branch: 2 branches
BranchTrueFalseTotal
$i > 0 ? : 0 0 0
$current_opts{'-toc'} ? : 0 0 0
433  
434 0 my $converter = $opts{-converter}->new(%current_opts);
435  
436 ## Now convert it
437 0 my $outfile;
438 0 my $outpath = _construct_file_name($_->page(), 0, $opts{-filesuffix});
439 0 ▶ if($opts{-filter}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{'-filter'}) { } 0 0 0
440 0 $outfile = \*STDOUT;
441 }
442 else {
443 $outfile = $opts{-outfile} ? $opts{-outfile} :
444 0 ▶ $opts{-dir} . '/' . $outpath;
Branch: 1 branch
BranchTrueFalseTotal
$opts{'-outfile'} ? : 0 0 0
445 0 my $ddir = dirname($outfile);
446 0 ▶ mkpath($ddir) unless(-d $ddir);
Branch: 1 branch
BranchTrueFalseTotal
unless -d $ddir 0 0 0
447 }
448 0 $converter->parse_from_file($infile,$outfile);
449 0 $_->description($converter->description());
450 0 $_->path($outpath);
451 0 push(@index, map { $$_[1] = "$outpath#$$_[1]"; $$_[2] = $current_opts{-name}; $_ }
452 $converter->indices());
453 # dump postscript if requested
454 0 ▶ if($opts{-ps}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-ps"}) 0 0 0
455 0 my $pspath = $opts{-psdir} . '/' . _construct_file_name(
456 $_->page(), 0, '.ps');
457 0 my $ddir = dirname($pspath);
458 0 ▶ mkpath($ddir) unless(-d $ddir);
Branch: 1 branch
BranchTrueFalseTotal
unless -d $ddir 0 0 0
459 0 _write_ps($pspath,$converter->{_html},\%opts);
460 }
461  
462 # kill the HTML tree, required by HTML::Element
463 0 $converter->{_html}->delete();
464  
465 } # end second pass
466  
467 ################################################
468 # create a table of contents
469 ################################################
470  
471 0 ▶ if($opts{-toc}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-toc"}) 0 0 0
472 # Style classes in TOC:
473 # H1 CLASS=PODTOC : Table of contents heading
474 # TD CLASS=PODTOC_NAME : POD name (appears as link)
475 # TD CLASS=PODTOC_DESC : Description
476 0 ▶ warn "\n+++ Creating table of contents\n" if($opts{-verbose});
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-verbose"} 0 0 0
477  
478 # create a Marek::Pod::HTML object to gain access to the customize
479 # method
480 my $tocobj = bless { %conv_opts, '-next' => $cache[0]->page() },
481 0 $opts{-converter};
482 0 ($tocobj->{_html}, $tocobj->{_head}, $tocobj->{_body}) =
483 _basic_html();
484 0 $tocobj->depth(0);
485  
486 0 my $table = HTML::Element->new('table');
487 0 $tocobj->{_body}->push_content($table, "\n");
488  
489 0 foreach(sort { lc $a->page() cmp lc $b->page() } $cache->item()) {
490 0 my $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLINK',
491 href => $_->path());
492 0 $anchor->push_content($_->page());
493 0 my $row = HTML::Element->new('tr');
494 0 my $name = HTML::Element->new('td', CLASS => 'PODTOC_NAME');
495 0 my $text = HTML::Element->new('td', CLASS => 'PODTOC_DESC');
496 0 $row->push_content($name, $text);
497 0 $table->push_content($row,"\n");
498 0 $name->push_content($anchor);
499 # $desc is either a simple string or a reference to an array
500 # of HTML::Element's
501 0 ▶ if(my $desc = $_->description()) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $desc = $_->description) { } 0 0 0
502 0 ▶ $text->push_content(ref $desc ? @{$desc} : $desc);
Branch: 1 branch
BranchTrueFalseTotal
ref $desc ? : 0 0 0
503 # correct POD_LINKs
504 0 foreach($text->find_by_tag_name('a')) {
505 0 my $class = $_->attr('CLASS');
506 0 ▶ next unless($class && $class eq 'POD_LINK');
Branch: 1 branch
BranchTrueFalseTotal
unless $class and $class eq "POD_LINK" 0 0 0
Condition0%0/3
$class and $class eq "POD_LINK"
!ll&&!rl&&r
000
MC/DC0%0/2
$class and $class eq "POD_LINK"
$class $class eq "POD_LINK"
Truth table0%0/3
A and B
A= $classB= $class eq "POD_LINK"
ABresult
0X0
100
111
507 0 my $href = $_->attr('href');
508 0 $href =~ s:^(\.\./)+::; # the TOC is on top!
509 0 $_->attr('href', $href);
510 }
511 }
512 else {
513 # we have no description
514 0 $text->push_content('<no description>');
515 }
516 }
517  
518 # add all the HTML gimmicks
519 0 $tocobj->customize($opts{-toctitle});
520  
521 # write HTML file
522 _write_html($tocobj->{_html},
523 0 "$opts{-dir}/$opts{-tocname}$opts{-filesuffix}",undef,$opts{-verbose});
524  
525 # dump postscript output
526 0 ▶ if($opts{-ps}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-ps"}) 0 0 0
527 _write_ps("$opts{-psdir}/$opts{-tocname}.ps",
528 0 $tocobj->{_html}, \%opts);
529 }
530  
531 # remove the HTML
532 0 $tocobj->{_html}->delete();
533 }
534  
535 ################################################
536 # create an index
537 ################################################
538  
539 0 ▶ if($opts{-idx}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-idx"}) 0 0 0
540 # Style classes in Index:
541 # H1 CLASS=PODIDX : Index heading
542 # H2 CLASS=PODIDX : Index section heading
543 0 ▶ warn "\n+++ Creating index\n" if($opts{-verbose});
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-verbose"} 0 0 0
544  
545 my $idxobj = bless { %conv_opts, '-prev' => $cache[-1]->page() },
546 0 $opts{-converter};
547 0 ($idxobj->{_html}, $idxobj->{_head}, $idxobj->{_body}) =
548 _basic_html();
549 0 $idxobj->depth(0);
550  
551 # now generate the real index
552  
553 0 my %idx;
554 0 foreach(@index) {
555 0 my ($text,$id, $page) = @$_;
556 0 my $key;
557 0 ▶ if($text =~ /^\W*([a-z])/i) {
Branch: 2 branches
BranchTrueFalseTotal
if ($text =~ /^\W*([a-z])/i) { } 0 0 0
elsif ($text =~ /^\W*([0-9])/) { } 0 0 0
558 0 $key = uc($1);
559 }
560 elsif($text =~ /^\W*([0-9])/) {
561 0 $key = '0-9';
562 }
563 else {
564 0 $key = 'Sym';
565 }
566 0 push(@{$idx{$key}{$text}}, [ $id, $page ]);
567  
568 }
569 0 foreach my $key (qw(Sym 0-9), sort keys %idx) {
570 0 ▶ next unless(defined $idx{$key});
Branch: 1 branch
BranchTrueFalseTotal
unless defined $idx{$key} 0 0 0
571 0 my $heading = HTML::Element->new('h2', CLASS => 'PODIDX');
572 0 $heading->push_content($key);
573 0 $idxobj->{_body}->push_content($heading, "\n");
574 0 foreach my $text (sort {lc $a cmp lc $b} keys %{$idx{$key}}) {
575 0 $idxobj->{_body}->push_content($text);
576 0 foreach(@{$idx{$key}{$text}}) {
577 0 my $anchor = HTML::Element->new('a', HREF => $$_[0],
578 CLASS => 'POD_NAVLINK');
579 0 $anchor->push_content("[$$_[1]]");
580 0 $idxobj->{_body}->push_content($NBSP x 2, $anchor);
581 }
582 0 $idxobj->{_body}->push_content(HTML::Element->new('br'),"\n");
583 }
584 0 delete $idx{$key};
585 }
586  
587 # add all the HTML gimmicks
588 0 $idxobj->customize($opts{-idxtitle});
589  
590 _write_html($idxobj->{_html},
591 0 "$opts{-dir}/$opts{-idxname}$opts{-filesuffix}",undef,$opts{-verbose});
592  
593 # dump postscript if requested
594 0 ▶ if($opts{-ps}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-ps"}) 0 0 0
595 _write_ps("$opts{-psdir}/$opts{-idxname}.ps",
596 0 $idxobj->{_html}, \%opts);
597 }
598  
599 # remove the HTML::Element objects
600 0 $idxobj->{_html}->delete();
601 }
602 }
603  
604 # write HTML tree as PostScript
605 sub _write_ps
606 0 ▶{
Subroutine _write_ps: not called CC=3 SCAR=24.8
607 0 my ($file,$html,$opts) = @_;
608  
609 0 ▶ warn "Writing PostScript $file\n" if($opts->{-verbose});
Branch: 1 branch
BranchTrueFalseTotal
if $opts->{"-verbose"} 0 0 0
610 0 ▶ unless(open(PS,">$file")) {
Branch: 1 branch
BranchTrueFalseTotal
unless (open PS, ">$file") 0 0 0
611 0 warn "Error: Cannot write '$file': $!\n";
612 0 return 0;
613 }
614 0 require HTML::FormatPS;
615 my $formatter = new HTML::FormatPS
616 FontFamily => $opts->{-psfont},
617 HorizontalMargin => HTML::FormatPS::mm(15),
618 VerticalMargin => HTML::FormatPS::mm(20),
619 0 PaperSize => $opts->{-papersize};
620 0 print PS $formatter->format($html);
621 0 close(PS);
622 }
623  
624 ##-------------------------------
625 ## Method definitions begin here
626 ##-------------------------------
627  
628 =head2 OO Interface
629  
630 The B<Marek::Pod::HTML> module has an object oriented interface that allows
631 to customize the converter for special requirements or for
632 proprietary conversion tools. This section describes the most important
633 methods.
634  
635 =over 4
636  
637 =item new()
638  
639 Create a new converter object. Idiom:
640  
641 my $converter = new Marek::Pod::HTML;
642  
643 =cut
644  
645 # set up a new object
646 0 ▶sub new {
Subroutine new: not called CC=2 SCAR=17.9
Pod documented
647 0 my $this = shift;
648 0 ▶ my $class = ref($this) || $this;
Condition0%0/3
ref $this || $this
l!l&&r!l&&!r
000
MC/DC0%0/2
ref $this || $this
ref $this $this
Truth table0%0/3
A || B
A= ref $thisB= $this
ABresult
1X1
011
000
649 0 my %params = @_;
650 0 my $self = {%params};
651 0 bless $self, $class;
652 0 $self->initialize();
653 0 return $self;
654 }
655  
656 # initalize, set defaults
657 0 ▶sub initialize {
Subroutine initialize: not called CC=6 SCAR=37.4
Pod undocumented
658 0 my $self = shift;
659  
660 ## Options
661 # the POD name
662 0 ▶ $self->{-name} ||= '';
Condition0%0/2
$self->{"-name"} ||= ""
l!l
00
MC/DC0%0/1
$self->{"-name"} ||= ""
$self->{"-name"}
Truth table0%0/2
A
A= $self->{"-name"}
Aresult
11
00
663  
664 # the suffix for links
665 0 ▶ $self->{-suffix} ||= '.html';
Condition0%0/2
$self->{"-suffix"} ||= ".html"
l!l
00
MC/DC0%0/1
$self->{"-suffix"} ||= ".html"
$self->{"-suffix"}
Truth table0%0/2
A
A= $self->{"-suffix"}
Aresult
11
00
666  
667 # the short description, taken from NAME
668 0 ▶ $self->{-description} ||= '';
Condition0%0/2
$self->{"-description"} ||= ""
l!l
00
MC/DC0%0/1
$self->{"-description"} ||= ""
$self->{"-description"}
Truth table0%0/2
A
A= $self->{"-description"}
Aresult
11
00
669  
670 # generate local navigation
671 0 ▶ $self->{-localtoc} = 1 unless(defined $self->{-localtoc});
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"-localtoc"} 0 0 0
672  
673 # global navigation
674 0 ▶ $self->{-navigation} = 1 unless(defined $self->{-navigation});
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"-navigation"} 0 0 0
675  
676 ## Internal
677 # counter for headings and items
678 0 $self->{_current_node} = 0;
679 0 $self->{_current_idx} = 0;
680  
681 # a stack for nested lists
682 0 $self->{_list_stack} = [];
683  
684 # a stack for nested lists
685 0 $self->{_current_anchor} = '';
686  
687 # no parser errors here, we've seen them in the first pass
688 0 ▶ $self->SUPER::errorsub(sub { return 1; });
Subroutine __ANON__: not called CC=1 SCAR=6.9
689 }
690  
691 =item customize($name)
692  
693 This method is called after the complete Pod source code has been
694 converted, thus allowing for customizations like title, navigation
695 and footer. I<$name> should contain the page title.
696 This method also reads properties of the current Marek::Pod::HTML object
697 to do the customizations. It is executed for each POD file processed and
698 -- if enabled -- the index and the table of contents.
699  
700 X<Customizing>It is quite simple to build a proprietary
701 customization by writing a new module that inherits from B<Marek::Pod::HTML>:
702  
703 package POD::HTML::mystyle;
704 use Marek::Pod::HTML qw(pod2html);
705 use vars qw(@ISA @EXPORT @EXPORT_OK);
706 require Exporter;
707 @ISA = qw(Marek::Pod::HTML);
708 @EXPORT_OK = qw(&pod2html);
709 sub customize {
710 my ($self,$name) = @_;
711 # if you just want to add things, use this line first:
712 $self->SUPER::customize($name);
713 # do your own things here
714 #...
715 }
716  
717 For complete customization, it is a good starting point to copy the
718 customize method from B<Marek::Pod::HTML>.
719  
720 You can access all the converter's methods and properties through the
721 C<$self->method()> and C<$self->{-property}> syntax, respectively.
722  
723 =cut
724  
725 # this method can be overridden to customize the HTML output
726 0 ▶sub customize {
Subroutine customize: not called CC=11 SCAR=48.8
Pod documented
727 0 my ($self,$name) = @_;
728  
729 # set document class
730 0 my $root = HTML::Element->new('~declaration', text =>
731 'DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"');
732 0 $root->push_content("\n", $self->{_html});
733 0 $self->{_html} = $root;
734  
735 # include stylesheet
736 0 ▶ if($self->{-stylesheet}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-stylesheet"}) 0 0 0
737 my $css = HTML::Element->new('link', TYPE => "text/css",
738 0 REL => "stylesheet", HREF => $self->{-stylesheet});
739 0 $self->{_head}->push_content($css, "\n");
740 }
741  
742 # customize the title
743 0 my $title = HTML::Element->new('title');
744 0 ▶ $title->push_content($self->{-title} || $name || 'POD');
Condition0%0/5
$self->{'-title'} || $name || 'POD'
l!l
00
$self->{"-title"} or $name
l!l&&r!l&&!r
000
MC/DC0%0/2
$self->{'-title'} || $name || 'POD'
$self->{"-title"} $name
Truth table0%0/3
A or B
A= $self->{"-title"}B= $name
ABresult
1X1
011
000
745 0 $self->{_head}->push_content($title, "\n");
746  
747 # prepend big heading
748 0 ▶ if($name) {
Branch: 1 branch
BranchTrueFalseTotal
if ($name) 0 0 0
749 0 my $titleh = HTML::Element->new('h1', CLASS => 'POD_TITLE');
750 0 $titleh->push_content($name);
751 0 $self->{_body}->unshift_content("\n",$titleh,"\n",
752 HTML::Element->new('hr'));
753 }
754  
755 0 ▶ if($self->{-navigation}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-navigation"}) 0 0 0
756 # add navigation
757 0 my $table = HTML::Element->new('table', width => '100%');
758 0 $self->{_body}->unshift_content("\n",$table);
759  
760 0 my $tr = HTML::Element->new('tr');
761 0 $table->push_content("\n",$tr,"\n");
762  
763 0 ▶ if($self->{'-next'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-next"}) 0 0 0
764 0 my $td = HTML::Element->new('td', align => 'left', width => '1%');
765 my $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLINK',
766 0 href => _construct_file_name($self->{'-next'}, $self->depth(), $self->{-suffix}));
767 0 $anchor->push_content('Next:', HTML::Element->new('br'), $self->{'-next'});
768 0 $td->push_content($anchor);
769 0 $tr->push_content($td);
770 }
771  
772 0 ▶ if($self->{'-prev'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-prev"}) 0 0 0
773 0 my $td = HTML::Element->new('td', align => 'left', width => '1%');
774 my $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLINK',
775 0 href => _construct_file_name($self->{'-prev'}, $self->depth(), $self->{-suffix}));
776 0 $anchor->push_content('Previous:', HTML::Element->new('br'), $self->{'-prev'});
777 0 $td->push_content($anchor);
778 0 $tr->push_content($td);
779 }
780  
781 0 my $filler = HTML::Element->new('td', width => '90%');
782 0 $filler->push_content($NBSP);
783 0 $tr->push_content($filler);
784  
785 0 ▶ if($self->{-toc}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-toc"}) 0 0 0
786 0 my $td = HTML::Element->new('td', align => 'right', width => '1%');
787 my $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLILNK',
788 0 href => _construct_file_name($self->{-tocname}, $self->depth(), $self->{-suffix}));
789 0 my $text = '['.$self->{-toctitle}.']';
790 0 $text =~ s/\s+/$NBSP/g;
791 0 $anchor->push_content($text);
792 0 $td->push_content($anchor);
793 0 $tr->push_content($td);
794 }
795  
796 0 ▶ if($self->{-idx}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-idx"}) 0 0 0
797 0 my $td = HTML::Element->new('td', align => 'right', width => '1%');
798 my $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLINK',
799 0 href => _construct_file_name($self->{-idxname}, $self->depth(), $self->{-suffix}));
800 0 my $text = '['.$self->{-idxtitle}.']';
801 0 $text =~ s/\s+/$NBSP/g;
802 0 $anchor->push_content($text);
803 0 $td->push_content($anchor);
804 0 $tr->push_content($td);
805 }
806 } # end navigation
807  
808 # for finding the way back to the top
809 0 my $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLINK',
810 name => 'Pod_TOP_OF_PAGE');
811 0 $self->{_body}->unshift_content("\n",$anchor);
812  
813 # customize the footer
814 0 $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLINK',
815 href => '#Pod_TOP_OF_PAGE');
816 0 $anchor->push_content('[Top]');
817 0 $self->{_body}->push_content(HTML::Element->new('hr'), "\n", $anchor, "\n");
818 $self->{_body}->push_content("Generated by Marek::Pod::HTML $VERSION on " . localtime() . "\n")
819 0 ▶ if($self->{-banner});
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"-banner"} 0 0 0
820 }
821  
822 =item depth()
823  
824 Returns how "deep" this documents is buried in the directory
825 hierarchy. This value is derived from the C<-name> property and is
826 for instance 1 for B<Pod::Parser>.
827  
828 =cut
829  
830 # which hierarchy level does this POD have?
831 0 ▶sub depth {
Subroutine depth: not called CC=4 SCAR=30.0
Pod documented
832 0 my ($self,$depth) = @_;
833 0 ▶ if(defined $depth) {
Branch: 2 branches
BranchTrueFalseTotal
if (defined $depth) { } 0 0 0
elsif (not defined $self->{'-depth'}) { } 0 0 0
834 0 $self->{-depth} = $depth;
835 } elsif(!defined $self->{-depth}) {
836 0 $self->{-depth} = 0;
837 0 ▶ $self->{-depth}++ while($self->{-name} =~ /::/g);
Branch: 1 branch
BranchTrueFalseTotal
$self->{"-name"} =~ /::/g and do { ++$self->{"-depth"} } 0 0 0
838 }
839 0 $self->{-depth};
840 }
841  
842 =item description()
843  
844 Sets or retrieves the short description from the C<=head1 NAME> section of
845 the Pod document. Empty if there is no such section.
846  
847 =cut
848  
849 # The POD description, taken out of NAME if present
850 0 ▶sub description {
Subroutine description: not called CC=2 SCAR=17.9
Pod documented
851 0 ▶ return (@_ > 1) ? ($_[0]->{-description} = $_[1]) : $_[0]->{-description};
Branch: 1 branch
BranchTrueFalseTotal
@_ > 1 ? : 0 0 0
852 }
853  
854 =item indices()
855  
856 Add a new item or return the list of index entries of this document.
857 Each index is represented by an index text (in HTML) and the unique id
858 (i.e. the anchor name) of the index entry in the HTML document.
859  
860 =cut
861  
862 # store/retrieve index entries
863 0 ▶sub indices {
Subroutine indices: not called CC=3 SCAR=24.8
Pod documented
864 0 my $self = shift;
865 0 ▶ unless(defined $self->{_indices}) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->{"_indices"}) 0 0 0
866 0 $self->{_indices} = [];
867 }
868 0 ▶ if(@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) { } 0 0 0
869 0 push(@{$self->{_indices}}, [ @_ ]);
870 0 return $self->{_indices}->[-1];
871 }
872 else {
873 0 return @{$self->{_indices}};
874 }
875 }
876  
877 =item name()
878  
879 Set/retrieve the C<-name> property, i.e. the canonical Pod name
880 (e.g. C<Marek::Pod::HTML>).
881  
882 =back
883  
884 See the F<Pod/HTML.pm> file for additional helper functions that
885 you may use in your code, but beware: things may change there without
886 notice!
887  
888 =cut
889  
890 # set and/or retrieve canonical name of POD
891 0 ▶sub name {
Subroutine name: not called CC=2 SCAR=17.9
Pod documented
892 0 ▶ return (@_ > 1) ? ($_[0]->{-name} = $_[1]) : $_[0]->{-name};
Branch: 1 branch
BranchTrueFalseTotal
@_ > 1 ? : 0 0 0
893 }
894  
895 ## overrides for Pod::Parser
896  
897 # things to do at start of POD
898 0 ▶sub begin_input {
Subroutine begin_input: not called CC=1 SCAR=6.9
Pod undocumented
899 0 my $self = shift;
900  
901 0 ($self->{_html}, $self->{_head}, $self->{_body}) =
902 _basic_html();
903 0 $self->{_current} = $self->{_body};
904 0 $self->{_current_head1_title} = '';
905 }
906  
907 # things to do at end of POD
908 0 ▶sub end_pod {
Subroutine end_pod: not called CC=3 SCAR=24.8
Pod undocumented
909 0 my $self = shift;
910 0 my $out_fh = $self->output_handle();
911 #delete $self->{_p_for_reuse};
912 0 delete $self->{_current};
913  
914 # close any lists left
915 0 ▶ while(@{$self->{_list_stack}}) {
Branch: 1 branch
BranchTrueFalseTotal
if (@{$self->{"_list_stack"};}) 0 0 0
916 0 my $list = shift(@{$self->{_list_stack}});
917 0 warn "Warning: autoclosing list at EOF\n";
918 # nothing to do thanks to HTML::Element
919 }
920  
921 ## add local TOC
922 0 ▶ if($self->{-localtoc}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-localtoc"}) 0 0 0
923 0 $self->_local_toc();
924 }
925  
926 ## Do any page customizations
927 0 $self->customize($self->name());
928  
929 # dump it
930 0 _write_html($self->{_html},$self->output_file(),$out_fh,$self->{-verbose});
931 0 1;
932 }
933  
934 sub _write_html
935 0 ▶{
Subroutine _write_html: not called CC=4 SCAR=30.0
936 0 my ($obj, $file, $handle,$verbose) = @_;
937 0 ▶ warn "Writing HTML $file\n" if($verbose);
Branch: 1 branch
BranchTrueFalseTotal
if $verbose 0 0 0
938 0 my $html = $obj->as_HTML() . "\n";
939 0 ▶ unless($handle) {
Branch: 1 branch
BranchTrueFalseTotal
if ($handle) { } 0 0 0
940 0 ▶ unless(open(OUT, ">$file")) {
Branch: 1 branch
BranchTrueFalseTotal
unless (open OUT, ">$file") 0 0 0
941 0 warn "Error: Cannot write: $!\n";
942 0 return 0;
943 }
944 0 print OUT $html;
945 0 close(OUT);
946 } else {
947 0 print $handle $html;
948 }
949 0 1;
950 }
951  
952 # expand a POD command
953 0 ▶sub command {
Subroutine command: not called CC=34 SCAR=70.8
Pod undocumented
954 0 my ($self, $command, $paragraph, $line_num, $pod_para) = @_;
955 0 my ($file, $line) = $pod_para->file_line;
956  
957 # Heading
958 0 ▶ if ($command =~ /^head(\d)/) {
Branch: 7 branches
BranchTrueFalseTotal
if ($command =~ /^head(\d)/) { } 0 0 0
elsif ($command eq 'over') { } 0 0 0
elsif ($command eq 'item') { } 0 0 0
elsif ($command eq 'back') { } 0 0 0
elsif ($command eq 'for') { } 0 0 0
elsif ($command eq 'begin') { } 0 0 0
elsif ($command eq 'end') { } 0 0 0
959 0 my $n = $1;
960  
961 # close any lists left
962 0 ▶ while(@{$self->{_list_stack}}) {
Branch: 1 branch
BranchTrueFalseTotal
if (@{$self->{"_list_stack"};}) 0 0 0
963 0 my $list = shift(@{$self->{_list_stack}});
964 0 warn "Warning: autoclosing list at $command"
965 . " at line $line_num of file $file\n";
966 0 $self->{_current} = $list->parent();
967 }
968  
969 # expand the heading's text
970 0 $paragraph =~ s/[\s\n]+$//;
971 0 my @title = $self->interpolate($paragraph, $line_num);
972  
973 # retrieve the heading's id
974 0 my $count = ($self->{_current_node})++;
975 0 my ($node,$id) = @{$self->{-mycache}->{-nodes}->[$count]};
976  
977 # make <H2> and <H3>, but leave space for deeper
978 # levels. By special request of Achim Bohnet ;-)
979 0 my $heading = HTML::Element->new('h'.($n + 1), CLASS => "POD_HEAD$n");
980 0 my $anchor = HTML::Element->new('a', name => $id);
981 0 $self->{_current_anchor} = $id;
982 0 $anchor->push_content(@title);
983 0 $heading->push_content($anchor);
984 0 $self->{_current}->push_content($heading,"\n");
985  
986 # save heading details for later reference
987 0 ▶ if($n == 1) {
Branch: 1 branch
BranchTrueFalseTotal
if ($n == 1) 0 0 0
988 0 $self->{_current_head1_title} = $heading->as_text();
989 }
990 0 ▶ if($self->{-localtoc}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-localtoc"}) 0 0 0
991 0 push(@{$self->{_toc}}, [ $n, $id,
992 HTML::Element->clone_list(@title) ]);
993 }
994 }
995 # Start of List
996 elsif ($command eq 'over') {
997 0 $self->{_current_anchor} = '';
998 0 $paragraph =~ s/[\s\n]+$//;
999 0 unshift(@{$self->{_list_stack}},
1000 Pod::List->new(-indent => $paragraph,
1001 0 -parent => $self->{_current}));
1002 }
1003  
1004 # a list item
1005 elsif ($command eq 'item') {
1006 # Check for an open list
1007 0 ▶ unless(@{$self->{_list_stack}}) {
Branch: 1 branch
BranchTrueFalseTotal
unless (@{$self->{"_list_stack"};}) 0 0 0
1008 0 unshift(@{$self->{_list_stack}},
1009 Pod::List->new(-indent => 4, -parent =>
1010 0 $self->{_current}));
1011 0 warn "Warning: =item without =over, auto-opening `=over 4'"
1012 . " at line $line_num of file $file\n";
1013 }
1014 0 my $list = $self->{_list_stack}[0];
1015 0 $paragraph =~ s/[\s\n]+$//;
1016 0 ▶ unless($list->type()) {
Branch: 2 branches
BranchTrueFalseTotal
if ($list->type) { } 0 0 0
if (do { my $rx = $list->rx }) 0 0 0
1017 # determine type of list
1018 0 ▶ if($paragraph =~ s/^()\s*\d+\.?\s*/$1/) {
Branch: 2 branches
BranchTrueFalseTotal
if ($paragraph =~ s/^()\s*\d+\.?\s*/$1/) { } 0 0 0
elsif ($paragraph =~ s/^((\s*\w<)*)\s*[*]\s*/$1/ or $paragraph =~ s/^\s*$//) { } 0 0 0
1019 # an ordered list
1020 0 $list->type('ol');
1021 0 $list->rx('^()\s*\d+\.?\s*');
1022 }
1023 # artificial intelligence: look behind opening tags
1024 ▶ elsif($paragraph =~ s/^((\s*\w<)*)\s*[*]\s*/$1/ ||
Condition0%0/3
$paragraph =~ s/^((\s*\w<)*)\s*[*]\s*/$1/ or $paragraph =~ s/^\s*$//
l!l&&r!l&&!r
000
MC/DC0%0/2
$paragraph =~ s/^((\s*\w<)*)\s*[*]\s*/$1/ or $paragraph =~ s/^\s*$//
$paragraph =~ s/^((\s*\w<)*)\s*[*]\s*/$1/ $paragraph =~ s/^\s*$//
Truth table0%0/3
A or B
A= $paragraph =~ s/^((\s*\w<)*)\s*[*]\s*/$1/B= $paragraph =~ s/^\s*$//
ABresult
1X1
011
000
1025 $paragraph =~ s/^\s*$//) {
1026 # a bulleted list
1027 0 $list->type('ul');
1028 0 $list->rx('^((\s*\w<)*)\s*[*]\s*');
1029 }
1030 else {
1031 # a definition list
1032 0 $list->type('dl');
1033 }
1034 0 $list->tag(HTML::Element->new($list->type(), CLASS => 'POD_LIST')
1035 )->push_content("\n");
1036 0 $self->{_current}->push_content($list->tag(),"\n");
1037 0 } elsif(my $rx = $list->rx()) {
1038 # simplify the item text
1039 0 $paragraph =~ s/$rx/$1/;
1040 }
1041  
1042 # retrieve node id
1043 0 my $count = ($self->{_current_node})++;
1044 0 my ($node,$id) = @{$self->{-mycache}->{-nodes}->[$count]};
1045 0 $self->{_current_anchor} = $id;
1046  
1047 0 my @text = $self->interpolate($paragraph, $line_num);
1048  
1049 0 my $item;
1050 0 my $anchor = HTML::Element->new('a', name => $id);
1051 0 ▶ if($list->type() eq 'dl') {
Branch: 1 branch
BranchTrueFalseTotal
if ($list->type eq 'dl') { } 0 0 0
1052 0 my $dt;
1053 0 my $content = $list->tag()->content();
1054 0 ▶ if(defined $content && ref($content) && @$content &&
Branch: 1 branch
BranchTrueFalseTotal
if (defined $content and ref $content and @$content and ref $content->[-1] and $content->[-1]->tag eq 'dd' and $content->[-1]->is_empty) { } 0 0 0
Condition0%0/15
defined $content and ref $content and @$content and ref $content->[-1] and $content->[-1]->tag eq "dd" and $content->[-1]->is_empty
!ll&&!rl&&r
000
defined $content and ref $content and @$content and ref $content->[-1] and $content->[-1]->tag eq "dd"
!ll&&!rl&&r
000
defined $content and ref $content and @$content and ref $content->[-1]
!ll&&!rl&&r
000
defined $content and ref $content and @$content
!ll&&!rl&&r
000
defined $content and ref $content
!ll&&!rl&&r
000
MC/DC0%0/6
defined $content and ref $content and @$content and ref $content->[-1] and $content->[-1]->tag eq "dd" and $content->[-1]->is_empty
defined $content ref $content @$content ref $content->[-1] $content->[-1]->tag eq "dd" $content->[-1]->is_empty
Truth table0%0/7
A and B and C and D and E and F
A= defined $contentB= ref $contentC= @$contentD= ref $content->[-1]E= $content->[-1]->tag eq "dd"F= $content->[-1]->is_empty
ABCDEFresult
0XXXXX0
10XXXX0
110XXX0
1110XX0
11110X0
1111100
1111111
1055 ref($content->[-1]) && $content->[-1]->tag() eq 'dd' &&
1056 $content->[-1]->is_empty()) {
1057 0 $dt = $content->[-1];
1058 0 $dt->tag('dt');
1059 } else {
1060 0 $dt = HTML::Element->new('dt', CLASS => 'POD_ITEM');
1061 0 $list->tag()->push_content($dt);
1062 }
1063 0 $dt->push_content($anchor,"\n");
1064 0 $anchor->push_content(@text);
1065 0 $item = HTML::Element->new('dd');
1066 0 $self->{_last_p_by} = 'dd';
1067 } else {
1068 0 $item = HTML::Element->new('li', CLASS => 'POD_ITEM');
1069 0 ▶ if(length $paragraph) {
Branch: 1 branch
BranchTrueFalseTotal
if (length $paragraph) { } 0 0 0
1070 0 my $p = HTML::Element->new('p');
1071 0 $p->push_content(@text);
1072 0 $anchor->push_content($p);
1073 } else {
1074 0 $anchor->push_content(@text);
1075 }
1076 0 $item->push_content($anchor);
1077 0 $item->push_content("\n");
1078 }
1079 0 $list->tag()->push_content($item);
1080 0 $self->{_current} = $item;
1081  
1082 0 ▶ if($self->{-idxopt} =~ /(^|,)item(,|$)/i) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-idxopt"} =~ /(^|,)item(,|$)/i) 0 0 0
1083 # save item html text for later reference
1084 0 ▶ $self->indices(_to_text(@text),$id)
Branch: 1 branch
BranchTrueFalseTotal
if $paragraph =~ /^\s*(\w<\s*)*(\S*)/ and $2 0 0 0
Condition0%0/3
$paragraph =~ /^\s*(\w<\s*)*(\S*)/ and $2
!ll&&!rl&&r
000
MC/DC0%0/2
$paragraph =~ /^\s*(\w<\s*)*(\S*)/ and $2
$paragraph =~ /^\s*(\w<\s*)*(\S*)/ $2
Truth table0%0/3
A and B
A= $paragraph =~ /^\s*(\w<\s*)*(\S*)/B= $2
ABresult
0X0
100
111
1085 if($paragraph =~ /^\s*(\w<\s*)*(\S*)/ && $2);
1086 }
1087 }
1088  
1089 # End of a list
1090 elsif ($command eq 'back') {
1091 0 $self->{_current_anchor} = '';
1092 0 my $list = shift(@{$self->{_list_stack}});
1093 0 ▶ unless($list) {
Branch: 1 branch
BranchTrueFalseTotal
if ($list) { } 0 0 0
1094 0 warn "Warning: =back without =over, ignoring"
1095 . " at line $line_num of file $file\n";
1096 }
1097 else {
1098 0 $self->{_current} = $list->parent();
1099 }
1100 }
1101  
1102 # 'for' converter paragraph
1103 elsif ($command eq 'for') {
1104 0 $self->{_current_anchor} = '';
1105 0 $paragraph =~ s/[\s\n]+$//s;
1106 0 ▶ if($paragraph =~ s/^[\s\n]*(\S+)[\s\n]*// && lc($1) eq 'html') {
Branch: 1 branch
BranchTrueFalseTotal
if ($paragraph =~ s/^[\s\n]*(\S+)[\s\n]*// and lc $1 eq "html") 0 0 0
Condition0%0/3
$paragraph =~ s/^[\s\n]*(\S+)[\s\n]*// and lc $1 eq "html"
!ll&&!rl&&r
000
MC/DC0%0/2
$paragraph =~ s/^[\s\n]*(\S+)[\s\n]*// and lc $1 eq "html"
$paragraph =~ s/^[\s\n]*(\S+)[\s\n]*// lc $1 eq "html"
Truth table0%0/3
A and B
A= $paragraph =~ s/^[\s\n]*(\S+)[\s\n]*//B= lc $1 eq "html"
ABresult
0X0
100
111
1107 0 my $curr = $self->{_current};
1108 0 my $p = _get_last_p_or_new($curr, 'POD_RAW');
1109 0 $self->_push_raw_html($p,$paragraph);
1110 }
1111 }
1112  
1113 # 'begin' converter brace
1114 elsif ($command eq 'begin') {
1115 0 $self->{_current_anchor} = '';
1116 0 ▶ unless($paragraph =~ /(\S+)/) {
Branch: 1 branch
BranchTrueFalseTotal
if ($paragraph =~ /(\S+)/) { } 0 0 0
1117 0 warn "Warning: =begin without parameter, ignoring"
1118 . " at line $line_num of file $file\n";
1119 }
1120 else {
1121 0 $self->{_begin} = lc($1);
1122 0 ▶ if($self->{_begin} eq 'html') {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"_begin"} eq "html") 0 0 0
1123 # set up a raw HTML storage
1124 0 $self->{_raw_html} = '';
1125 }
1126 }
1127 }
1128  
1129 # 'end' converter brace
1130 elsif ($command eq 'end') {
1131 0 $self->{_current_anchor} = '';
1132 0 $self->{_begin} = undef;
1133 # do I have html?
1134 0 ▶ if($self->{_raw_html}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"_raw_html"}) 0 0 0
1135 # try to find a preceding <P> tag
1136 0 my $curr = $self->{_current};
1137 0 my $p = _get_last_p_or_new($curr, 'POD_RAW');
1138 0 $self->_push_raw_html($p,$self->{_raw_html});
1139 0 delete $self->{_raw_html};
1140 }
1141 }
1142 # ignore all the rest
1143 }
1144  
1145 sub _get_last_p_or_new
1146 0 ▶{
Subroutine _get_last_p_or_new: not called CC=6 SCAR=37.4
1147 0 my ($curr,$class) = @_;
1148 0 my $p;
1149 0 my $content = $curr->content();
1150 0 ▶ if(defined $content && ref($content) && @$content &&
Branch: 1 branch
BranchTrueFalseTotal
if (defined $content and ref $content and @$content and ref $content->[-2] and $content->[-2]->tag eq 'p') { } 0 0 0
Condition0%0/12
defined $content and ref $content and @$content and ref $content->[-2] and $content->[-2]->tag eq "p"
!ll&&!rl&&r
000
defined $content and ref $content and @$content and ref $content->[-2]
!ll&&!rl&&r
000
defined $content and ref $content and @$content
!ll&&!rl&&r
000
defined $content and ref $content
!ll&&!rl&&r
000
MC/DC0%0/5
defined $content and ref $content and @$content and ref $content->[-2] and $content->[-2]->tag eq "p"
defined $content ref $content @$content ref $content->[-2] $content->[-2]->tag eq "p"
Truth table0%0/6
A and B and C and D and E
A= defined $contentB= ref $contentC= @$contentD= ref $content->[-2]E= $content->[-2]->tag eq "p"
ABCDEresult
0XXXX0
10XXX0
110XX0
1110X0
111100
111111
1151 ref($content->[-2]) && $content->[-2]->tag() eq 'p') {
1152 0 $p = $content->[-2];
1153 } else { # need a new one
1154 0 $p = HTML::Element->new('p', CLASS => $class);
1155 0 $curr->push_content($p,"\n");
1156 }
1157 0 $p;
1158 }
1159  
1160 # process a verbatim paragraph
1161 0 ▶sub verbatim {
Subroutine verbatim: not called CC=15 SCAR=54.8
Pod undocumented
1162 0 my ($self, $paragraph, $line_num, $pod_para) = @_;
1163  
1164 0 $self->{_current_anchor} = '';
1165 # strip trailing whitespace
1166 0 $paragraph =~ s/[\s\n]+$//s;
1167  
1168 0 ▶ unless(length($paragraph)) {
Branch: 3 branches
BranchTrueFalseTotal
if (length $paragraph) { } 0 0 0
if (do { not $self->{'_begin'} }) { } 0 0 0
elsif ($self->{'_begin'} eq 'html') { } 0 0 0
1169 # just an empty line
1170 0 $self->{_current}->push_content(HTML::Element->new('p'), "\n");
1171 }
1172 elsif(!$self->{_begin}) {
1173 # a regular paragraph
1174 0 my $pre;
1175 0 my $content = $self->{_current}->content();
1176 # reuse last <pre> if immediate predecessor
1177 0 ▶ if(defined $content && ref($content) && @$content &&
Branch: 1 branch
BranchTrueFalseTotal
if (defined $content and ref $content and @$content and ref $content->[-2] and $content->[-2]->tag eq 'pre') { } 0 0 0
Condition0%0/12
defined $content and ref $content and @$content and ref $content->[-2] and $content->[-2]->tag eq "pre"
!ll&&!rl&&r
000
defined $content and ref $content and @$content and ref $content->[-2]
!ll&&!rl&&r
000
defined $content and ref $content and @$content
!ll&&!rl&&r
000
defined $content and ref $content
!ll&&!rl&&r
000
MC/DC0%0/5
defined $content and ref $content and @$content and ref $content->[-2] and $content->[-2]->tag eq "pre"
defined $content ref $content @$content ref $content->[-2] $content->[-2]->tag eq "pre"
Truth table0%0/6
A and B and C and D and E
A= defined $contentB= ref $contentC= @$contentD= ref $content->[-2]E= $content->[-2]->tag eq "pre"
ABCDEresult
0XXXX0
10XXX0
110XX0
1110X0
111100
111111
1178 ref($content->[-2]) && $content->[-2]->tag() eq 'pre') {
1179 0 $pre = $content->[-2];
1180 } else {
1181 0 $pre = HTML::Element->new('pre', CLASS => 'POD_VERBATIM');
1182 0 $self->{_current}->push_content($pre,"\n");
1183 }
1184 0 $pre->push_content("\n");
1185  
1186 0 ▶ if($self->{_current_head1_title} eq 'NAME' && !$self->description()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"_current_head1_title"} eq "NAME" and not $self->description) 0 0 0
Condition0%0/3
$self->{"_current_head1_title"} eq "NAME" and not $self->description
!ll&&!rl&&r
000
MC/DC0%0/2
$self->{"_current_head1_title"} eq "NAME" and not $self->description
$self->{"_current_head1_title"} eq "NAME" not $self->description
Truth table0%0/3
A and not(B)
A= $self->{"_current_head1_title"} eq "NAME"B= not $self->description
ABresult
0X0
100
111
1187 # save the description for further use in TOC
1188 0 my $str = $paragraph;
1189 0 $str =~ s/^[\n\s]+//;
1190 0 ▶ $self->description($str) if($str);
Branch: 1 branch
BranchTrueFalseTotal
if $str 0 0 0
1191 }
1192 # this is special in perl.pod
1193 0 foreach(split(/\n/,$paragraph)) {
1194 # TODO expand tabs correctly?
1195 0 ▶ if(s/^(\s+)([\w:]+)(\t+)//) {
Branch: 1 branch
BranchTrueFalseTotal
if (s/^(\s+)([\w:]+)(\t+)//) { } 0 0 0
1196 # this is for perl.pod - an implied list
1197 0 my ($indent,$page,$postdent) = ($1,$2,$3);
1198 0 my $dest = $self->{-cache}->find_page($page);
1199 0 ▶ if($dest) {
Branch: 1 branch
BranchTrueFalseTotal
if ($dest) 0 0 0
1200 my $destfile = _construct_file_name(
1201 0 $dest->page(), $self->depth(), $self->{-suffix});
1202 0 my $link = HTML::Element->new('a', href => $destfile,
1203 CLASS => 'POD_LINK');
1204 0 $link->push_content($page);
1205 0 $page = $link;
1206 }
1207 0 $pre->push_content($indent,$page,$postdent,$_,"\n");
1208 } else {
1209 0 $pre->push_content($_,"\n");
1210 }
1211 }
1212 }
1213 # a "verbatim" =begin html paragraph
1214 elsif($self->{_begin} eq 'html') {
1215 0 $self->{_raw_html} .= $paragraph;
1216 }
1217 }
1218  
1219 # a regular text paragraph
1220 0 ▶sub textblock {
Subroutine textblock: not called CC=10 SCAR=47.0
Pod undocumented
1221 0 my ($self, $paragraph, $line_num, $pod_para) = @_;
1222  
1223 0 $paragraph =~ s/[\s\n]+$//s;
1224  
1225 # regular context
1226 0 ▶ if(!$self->{_begin}) {
Branch: 2 branches
BranchTrueFalseTotal
if (not $self->{'_begin'}) { } 0 0 0
elsif ($self->{'_begin'} eq 'html') { } 0 0 0
1227 0 my @text = $self->interpolate($paragraph, $line_num);
1228 # remember first paragraph in NAME section
1229 0 ▶ if($self->{_current_head1_title} eq 'NAME' && $paragraph &&
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"_current_head1_title"} eq "NAME" and $paragraph and not $self->description) 0 0 0
Condition0%0/6
$self->{"_current_head1_title"} eq "NAME" and $paragraph and not $self->description
!ll&&!rl&&r
000
$self->{"_current_head1_title"} eq "NAME" and $paragraph
!ll&&!rl&&r
000
MC/DC0%0/3
$self->{"_current_head1_title"} eq "NAME" and $paragraph and not $self->description
$self->{"_current_head1_title"} eq "NAME" $paragraph not $self->description
Truth table0%0/4
A and B and not(C)
A= $self->{"_current_head1_title"} eq "NAME"B= $paragraphC= not $self->description
ABCresult
0XX0
10X0
1100
1111
1230 !$self->description()) {
1231 # save the description for further use in TOC
1232 0 $self->description([ HTML::Element->clone_list(@text) ]);
1233 }
1234 0 my $par;
1235 0 ▶ if($self->{_last_p_by} && $self->{_last_p_by} eq 'dd') {
Branch: 2 branches
BranchTrueFalseTotal
if ($self->{'_last_p_by'} and $self->{'_last_p_by'} eq 'dd') { } 0 0 0
elsif ($self->{'_last_p_by'} and $self->{'_last_p_by'} eq 'beginfor') { } 0 0 0
Condition0%0/3
$self->{"_last_p_by"} and $self->{"_last_p_by"} eq "dd"
!ll&&!rl&&r
000
MC/DC0%0/2
$self->{"_last_p_by"} and $self->{"_last_p_by"} eq "dd"
$self->{"_last_p_by"} $self->{"_last_p_by"} eq "dd"
Truth table0%0/3
A and B
A= $self->{"_last_p_by"}B= $self->{"_last_p_by"} eq "dd"
ABresult
0X0
100
111
1236 0 $par = $self->{_current};
1237 0 delete $self->{_last_p_by};
1238 }
1239 ▶ elsif($self->{_last_p_by} && $self->{_last_p_by} eq 'beginfor') {
Condition0%0/3
$self->{"_last_p_by"} and $self->{"_last_p_by"} eq "beginfor"
!ll&&!rl&&r
000
MC/DC0%0/2
$self->{"_last_p_by"} and $self->{"_last_p_by"} eq "beginfor"
$self->{"_last_p_by"} $self->{"_last_p_by"} eq "beginfor"
Truth table0%0/3
A and B
A= $self->{"_last_p_by"}B= $self->{"_last_p_by"} eq "beginfor"
ABresult
0X0
100
111
1240 0 $par = _get_last_p_or_new($self->{_current}, 'POD_TEXT');
1241 }
1242 else {
1243 0 $par = HTML::Element->new('p', CLASS => 'POD_TEXT');
1244 0 $self->{_current}->push_content($par, "\n");
1245 }
1246 0 $par->push_content("\n",@text,"\n");
1247 0 $self->{_last_p_by} = 'text';
1248 }
1249 # =begin html context
1250 elsif($self->{_begin} eq 'html') {
1251 0 $self->{_raw_html} .= $paragraph;
1252 }
1253 # reset currrent anchor this late so that in this par no autolinks
1254 # are generated
1255 0 $self->{_current_anchor} = '';
1256 }
1257  
1258 # expand a POD text string
1259 0 ▶sub interpolate {
Subroutine interpolate: not called CC=1 SCAR=6.9
Pod undocumented
1260 0 my ($self, $paragraph, $line) = @_;
1261 ## Check the interior sequences in the command-text
1262 # and return the text as array of HTML::Element's
1263 0 $self->_expand_ptree(
1264 $self->parse_text($paragraph,$line), $line, '');
1265 }
1266  
1267 0 ▶sub _expand_ptree {
Subroutine _expand_ptree: not called CC=34 SCAR=70.8
1268 0 my ($self,$ptree,$line,$nestlist) = @_;
1269 0 local($_);
1270 0 my @text = ();
1271 # process each node in the parse tree
1272 0 foreach(@$ptree) {
1273 # regular text chunk
1274 0 ▶ unless(ref) {
Branch: 1 branch
BranchTrueFalseTotal
unless (ref $_) 0 0 0
1275 0 my $chunk = $_;
1276 # do magic linebreaking
1277 0 ▶ while($chunk =~ s/^([^\n]*)\n([ \t]+)//) {
Branch: 1 branch
BranchTrueFalseTotal
if ($chunk =~ s/^([^\n]*)\n([ \t]+)//) 0 0 0
1278 0 my ($line,$indent) = ($1,$2);
1279 0 ▶ $line =~ s/\s/$NBSP/g if($nestlist =~ /S/);
Branch: 1 branch
BranchTrueFalseTotal
if $nestlist =~ /S/ 0 0 0
1280 0 push(@text, $line, HTML::Element->new('br'),
1281 _expand_tab($indent) );
1282 }
1283 # escape whitespace if in S<>
1284 0 ▶ if($chunk) {
Branch: 1 branch
BranchTrueFalseTotal
if ($chunk) 0 0 0
1285 0 ▶ $chunk =~ s/\s/$NBSP/g if($nestlist =~ /S/);
Branch: 1 branch
BranchTrueFalseTotal
if $nestlist =~ /S/ 0 0 0
1286 0 push(@text,$chunk);
1287 }
1288 0 next; # finished this chunk
1289 }
1290 # have an interior sequence
1291 0 my $cmd = $_->cmd_name();
1292 0 my $contents = $_->parse_tree();
1293 0 my $file;
1294 0 ($file,$line) = $_->file_line();
1295  
1296 # an entity
1297 0 ▶ if($cmd eq 'E') {
Branch: 11 branches
BranchTrueFalseTotal
if ($cmd eq 'E') { } 0 0 0
elsif ($cmd eq 'L') { } 0 0 0
elsif ($cmd eq 'P') { } 0 0 0
elsif ($cmd eq 'Q') { } 0 0 0
elsif ($cmd eq 'B') { } 0 0 0
elsif ($cmd eq 'C') { } 0 0 0
elsif ($cmd eq 'F') { } 0 0 0
elsif ($cmd eq 'I') { } 0 0 0
elsif ($cmd eq 'S') { } 0 0 0
elsif ($cmd eq 'Z') { } 0 0 0
elsif ($cmd eq 'X') { } 0 0 0
1298 0 my $entity = $contents->raw_text();
1299 0 $entity =~ s/^[\n\s]+|[\n\s]+$//g;
1300 0 ▶ if($entity =~ /^(0x[0-9a-f]+)$/i) {
Branch: 5 branches
BranchTrueFalseTotal
if ($entity =~ /^(0x[0-9a-f]+)$/i) { } 0 0 0
elsif ($entity =~ /^(0[0-7]+)$/) { } 0 0 0
elsif ($entity =~ /^(\d+)$/) { } 0 0 0
elsif ($entity =~ /^sol$/i) { } 0 0 0
elsif ($entity =~ /^verbar$/i) { } 0 0 0
1301 # hexadecimal
1302 0 push(@text, chr(hex($1)));
1303 }
1304 elsif($entity =~ /^(0[0-7]+)$/) {
1305 # octal
1306 0 push(@text, chr(oct($1)));
1307 }
1308 elsif($entity =~ /^(\d+)$/) {
1309 # decimal
1310 0 push(@text, chr($1));
1311 }
1312 elsif($entity =~ /^sol$/i) {
1313 # forward slash
1314 0 push(@text, '/');
1315 }
1316 elsif($entity =~ /^verbar$/i) {
1317 # vertical bar
1318 0 push(@text, '|');
1319 }
1320 else {
1321 # textual entity
1322 0 ▶ push(@text, HTML::Entities::decode_entities("&$entity;") || '');
Condition0%0/2
HTML::Entities::decode_entities("&$entity;") || ''
l!l
00
MC/DC0%0/1
HTML::Entities::decode_entities("&$entity;") || ''
HTML::Entities::decode_entities("&$entity;")
Truth table0%0/2
A
A= HTML::Entities::decode_entities("&$entity;")
Aresult
11
00
1323 }
1324 }
1325  
1326 # a hyperlink
1327 elsif($cmd eq 'L') {
1328 # try to parse the hyperlink
1329 0 my $raw = $contents->raw_text();
1330 0 my $link = Pod::Hyperlink->new($raw);
1331 0 ▶ unless(defined $link) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $link) 0 0 0
1332 # the link cannot be parsed
1333 0 my $underline = HTML::Element->new('u');
1334 0 $underline->push_content($raw);
1335 0 push(@text,$underline);
1336 0 next;
1337 }
1338  
1339 # only underline if destination not found
1340 0 $self->{_link_pagemark} = 'u';
1341 0 $self->{_link_pageopt} = +{};
1342 0 $self->{_link_sectionmark} = 'u';
1343 0 $self->{_link_sectionopt} = +{};
1344  
1345 # search for page
1346 0 my $page = $link->page();
1347 0 $page =~ s/[(]\w*[)]$//; # strip manpage section
1348 0 my $dest;
1349 0 my $destfile = '';
1350 0 ▶ if($page) {
Branch: 1 branch
BranchTrueFalseTotal
if ($page) { } 0 0 0
1351 0 $dest = $self->{-cache}->find_page($page);
1352 0 ▶ if($dest) {
Branch: 1 branch
BranchTrueFalseTotal
if ($dest) { } 0 0 0
1353 $destfile = _construct_file_name(
1354 0 $dest->page(), $self->depth(), $self->{-suffix});
1355 0 $self->{_link_pagemark} = $self->{_link_sectionmark} = 'a';
1356 $self->{_link_pageopt} =
1357 $self->{_link_sectionopt} =
1358 0 { CLASS => 'POD_LINK', HREF => $destfile };
1359 }
1360 else {
1361 0 warn "Cannot find page `$page' at L<> on line $line\n";
1362 }
1363 } else {
1364 0 $dest = $self->{-mycache};
1365 }
1366  
1367 0 ▶ if($link->type() eq 'hyperlink') {
Branch: 1 branch
BranchTrueFalseTotal
if ($link->type eq 'hyperlink') { } 0 0 0
1368 0 $self->{_link_sectionmark} = 'a';
1369 $self->{_link_sectionopt} =
1370 0 { CLASS => 'POD_LINK', HREF => $link->node() };
1371 } else {
1372 # search for node in page
1373 0 my $node = '';
1374 # use Pod::Checker's expand procedure to get the link
1375 # destination node
1376 0 ▶ if($link->node()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($link->node) 0 0 0
1377 0 my $cruncher = Pod::Checker->new(-quiet => 1);
1378 0 ▶ $cruncher->errorsub(sub { 1; }); # suppress any errors
Subroutine __ANON__: not called CC=1 SCAR=6.9
1379 0 $node = $cruncher->interpolate_and_check($link->node(),
1380 $line,$file);
1381 }
1382 0 ▶ if($dest && $node) {
Branch: 1 branch
BranchTrueFalseTotal
if ($dest and $node) 0 0 0
Condition0%0/3
$dest and $node
!ll&&!rl&&r
000
MC/DC0%0/2
$dest and $node
$dest $node
Truth table0%0/3
A and B
A= $destB= $node
ABresult
0X0
100
111
1383 0 my $id = $dest->find_node($node);
1384 0 ▶ if($id) {
Branch: 1 branch
BranchTrueFalseTotal
if ($id) { } 0 0 0
1385 0 $self->{_link_sectionmark} = 'a';
1386 $self->{_link_sectionopt} =
1387 0 { CLASS => 'POD_LINK', HREF => "$destfile#$id" };
1388 } else {
1389 0 ▶ my $inpage = $page ? " in `$page'" : '';
Branch: 1 branch
BranchTrueFalseTotal
$page ? : 0 0 0
1390 0 warn "Cannot find node `$node'$inpage at L<> on line $line\n";
1391 }
1392 }
1393 }
1394 0 $link->line($line); # remember line
1395  
1396 # convert the link text (expand POD markup)
1397 0 push(@text, $self->_expand_ptree($self->parse_text(
1398 $link->markup(), $line), $line, "$nestlist$cmd"));
1399 }
1400  
1401 # internal: hyperlink to page
1402 elsif($cmd eq 'P') {
1403 my $tag = HTML::Element->new($self->{_link_pagemark},
1404 0 %{$self->{_link_pageopt}});
1405 0 push(@text,$tag);
1406 0 $tag->push_content($self->_expand_ptree($contents, $line,
1407 "$nestlist$cmd"));
1408 }
1409  
1410 # internal: hyperlink to section
1411 elsif($cmd eq 'Q') {
1412 my $tag = HTML::Element->new($self->{_link_sectionmark},
1413 0 %{$self->{_link_sectionopt}});
1414 0 push(@text,$tag);
1415 0 $tag->push_content($self->_expand_ptree($contents, $line,
1416 "$nestlist$cmd"));
1417 }
1418  
1419 # bold text
1420 elsif($cmd eq 'B') {
1421 0 $self->_autolink_and_highlight(\@text, $contents, $line,
1422 "$nestlist$cmd", 'b', 0);
1423 }
1424  
1425 # code text
1426 elsif($cmd eq 'C') {
1427 0 $self->_autolink_and_highlight(\@text, $contents, $line,
1428 "$nestlist$cmd", 'code', 1);
1429 }
1430  
1431 # file text
1432 elsif($cmd eq 'F') {
1433 0 $self->_autolink_and_highlight(\@text, $contents, $line,
1434 "$nestlist$cmd", 'code' , 0);
1435 }
1436  
1437 # italic text
1438 elsif($cmd eq 'I') {
1439 # TODO I<...I<...>...> should be expanded to
1440 # <I>...</I>...<I>...</I> - according to Achim Bohnet
1441 0 $self->_autolink_and_highlight(\@text, $contents, $line,
1442 "$nestlist$cmd", 'i', 0);
1443 }
1444  
1445 # non-breakable space
1446 elsif($cmd eq 'S') {
1447 # will be taken care of above, when expanding text chunk
1448 0 push(@text, $self->_expand_ptree($contents, $line, "$nestlist$cmd"));
1449 }
1450  
1451 # zero-size element
1452 elsif($cmd eq 'Z') {
1453 # do nothing - a comment would be nice
1454 # &#x200B; is the correct entity, but it won't work with the
1455 # current HTML::Entities
1456 }
1457  
1458 # custom index entries
1459 # TODO these should run also through Pod::Checker and result in
1460 # valid L<...> destinations
1461 elsif($cmd eq 'X') {
1462 # set up a fast lookup cache for node ids
1463 0 my $count = ($self->{_current_idx})++;
1464 0 my ($node,$id) = @{$self->{-mycache}->{-idx}->[$count]};
1465 0 my $tag = HTML::Element->new('a', name => $id);
1466 #$tag->push_content(@key);
1467 0 push(@text,$tag);
1468 $self->indices($node,$id) # $node was $txt
1469 0 ▶ if($self->{-idxopt} =~ /(^|,)x(,|$)/i);
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"-idxopt"} =~ /(^|,)x(,|$)/i 0 0 0
1470 }
1471 # ignore everything else
1472 }
1473 0 @text;
1474 }
1475  
1476 ## Helpers
1477  
1478 # set some default value unless already defined
1479 sub _default
1480 46 ▶{
Subroutine _default: called CC=2 SCAR=6.9
1481 46 ▶ $_[0]->{$_[1]} = $_[2] unless(defined $_[0]->{$_[1]});
Branch: 1 branch
BranchTrueFalseTotal
unless defined $_[0]{$_[1]} 38 8 46
1482 }
1483  
1484 # setup the basic frame for a HTML tree
1485 sub _basic_html
1486 0 ▶{
Subroutine _basic_html: not called CC=1 SCAR=6.9
1487 0 my $html = HTML::Element->new('html');
1488 0 my $head = HTML::Element->new('head');
1489 0 $head->push_content("\n",
1490 HTML::Element->new('meta', 'http-equiv' => 'Content-Type',
1491 content => 'text/html; charset=ISO-8859-1'), "\n",
1492 HTML::Element->new('meta', 'http-equiv' => 'Content-Style-Type',
1493 content => 'text/css'), "\n",
1494 HTML::Element->new('meta', 'name' => 'GENERATOR',
1495 content => "Marek::Pod::HTML $VERSION"), "\n");
1496 0 $html->push_content("\n",$head,"\n");
1497 0 my $body = HTML::Element->new('body');
1498 0 $body->push_content("\n");
1499 0 $html->push_content($body,"\n");
1500 0 ($html,$head,$body);
1501 }
1502  
1503 # create a set of unique ids
1504 0 ▶sub _unique_ids {
Subroutine _unique_ids: not called CC=5 SCAR=34.0
1505 0 my (@nodes) = @_;
1506  
1507 # we need the hashes both ways...
1508 0 my %hash = ();
1509 0 my %Node = ();
1510 0 foreach my $node (@nodes) {
1511 # start with string
1512 0 my $id = _idfy($node,\%hash);
1513 0 $hash{$id} = 1;
1514 0 $Node{$node} = $id;
1515 0 $node = [ $node, $id ];
1516 }
1517 # create secondary nodes (needed mainly for perlfunc)
1518 0 my @addnodes = ();
1519 0 foreach my $node (keys %Node) {
1520 0 ▶ if($node =~ /^(\S+)\s+\S/) { # more than one word
Branch: 1 branch
BranchTrueFalseTotal
if ($node =~ /^(\S+)\s+\S/) 0 0 0
1521 0 ▶ push(@addnodes, [ $1, $Node{$node} ]) unless(defined $Node{$1});
Branch: 1 branch
BranchTrueFalseTotal
unless defined $Node{$1} 0 0 0
1522 }
1523 }
1524 0 @nodes,@addnodes;
1525 }
1526  
1527 # turn a string into a unique id
1528 # hashref points to a has with already existing ids
1529 sub _idfy
1530 0 ▶{
Subroutine _idfy: not called CC=3 SCAR=24.8
1531 0 my ($id,$hashref) = @_;
1532
1533 # collapse entities
1534 0 $id =~ s/E<([^>]*)>/$1/g;
1535 # collapse all non-alphanum characters to _
1536 0 $id =~ s/\W+/_/g;
1537 # collapse multiple _
1538 0 $id =~ s/_{2,}/_/g;
1539 # abbreviate to 20 characters
1540 0 $id = substr($id,0,20);
1541 # has to have some contents
1542 0 ▶ $id = '_' unless($id);
Branch: 1 branch
BranchTrueFalseTotal
unless $id 0 0 0
1543 0 my $ext = '';
1544 # find something unique
1545 0 ▶ $ext++ while($hashref->{$id.$ext});
Branch: 1 branch
BranchTrueFalseTotal
$$hashref{$id . $ext} and do { ++$ext } 0 0 0
1546 0 $id . $ext;
1547 }
1548  
1549  
1550 # prepend a paragraph with links to an HTML object's contents
1551 0 ▶sub _add_links {
Subroutine _add_links: not called CC=1 SCAR=6.9
1552 0 1;
1553 }
1554  
1555 # turn a POD name into a HTML file name
1556 0 ▶sub _construct_file_name {
Subroutine _construct_file_name: not called CC=2 SCAR=17.9
1557 0 my ($file,$depth,$suffix) = @_;
1558 0 $file =~ s!::!/!g; #/
1559 0 ▶ $file .= $suffix if($suffix);
Branch: 1 branch
BranchTrueFalseTotal
if $suffix 0 0 0
1560 0 ('../' x $depth) . $file;
1561 }
1562  
1563 # check if linkable and put into appropriate tag
1564 sub _autolink_and_highlight
1565 0 ▶{
Subroutine _autolink_and_highlight: not called CC=6 SCAR=37.4
1566 0 my ($self,$tref,$contents,$line,$nest,$type,$doit) = @_;
1567  
1568 0 my $tag = HTML::Element->new($type);
1569 0 push(@$tref,$tag);
1570 # canonicalize raw_text before lookup
1571 0 my $cruncher = Pod::Checker->new(-quiet => 1);
1572 0 ▶ $cruncher->errorsub(sub { 1; }); # suppress any errors
Subroutine __ANON__: not called CC=1 SCAR=6.9
1573 0 my $text = $cruncher->interpolate_and_check($contents->raw_text(),
1574 $line,'');
1575 0 $text =~ s/^\s+|\s+$//g;
1576 0 my ($node_ref); # will contain [$page,$id]
1577 # try to find text in the libpod nodes. Do not link if
1578 # currently processing the anchor paragraph itself
1579 # (avoid reciprocal links)
1580 0 ▶ if($doit && $self->{-lib} &&
Branch: 1 branch
BranchTrueFalseTotal
if ($doit and $self->{"-lib"} and $node_ref = $self->{"-lib"}{$text} and not $node_ref->[0] eq $self->{"-name"} && $node_ref->[1] eq $self->{"_current_anchor"}) 0 0 0
Condition0%0/12
$doit and $self->{"-lib"} and $node_ref = $self->{"-lib"}{$text} and not $node_ref->[0] eq $self->{"-name"} && $node_ref->[1] eq $self->{"_current_anchor"}
!ll&&!rl&&r
000
$doit and $self->{"-lib"} and $node_ref = $self->{"-lib"}{$text}
!ll&&!rl&&r
000
$doit and $self->{"-lib"}
!ll&&!rl&&r
000
$node_ref->[0] eq $self->{'-name'} && $node_ref->[1] eq $self->{'_current_anchor'}
!ll&&!rl&&r
000
MC/DC0%0/5
$doit and $self->{"-lib"} and $node_ref = $self->{"-lib"}{$text} and not $node_ref->[0] eq $self->{"-name"} && $node_ref->[1] eq $self->{"_current_anchor"}
$doit $self->{"-lib"} $node_ref = $self->{"-lib"}{$text} $node_ref->[0] eq $self->{'-name'} $node_ref->[1] eq $self->{'_current_anchor'}
Truth table0%0/6
A and B and C and not(D && E)
A= $doitB= $self->{"-lib"}C= $node_ref = $self->{"-lib"}{$text}D= $node_ref->[0] eq $self->{'-name'}E= $node_ref->[1] eq $self->{'_current_anchor'}
ABCDEresult
0XXXX0
10XXX0
110XX0
111110
1110X1
111101
1581 ($node_ref = $self->{-lib}->{$text}) &&
1582 !($$node_ref[0] eq $self->{-name} &&
1583 $$node_ref[1] eq $self->{_current_anchor})) {
1584 my $anchor = HTML::Element->new('a', CLASS => 'POD_LINK',
1585 href => _construct_file_name($$node_ref[0], $self->depth(),
1586 0 $self->{-suffix} . '#' . $$node_ref[1]));
1587 0 $tag->push_content($anchor);
1588 0 $tag = $anchor;
1589 }
1590 0 $tag->push_content($self->_expand_ptree($contents, $line, $nest));
1591 }
1592  
1593 # expand blanks and tabs to an appropriate amount of non-breaking space
1594 0 ▶sub _expand_tab {
Subroutine _expand_tab: not called CC=5 SCAR=34.0
1595 # TODO more magic: indent by one blank less than in $str -
1596 # this would allow for the missing E<br> syntax
1597 0 my ($str, $pos) = @_;
1598 0 my $new = '';
1599 0 ▶ $pos ||= 0;
Condition0%0/2
$pos ||= 0
l!l
00
MC/DC0%0/1
$pos ||= 0
$pos
Truth table0%0/2
A
A= $pos
Aresult
11
00
1600 0 ▶ while($str =~ m/([ \t])/g) {
Branch: 1 branch
BranchTrueFalseTotal
if ($str =~ /([ \t])/g) 0 0 0
1601 0 ▶ if($1 eq ' ') {
Branch: 1 branch
BranchTrueFalseTotal
if ($1 eq ' ') { } 0 0 0
1602 0 $new .= $NBSP;
1603 0 $pos++;
1604 }
1605 else {
1606 0 my $len = $pos % 8;
1607 0 ▶ $len = 8 unless($len);
Branch: 1 branch
BranchTrueFalseTotal
unless $len 0 0 0
1608 0 $new .= $NBSP x $len;
1609 0 $pos += $len;
1610 }
1611 }
1612 0 $new;
1613 }
1614  
1615 # prepend local navigation to body
1616 0 ▶sub _local_toc {
Subroutine _local_toc: not called CC=5 SCAR=34.0
1617 0 my $self = shift;
1618 0 ▶ if(defined $self->{_toc}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $self->{"_toc"}) 0 0 0
1619 0 my $level = 1;
1620 0 my @hier = ( HTML::Element->new('ul') );
1621 0 $hier[0]->push_content("\n");
1622 0 $self->{_body}->unshift_content("\n", $hier[0], "\n",
1623 HTML::Element->new('hr'));
1624 0 foreach(@{$self->{_toc}}) {
1625 0 my ($l, $id, @line) = @$_;
1626 0 ▶ while($l > $level) {
Branch: 1 branch
BranchTrueFalseTotal
if ($l > $level) 0 0 0
1627 # new sublevel
1628 0 push(@hier, HTML::Element->new('ul'));
1629 0 $hier[-2]->push_content($hier[-1], "\n");
1630 0 $level++;
1631 0 $hier[-1]->push_content("\n");
1632 }
1633 0 ▶ while($l < $level) {
Branch: 1 branch
BranchTrueFalseTotal
if ($l < $level) 0 0 0
1634 0 pop(@hier);
1635 0 $level--;
1636 }
1637 0 my $item = HTML::Element->new('li');
1638 0 my $anchor = HTML::Element->new('a', CLASS => 'POD_NAVLINK',
1639 href => "#$id");
1640 0 $item->push_content($anchor);
1641 0 $anchor->push_content(@line);
1642 0 $hier[-1]->push_content($item, "\n");
1643 }
1644 }
1645 }
1646  
1647 # push a raw HTML string on the current contents
1648 0 ▶sub _push_raw_html {
Subroutine _push_raw_html: not called CC=11 SCAR=48.8
1649 0 my ($self,$node,$str) = @_;
1650 0 my $tree = new HTML::TreeBuilder;
1651 0 $tree->warn(1);
1652 0 $tree->implicit_tags(1);
1653 0 $tree->ignore_unknown(1);
1654 0 $tree->store_comments(1);
1655 0 $tree->p_strict(1);
1656 #$tree->implicit_body_p_tag(1);
1657 0 $tree->parse($str);
1658 0 $tree->eof;
1659 0 my $head = $tree->find_by_tag_name('head');
1660 0 ▶ $self->{_head}->push_content(@{$head->content()},"\n")
Branch: 1 branch
BranchTrueFalseTotal
if $head and $head->content 0 0 0
Condition0%0/3
$head and $head->content
!ll&&!rl&&r
000
MC/DC0%0/2
$head and $head->content
$head $head->content
Truth table0%0/3
A and B
A= $headB= $head->content
ABresult
0X0
100
111
1661 if($head && $head->content());
1662 0 my $body = $tree->find_by_tag_name('body');
1663 0 ▶ $node->push_content(@{$body->content()})
Branch: 1 branch
BranchTrueFalseTotal
if $body and $body->content 0 0 0
Condition0%0/3
$body and $body->content
!ll&&!rl&&r
000
MC/DC0%0/2
$body and $body->content
$body $body->content
Truth table0%0/3
A and B
A= $bodyB= $body->content
ABresult
0X0
100
111
1664 if($body && $body->content());
1665 # this will not delete the contents, they have been pushed
1666 # somewhere else
1667 0 $tree->delete();
1668  
1669 # consolidate p tags, i.e. re-root them appropriately
1670 0 my $lastp;
1671 0 ▶ if($node->tag() eq 'p') {
Branch: 1 branch
BranchTrueFalseTotal
if ($node->tag eq "p") 0 0 0
1672 0 my $root = $node->parent();
1673 0 foreach($node->content_refs_list) {
1674 0 ▶ if(ref $$_ && $$_->tag() eq 'p') {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $$_ and $$_->tag eq "p") 0 0 0
Condition0%0/3
ref $$_ and $$_->tag eq "p"
!ll&&!rl&&r
000
MC/DC0%0/2
ref $$_ and $$_->tag eq "p"
ref $$_ $$_->tag eq "p"
Truth table0%0/3
A and B
A= ref $$_B= $$_->tag eq "p"
ABresult
0X0
100
111
1675 0 my $parent = $$_->parent();
1676 0 my $pindex = $$_->pindex();
1677 0 my ($p,@rest) = $parent->splice_content($pindex);
1678 0 ▶ if(@rest) {
Branch: 1 branch
BranchTrueFalseTotal
if (@rest) { } 0 0 0
1679 0 my %attr = $node->all_attr();
1680 0 my $newp = HTML::Element->new('p', $node->all_external_attr());
1681 0 $newp->push_content(@rest);
1682 0 $root->push_content($p,"\n",$newp,"\n");
1683 0 $lastp = 'beginfor';
1684 } else {
1685 0 $root->push_content($p,"\n");
1686 0 $lastp = 'raw';
1687 }
1688 }
1689 }
1690 }
1691 0 ▶ $self->{_last_p_by} = $lastp || 'beginfor';
Condition0%0/2
$lastp || 'beginfor'
l!l
00
MC/DC0%0/1
$lastp || 'beginfor'
$lastp
Truth table0%0/2
A
A= $lastp
Aresult
11
00
1692 0 1;
1693 }
1694  
1695 # process a part of HTML::Element into plain text
1696 0 ▶sub _to_text {
Subroutine _to_text: not called CC=3 SCAR=24.8
1697 0 my @out;
1698 0 foreach(@_) {
1699 0 ▶ if(ref $_) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $_) { } 0 0 0
1700 0 push(@out, $_->as_text());
1701 }
1702 else {
1703 0 push(@out, HTML::Entities::decode_entities($_));
1704 }
1705 }
1706 0 join('',@out);
1707 }
1708  
1709 # needed to get rid of all HTML::Element's
1710 0 ▶sub DESTROY {
Subroutine DESTROY: not called CC=2 SCAR=17.9
1711 0 my $self = shift;
1712 0 ▶ $self->{_html}->delete() if(defined $self->{_html});
Branch: 1 branch
BranchTrueFalseTotal
if defined $self->{"_html"} 0 0 0
1713 }
1714  
1715 =head1 SEE ALSO
1716  
1717 L<Pod::Checker>, L<Pod::Parser>, L<Pod::Find>, L<HTML::Element>,
1718 L<HTML::TreeBuilder>, L<HTML::Entities>, L<HTML::FormatPS>,
1719 L<HTML::Tagset>, L<pod2man>, L<pod2text>, L<Pod::Man>
1720  
1721 =head1 AUTHOR
1722  
1723 Marek Rouchal E<lt>marekr@cpan.orgE<gt>
1724  
1725 =head1 HISTORY
1726  
1727 A big deal of this code has been recycled from a variety of existing
1728 Pod converters, e.g. by Tom Christiansen and Russ Allbery. A lot of
1729 ideas came from Nick Ing-Simmons' B<PodToHtml>, e.g. the usage of the
1730 B<HTML::Element> module and the B<HTML::FormatPS> module.
1731 Without the B<Pod::Parser> module by Brad Appleton and the
1732 B<HTML::Element> module by Gisle Aas this module would not exist.
1733  
1734 =cut
1735  
1736 4 1;
1737  
↑ Summary script/mpod2html »