Image

head

code

item

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

use v6.c;

unit module Pod::Utils:ver<0.0.2>;



Pod::Utils - Set of helper functions to ease create new
Pods elements.


# time to work with Pod::* elements!
say first-subtitle($=pod[0].contents);


SUBTITLE

Pod::Utils is a set of routines that help you to deal with Pod elements.
It lets you manipulate several kinds of Pod objects, obtain gists and modify 
headings.


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



#| Returns the first Pod::Block::Code found in an array, concatenating 
#| all lines in it. If none is found, it will return an empty string.
sub first-code-block(@pod) is export {
    @pod.first(* ~~ Pod::Block::Code).contents.grep(Str).join || "";
}

#| Returns the text in the first 

found in @pod.
sub first-title(@pod) is export {
    @pod.first((* ~~ Pod::Block::Named and *.name eq "TITLE"));
}


TITLE

found in @pod.
sub first-subtitle(@pod) is export {
    @pod.first((* ~~ Pod::Block::Named and *.name eq "SUBTITLE"));    
}



#| Converts Lists of Pod::Blocks to Strings.
multi textify-guts (Any:U,       ) is export { '' }
multi textify-guts (Str:D      \v) is export { v }
multi textify-guts (List:D     \v) is export { v».&textify-guts.Str }
multi textify-guts (Pod::Block \v) is export {
    # core module
    use Pod::To::Text;
    pod2text v;
}

#| Accepts a Pod::Block and returns a concatenation of the content of all subpods
multi sub recurse-until-str(Str:D $s) is export { $s }
multi sub recurse-until-str(Pod::Block $n) is export { $n.contents>>.&recurse-until-str().join }


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.


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


Usage

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

filter-usage(@pod-elements)

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

SEE ALSO

AUTHOR

COPYRIGHT AND LICENSE

Pod::Usage v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation