Lines Matching +full:x +full:- +full:whatever
4 Pod::Simple - framework for parsing Pod
17 Be sure to read L</ENCODING> if your Pod contains non-ASCII characters.
24 program that has a multi-line quoted string which has lines that look
28 If you're reading this document just because you have a Pod-processing
34 then possibly even read L<perlpodspec> (some of which is for parser-writers,
35 but much of which is notes to formatter-writers).
41 =item C<< $parser = I<SomeClass>->new(); >>
46 =item C<< $parser->output_fh( *OUT ); >>
54 $parser->output_fh(*TXTOUT);
56 ...before you call one of the C<< $parser->parse_I<whatever> >> methods.
58 =item C<< $parser->output_string( \$somestring ); >>
64 =item C<< $parser->parse_file( I<$some_filename> ); >>
66 =item C<< $parser->parse_file( *INPUT_FH ); >>
70 C<$parser>'s class works, and according to whatever parser options you
73 =item C<< $parser->parse_string_document( I<$all_content> ); >>
79 =item C<< $parser->parse_lines( I<...@lines...>, undef ); >>
82 defined value, and must contain exactly one line of content -- so no
86 The other C<parser_I<whatever>> methods are meant to be called only once
92 =item C<< $parser->content_seen >>
98 =item C<< I<SomeClass>->filter( I<$filename> ); >>
100 =item C<< I<SomeClass>->filter( I<*INPUT_FH> ); >>
102 =item C<< I<SomeClass>->filter( I<\$document_content> ); >>
106 filehandle, or in-memory document). This is handy for one-liners like
109 perl -MPod::Simple::Text -e "Pod::Simple::Text->filter('thingy.pod')"
118 well as of interest to formatter-writers.
120 Note that the general pattern here is that the accessor-methods
121 read the attribute's value with C<< $value = $parser->I<attribute> >>
123 C<< $parser->I<attribute>(I<newvalue>) >>. For each accessor, I typically
130 =item C<< $parser->parse_characters( I<SOMEVALUE> ) >>
138 =item C<< $parser->no_whining( I<SOMEVALUE> ) >>
149 =item C<< $parser->no_errata_section( I<SOMEVALUE> ) >>
157 =item C<< $parser->complain_stderr( I<SOMEVALUE> ) >>
166 =item C<< $parser->source_filename >>
171 =item C<< $parser->doc_has_started >>
177 =item C<< $parser->source_dead >>
182 =item C<< $parser->strip_verbatim_indent( I<SOMEVALUE> ) >>
192 verbatim blocks. This method tells Pod::Simple what to strip. For two-space
195 $parser->strip_verbatim_indent(' ');
199 $parser->strip_verbatim_indent("\t");
210 $new->strip_verbatim_indent(sub {
212 (my $indent = $lines->[0]) =~ s/\S.*//;
217 transforming them in-place in the code reference and returning C<undef>. Say
220 $new->strip_verbatim_indent(sub {
226 =item C<< $parser->expand_verbatim_tabs( I<n> ) >>
239 C<undef> or containing non-digits has the same effect as 8.
247 =item C<< $parser->abandon_output_fh() >>X<abandon_output_fh>
252 =item C<< $parser->abandon_output_string() >>X<abandon_output_string>
257 =item C<< $parser->accept_code( @codes ) >>X<accept_code>
261 =item C<< $parser->accept_codes( @codes ) >>X<accept_codes>
264 used to implement user-defined codes.
266 =item C<< $parser->accept_directive_as_data( @directives ) >>X<accept_directive_as_data>
271 implement user-defined directives.
273 =item C<< $parser->accept_directive_as_processed( @directives ) >>X<accept_directive_as_processed>
278 implement user-defined directives.
280 =item C<< $parser->accept_directive_as_verbatim( @directives ) >>X<accept_directive_as_verbatim>
284 can be used to implement user-defined directives.
286 =item C<< $parser->accept_target( @targets ) >>X<accept_target>
290 =item C<< $parser->accept_target_as_text( @targets ) >>X<accept_target_as_text>
294 =item C<< $parser->accept_targets( @targets ) >>X<accept_targets>
298 =item C<< $parser->accept_targets_as_text( @targets ) >>X<accept_targets_as_text>
303 =item C<< $parser->any_errata_seen() >>X<any_errata_seen>
309 die "too many errors\n" if $parser->any_errata_seen();
311 =item C<< $parser->errata_seen() >>X<errata_seen>
317 if ( $parser->any_errata_seen() ) {
318 $logger->log( $parser->errata_seen() );
321 =item C<< $parser->detected_encoding() >>X<detected_encoding>
326 =item C<< $parser->encoding() >>X<encoding>
331 =item C<< $parser->parse_from_file( $source, $to ) >>X<parse_from_file>
336 =item C<< $parser->scream( @error_messages ) >>X<scream>
340 =item C<< $parser->unaccept_code( @codes ) >>X<unaccept_code>
344 =item C<< $parser->unaccept_codes( @codes ) >>X<unaccept_codes>
348 =item C<< $parser->unaccept_directive( @directives ) >>X<unaccept_directive>
352 =item C<< $parser->unaccept_directives( @directives ) >>X<unaccept_directives>
356 =item C<< $parser->unaccept_target( @targets ) >>X<unaccept_target>
360 =item C<< $parser->unaccept_targets( @targets ) >>X<unaccept_targets>
364 =item C<< $parser->version_report() >>X<version_report>
368 =item C<< $parser->whine( @error_messages ) >>X<whine>
370 Log an error unless C<< $parser->no_whining( TRUE ); >>.
381 attempt to guess the encoding (selecting one of UTF-8 or CP 1252) by examining
382 the first non-ASCII bytes and applying the heuristic described in
405 pod-people@perl.org mail list. Send an empty email to
406 pod-people-subscribe@perl.org to subscribe.
409 L<https://github.com/perl-pod/pod-simple/>. Feel free to fork and contribute, or
410 to clone L<https://github.com/perl-pod/pod-simple.git> and send patches!
412 Please use L<https://github.com/perl-pod/pod-simple/issues/new> to file a bug