Image

head

code

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

README

unit class Pod::Usage;

my sub load(Str $classname) {
    my $loaded = try ::($classname);
    return $loaded if $loaded !eqv Any;
    require ::($classname);
    return ::($classname);
}

sub filter-usage(@pod-elements) is export(:filter) {
	my @contents = flat @pod-elements.map: { .contents.grep: { $_ ~~ Pod::Heading && .contents[0].contents.uc eq 'USAGE' ^fff^ $_ ~~ Pod::Heading } };
	Pod::Block::Named.new(:name<para>, :@contents);
}

proto render-usage(|)  is export(:DEFAULT, :render) { * }
multi render-usage(@pod-elements, Str:D :$renderer = %*ENV<POD_RENDERER> // 'Pod::To::Text') {
	render-usage(@pod-elements, :renderer(load($renderer)));
}
multi render-usage(@pod-elements, Any:U :$renderer!) {
	my $payload = filter-usage(@pod-elements);
	$renderer.render($payload);
}



Pod::Usage - extracts POD documentation to show usage information


=begin code :lang<raku>

use Pod::Usage;

multi MAIN(Bool :$help!) {
	render-usage($=pod);
}

sub GENERATE-USAGE(Routine $main, |capture) {
	render-usage($=pod);
}

=end code


Pod::Usage is a helper module for generating a usage message that isn't generated from C<sub MAIN>, but instead taken from the USAGE section of your documentation.


This filters out the text under the C<USAGE> and manipulates it to a renderable POD sniplet.


render-usage(@pod-elements, :$renderer = Pod::To::Text)


This takes the pod sniplet as extracted by C<filter-usage> and renders it using the given renderer.


item

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.


Usage

unit role Pod::TreeWalker::Listener;

# Only include bare Pod::Block objects by default.  You will need
# to add other candidates to allow other node types.
multi method start(Pod::Block:D $node) { self.WHAT =:= Pod::Block }
multi method end(  Pod::Block:D $node) { self.WHAT =:= Pod::Block }

method start-list(Int :$level, Bool :$numbered) { }
method end-list(Int :$level, Bool :$numbered) { }
method table-row(Array:D $row) { }
method config(Pod::Config:D $node) {  }
method text(Str:D $text) {  }



Pod::TreeWalker::Listener - Role for classes which handle events produced by Pod::TreeWalker


=begin code :lang<raku>

class MyListener does Pod::TreeWalker::Listener {
    multi method start(Pod::Heading $node --> False) {
        say "Heading level {$node.level}";
    }

    multi method end(  Pod::Heading $node --> False) {
        say "Heading level {$node.level}";
    }

    method table-row (Array $row) { ... }
}

=end code


This role defines the API which objects passed to C<Pod::TreeWalker>'s
constructor are expected to implement.


=begin code :lang<raku>

$listener.start(... $node --> False)

=end code


The C<start> method is a multi method which is called for most Pod objects. It
is passed a L<doc:Pod::Block> object of some sort.


If this method returns C<False>, then the C<Pod::TreeWalker> will not look
at the contents of the node, nor will it call the corresponding C<end> method
for the node.


The headers of a table (from C<$node.headers>) are passed as an array of
L<Pod::Blocks>.


=begin code :lang<raku>

$listener.end(  ... $node --> False)

=end code


The C<end> is a multi method that is called for most Pod objects.  It is
passed a C<Pod::Block> object of some sort.


=begin code :lang<raku>

$listener.start-list(Int :$level, Bool :numbered)

=end code


This method is called whenever a new list level is encountered. It can be
called multiple times in a row if a list item is introduced that skips levels,
for example:


=begin code

=item1 start-list is called once
=item3 start-list is called twice

=end code


=begin code :lang<raku>

$listener.end-list(Int :$level, Bool :numbered)

=end code


This method is called whenever a list level is done. List C<start-list>, it
can be called multiple times in a row.


=begin code :lang<raku>

$listener.table-row(Array $row)

=end code


This method is called once for each row in a table. Each element of C<$row>
will in turn be a L<Pod::Block>.


=begin code :lang<raku>

$listener.config(Pod::Config $node --> False)

=end code


This method is called for Pod config declarations.


=begin code :lang<raku>

$listener.text(Str $text)

=end code


This method is called for plain text, usually inside a paragraph block.


Listener

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


README

NAME

SYNOPSIS

DESCRIPTION

METHODS

new

walk-pod

text-content-of

AUTHOR

COPYRIGHT AND LICENSE

Pod::TreeWalker v0.0.4

Authors

License

Dependencies

Test Dependencies

Provides

Documentation