Skip to content
Newer
Older
100644 127 lines (69 sloc) 1.88 KB
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
1 =head1 POD
2
3 Plain Ol' Documentation
4
5 =head2 Inline documentation & formatting
6
7 POD allows you to create documentation with markup in your Perl code.
8 If you've seen Javadoc or PHPdoc, it's like that.
9 Rather, Javadoc and PHPdoc are like POD.
10
11 Except that POD is part of the language, not an add-on spec.
12
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
13 =head2 Create headings with C<=head1> and C<=head2>
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
14
15 =head1 MOST IMPORTANT
16
17 Blah blah
18
19 =head2 Subheading
20
21 blah blah
22
23 =head2 Subhading
24
25 blah blah
26
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
27 =head2 Create unordered lists
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
28
29 To create this list:
30
31 =over
32
33 =item * Wango
34
35 =item * Tango
36
37 =item * Fandango
38
39 =back
40
41 Use
42
43 =over
44
45 =item * Wango
46
47 =item * Tango
48
49 =item * Fandango
50
51 =back
52
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
53 =head2 Create ordered lists
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
54
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
55 To create this list:
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
56
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
57 =over
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
58
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
59 =item 1 Visit perl101.org
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
60
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
61 =item 2 ???
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
62
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
63 =item 3 Profit!
64
65 =back
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
66
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
67 Use
68
69 =over
70
71 =item 1 Visit perl101.org
72
73 =item 2 ???
74
75 =item 3 Profit!
76
77 =back
78
79 =head2 Use inline markup styles
80
81 POD uses BE<lt>E<gt>, IE<lt>E<gt> and CE<lt>E<gt> for B<bold>,
82 I<italics> and C<code>, respectively.
83
84 B<This is bolded>
85
86 I<This is italics>
87
88 C<This is code>
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
89
90 Your markup formats can nest.
91
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
92 =head2 Link with C<LE<lt>E<gt>>
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
93
8db4b74 @petdance Merged over the ttify branch, which is now dead
authored Apr 30, 2007
94 The C<LE<lt>E<gt>> links either to keywords in your document, as in
95 C<< LE<lt>MethodsE<gt> >>, or to a specific URL, as in
96 C<< LE<lt>http://search.cpan.orgE<gt> >>.
d5f3b1b @petdance Importing from Andy original repo
authored Apr 30, 2007
97
98 =head2 Paragraph mode vs. literal blocks
99
100 Everything in a paragraph word-wraps automatically. A paragraph
101 is separated by at least one blank line.
102
103 A literal block is indented at least one space
104 and does not
105 get
106 wrapped.
107
108 This came from:
109
110 Everything in a paragraph word-wraps automatically. A paragraph
111 is separated by at least one blank line.
112
113 A literal block is indented at least one space
114 and does not
115 get
116 wrapped.
117
118 =head2 POD does not make anything run slower.
119
120 It's stripped out at compile time.
121
122 =head2 TODO
123
124 Talk about double-bracketing
125
126
Something went wrong with that request. Please try again.