This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
The first big import towards 5.8.1, @18078. Please do NOT
[perl5.git] / lib / Pod / t / htmlview.pod
1 =head1 NAME
2
3 Test HTML Rendering
4
5 =head1 SYNOPSIS
6
7     use My::Module;
8
9     my $module = My::Module->new();
10
11 =head1 DESCRIPTION
12
13 This is the description.
14
15     Here is a verbatim section.
16
17 This is some more regular text.
18
19 Here is some B<bold> text, some I<italic> and something that looks 
20 like an E<lt>htmlE<gt> tag.  This is some C<$code($arg1)>.
21
22 This C<text contains embedded B<bold> and I<italic> tags>.  These can 
23 be nested, allowing B<bold and I<bold E<amp> italic> text>.  The module also
24 supports the extended B<< syntax >> and permits I<< nested tags E<amp>
25 other B<<< cool >>> stuff >>
26
27 =head1 METHODS =E<gt> OTHER STUFF
28
29 Here is a list of methods
30
31 =head2 new()
32
33 Constructor method.  Accepts the following config options:
34
35 =over 4
36
37 =item foo
38
39 The foo item.
40
41 =item bar
42
43 The bar item.
44
45 =over 4
46
47 This is a list within a list 
48
49 =item *
50
51 The wiz item.
52
53 =item *
54
55 The waz item.
56
57 =back
58
59 =item baz
60
61 The baz item.
62
63 =back
64
65 Title on the same line as the =item + * bullets
66
67 =over
68
69 =item * C<Black> Cat
70
71 =item * Sat S<I<on> the>
72
73 =item * MatE<lt>!E<gt>
74
75 =back
76
77 Title on the same line as the =item + numerical bullets
78
79 =over
80
81 =item 1 Cat
82
83 =item 2 Sat
84
85 =item 3 Mat
86
87 =back
88
89 No bullets, no title
90
91 =over
92
93 =item
94
95 Cat
96
97 =item
98
99 Sat
100
101 =item
102
103 Mat
104
105 =back
106
107 =head2 old()
108
109 Destructor method
110
111 =head1 TESTING FOR AND BEGIN
112
113 =for html    <br>
114 <p>
115 blah blah
116 </p>
117
118 intermediate text
119
120 =begin html
121
122 <more>
123 HTML
124 </more>
125
126 some text
127
128 =end html
129
130 =head1 TESTING URLs hyperlinking
131
132 This is an href link1: http://example.com
133
134 This is an href link2: http://example.com/foo/bar.html
135
136 This is an email link: mailto:foo@bar.com
137
138     This is a link in a verbatim block <a href="http://perl.org"> Perl </a>
139
140 =head1 SEE ALSO
141
142 See also L<Test Page 2|htmlescp>, the L<Your::Module> and L<Their::Module>
143 manpages and the other interesting file F</usr/local/my/module/rocks>
144 as well.
145
146 =cut