TITLE

Changes source filename starting 'Language', 'Type', 'Program' to lowercase.


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

raku-doc-setup is plugin for Collection


Default Raku Styling plugin for Collection


DESCRIPTION

Also provides the highlighter styling, but perhaps this needs to be broken out.


There are images in the css that need to be added to the assets folder using a render plugin.


Provides the B<=ListFiles> Pod::Block that lists all files in a B<Collection>
that have associated meta data.


In many cases, it is desirable to write a content file that has an annotated overview of all or some
of the files in the collection, showing the C<Title> together with the C<Subtitle>.


This list should be amenable to separate styling, so that long lists can be folded, or put into tabs.


Since C<Raku::Pod::Render> captures all the meta (or configuration) information associated with the
first Pod::Block named C<pod> in a file, this information can be extracted and used to list these
files in the Compilation stage.


head

Place C<listfiles> in the C<plugins-required<compilation>> B<and> C<plugins-required<render>> configuration keys.


Place the C<=for ListFiles :select<...> > in the Pod6 content file. See L<below for select|ListFiles block>.


In the content files that need to be listed, place meta data in the C<=begin pod> line, eg.


code

=begin code
    =begin pod :kind<Language> :category<tutorial>
=end code


The key names and the key values are arbitrary and depend only on the collection designer/writer.


=begin code
    =for ListFiles :select<key-name-1=key-value-1, key-name-2=key-value-2, ...> :no-desc<Nothing found> :no-files<aint got nothing>
    Some text for the caption in a single paragraph

Another way
    =begin ListFiles :select< ... > :no-desc<No description found>
    Some text in several paragraphs

    more caption text
    =end ListFiles
=end code


While C<ListFiles> is used here, C<Listfiles> and C<listfiles> are also possible.


If a ListFiles block is used without a C<select> key, then a C< <div> > with an error message is output.


If the C<select> key does not parse correctly, then an error div is also output.


It must have the form C<:select< ... > > so that the contents are a string. (Pod6 allows other
forms, which may be used so long as the argument is a string).


B<select> contains one, or a comma-separated list of, key/value pair(s) with the form C<\S+\s*=\s*\S+>.


The template will use the C<select> information to gather the files that meet the meta data criteria,
access the C<=TITLE> and C<=SUBTITLE> information in the Pod file, and list the files in alpahbetical
order.


This plugin only allows for a simple select semantic, such that files are selected when each key/value pair
is true. Other more complex select semantics could be considered in time.


If no C<=TITLE> block is found in the content file, the content filename is used instead.


If no C<=SUBTITLE> block is found, then the content of the C<no-desc> key is used. This allows for multilingual use.


If none of the alternatives are given, then the words 'no description' is used.


If there are no files that meet the C<select> criteria, then the text in C<no-files> is used.


If the option is not given, then the words 'No files meet the criteria' are used.


List File plugin for Collection


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


raku-doc-setup is plugin for Collection

Collection-Plugin-Development v0.3.0

Authors

License

Dependencies

Test Dependencies

Provides

Documentation