1Pod::Simple::PullParserUSstearrtCToonkterni(b3u)ted PerlPoDdo:c:uSmiemnptlaet:i:oPnullParserStartToken(3)
2
3
4
6 Pod::Simple::PullParserStartToken -- start-tokens from
7 Pod::Simple::PullParser
8
10 (See Pod::Simple::PullParser)
11
13 When you do $parser->get_token on a Pod::Simple::PullParser object, you
14 might get an object of this class.
15
16 This is a subclass of Pod::Simple::PullParserToken and inherits all its
17 methods, and adds these methods:
18
19 $token->tagname
20 This returns the tagname for this start-token object. For example,
21 parsing a "=head1 ..." line will give you a start-token with the
22 tagname of "head1", token(s) for its content, and then an end-token
23 with the tagname of "head1".
24
25 $token->tagname(somestring)
26 This changes the tagname for this start-token object. You probably
27 won't need to do this.
28
29 $token->tag(...)
30 A shortcut for $token->tagname(...)
31
32 $token->is_tag(somestring) or $token->is_tagname(somestring)
33 These are shortcuts for "$token->tag() eq somestring"
34
35 $token->attr(attrname)
36 This returns the value of the attrname attribute for this start-
37 token object, or undef.
38
39 For example, parsing a L<Foo/"Bar"> link will produce a start-token
40 with a "to" attribute with the value "Foo", a "type" attribute with
41 the value "pod", and a "section" attribute with the value "Bar".
42
43 $token->attr(attrname, newvalue)
44 This sets the attrname attribute for this start-token object to
45 newvalue. You probably won't need to do this.
46
47 $token->attr_hash
48 This returns the hashref that is the attribute set for this start-
49 token. This is useful if (for example) you want to ask what all
50 the attributes are -- you can just do "keys %{$token->attr_hash}"
51
52 You're unlikely to ever need to construct an object of this class for
53 yourself, but if you want to, call
54 "Pod::Simple::PullParserStartToken->new( tagname, attrhash )"
55
57 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
58
60 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
61
63 Questions or discussion about POD and Pod::Simple should be sent to the
64 pod-people@perl.org mail list. Send an empty email to
65 pod-people-subscribe@perl.org to subscribe.
66
67 This module is managed in an open GitHub repository,
68 <https://github.com/perl-pod/pod-simple/>. Feel free to fork and
69 contribute, or to clone <https://github.com/perl-pod/pod-simple.git>
70 and send patches!
71
72 Patches against Pod::Simple are welcome. Please send bug reports to
73 <bug-pod-simple@rt.cpan.org>.
74
76 Copyright (c) 2002 Sean M. Burke.
77
78 This library is free software; you can redistribute it and/or modify it
79 under the same terms as Perl itself.
80
81 This program is distributed in the hope that it will be useful, but
82 without any warranty; without even the implied warranty of
83 merchantability or fitness for a particular purpose.
84
86 Pod::Simple was created by Sean M. Burke <sburke@cpan.org>. But don't
87 bother him, he's retired.
88
89 Pod::Simple is maintained by:
90
91 • Allison Randal "allison@perl.org"
92
93 • Hans Dieter Pearcey "hdp@cpan.org"
94
95 • David E. Wheeler "dwheeler@cpan.org"
96
97
98
99perl v5.38.0 2023-07-2P1od::Simple::PullParserStartToken(3)