1Pod::Elemental::ParagraUpshe(r3)Contributed Perl DocumenPtoadt:i:oEnlemental::Paragraph(3)
2
3
4
6 Pod::Elemental::Paragraph - a paragraph in a Pod document
7
9 version 0.103006
10
12 This is probably the most important role in the Pod-Elemental
13 distribution. Classes including this role represent paragraphs in a
14 Pod document. The paragraph is the fundamental unit of dividing up Pod
15 documents, so this is a often-included role.
16
18 This library should run on perls released even a long time ago. It
19 should work on any version of perl released in the last five years.
20
21 Although it may work on older versions of perl, no guarantee is made
22 that the minimum required version will not be increased. The version
23 may be increased for any reason, and there is no promise that patches
24 will be accepted to lower the minimum required perl.
25
27 content
28 This is the textual content of the element, as in a Pod::Eventual
29 event. In other words, this Pod:
30
31 =head2 content
32
33 has a content of "content\n"
34
35 start_line
36 This attribute, which may or may not be set, indicates the line in the
37 source document where the element began.
38
40 as_pod_string
41 This returns the element as a string, suitable for turning elements
42 back into a document. Some elements, like a "=over" command, will
43 stringify to include extra content like a "=back" command. In the case
44 of elements with children, this method will include the stringified
45 children as well.
46
47 as_debug_string
48 This method returns a string, like "as_string", but is meant for
49 getting an overview of the document structure, and is not suitable for
50 reproducing a document. Its exact output is likely to change over
51 time.
52
54 Ricardo SIGNES <cpan@semiotic.systems>
55
57 This software is copyright (c) 2022 by Ricardo SIGNES.
58
59 This is free software; you can redistribute it and/or modify it under
60 the same terms as the Perl 5 programming language system itself.
61
62
63
64perl v5.38.0 2023-07-21 Pod::Elemental::Paragraph(3)