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

custom-ui

use v6.d;
use File::Temp;
use JSON::Fast;

state $atom-highlights-path = set-highlight-basedir;
state $atom-highlighter;
state $highlighter-supply;
state &highlight = -> $frag { $frag };

if test-highlighter( $atom-highlights-path ) {
    $atom-highlighter = Proc::Async.new(
        "{ $atom-highlights-path }/node_modules/coffeescript/bin/coffee",
        "{ $atom-highlights-path }/highlight-filename-from-stdin.coffee", :r, :w);
    $highlighter-supply = $atom-highlighter.stdout.lines;
    # set up the highlighter closure
    &highlight = sub ( $frag ) {
        return $frag unless $frag ~~ Str:D;
        $atom-highlighter.start unless $atom-highlighter.started;

        my ($tmp_fname, $tmp_io) = tempfile;
        # the 

comment


sub set-highlight-basedir( --> Str ) {
    my $basedir = $*HOME;
    my $hilite-path = "$basedir/.local/lib".IO.d
            ?? "$basedir/.local/lib/raku-pod-render/highlights".IO.mkdir
            !! "$basedir/.raku-pod-render/highlights".IO.mkdir;
    exit 1 unless ~$hilite-path;
    ~$hilite-path
}
sub test-highlighter( Str $hilite-path --> Bool ) {
    ?("$hilite-path/package-lock.json".IO.f and "$hilite-path/atom-language-perl6".IO.d)
}

%(
    'block-code' => sub ( %prm, %tml ) {
        &highlight( %prm<contents> )
    }
)

02-highlighter

TITLE

These are the cool possibilities using the C<Collection> and C<Raku::Pod::Render> distributions.


(The repeated headings in the Table of Contents are deliberate, as will become clear in this text.)


Assigning new classes to standard HTML templates.


head

code

=begin code
=for HR :class<yellowish-dots>

=for HR :class<bluish-dots>

=for HR :class<greenish-dots>

=end code


C<Raku::Pod::Render> introduces the idea of 'plugins' to keep block names and the templates
associated with them together. C<Collection> takes the concept further by having
plugins that can run Raku programs at each stage of the Collection process, after the
I<Mode> has been configured.


Plugins keep the CSS, templates and new custom block names in the same sub-directory.


This mechanism also means that I<Mode> specific output, such as I<scripts> and I<CSS> for
I<HTML> output can be managed by I<Mode> plugins. The I<Website> mode for C<Collection-Raku-Documentation>
contains plugins to gather I<CSS>, I<jQuery scripts>, I<js libraries>, and I<Images> from other
plugins, and collate them so that they are served with each page.


Since the entire page is in a template, it is also possible to create separate page templates,
with different CSS assets.


The following are Custom user-facing Pod::Blocks that come with C<Collection-Raku-Documentation>


For Raku files, a special block was created for the various types of Camelia image.
They normally float on the right-hand side. In order to contain them before
the next set of texts, they are included in an HTML5 C<flex-box>, which is
created using a template for C<para>.


=begin code
=begin para :template<flex-container>
=Camelia
=CameliaShadow
=CameliaFaded
=end para
=end code


Camelia

CameliaShadow

CameliaFaded

Adding new templates for existing Pod::Blocks


Suppose you want a different template to act on an existing block, like Para,
which is coded as HTML C<<p>>. For example,


=begin code
I like this sonnet:
=for para :template<quotation> :author<William Shakespeare> :citation<Sonnet 116>
Let me not to the marriage of true minds\n
Admit impediments; love is not love\n
Which alters when it alteration finds,\n
Or bends with the remover to remove.
=end code


Let me not to the marriage of true minds\n
Admit impediments; love is not love\n
Which alters when it alteration finds,\n
Or bends with the remover to remove.


Here is an example where the format code F has been leveraged to generate B<FontAwesome> icons.
The plugin here utilises v4.7. The API for v5 / 6 is different, so another plugin may be needed.


Since Raku treats all Unicode characters the same, Chinese/Arabic/Cyrillic glyphs can now be
specified to repeat or alias the predefined codes of C<B C I K T U E Z X N L P V >.


=begin code
Some FontAwesome icons

F<fa-ambulance> Example of ambulance

F<fa-automobile> Example of automobile (alias)

F<fa-bicycle> Example of bicycle

F<fa-bus> Example of bus

F<fa-truck> Example of truck

F<fa-wheelchair> Example of wheelchair

F<fa-wheelchair-alt> Example of wheelchair-alt
=end code


F<fa-automobile> Example of automobile (alias)


F<fa-wheelchair-alt> Example of wheelchair-alt


=begin code

Train normal size F<fa-train> Triple size train F<fa-train|fa-3x>

An animated spinner F<fa-refresh|fa-spin fa-3x fa-fw>
=end code


Train normal size F<fa-train> Triple size train F<fa-train|fa-3x>


An animated spinner F<fa-refresh|fa-spin fa-3x fa-fw>


Notice how these examples leverage off the idea of meta data together with a Format Code. This
is not standard Rakudoc (aka POD6), as this metadata is only specified for C< X<> > and C< L<> >.
C<Raku::Pod::Render>
allows for metadata to be added to any I<non-standard> letter used as a Format Code, and
any Unicode thingy that Raku treats as a "character" to be made into a Format Code.


When many Rakudoc files are included in a collection, there is a need to collect data from each. So
for example, the Raku Documentation files all have metadata associated with the first C<pod> definition.
We need to collect files according to the metadata. The keys C<kind>, C<subkind>, and C<category>
are allocated to all Raku Documents.


=begin code
=for ListFiles :select<kind=Programs>
Programs that support Raku development

=end code


ListFiles

=begin code
=for ListFiles :select<kind=Programs> :headlevel(0)
Programs that support Raku development, title is not included in the TOC.

=end code


Other examples of ListFiles can be seen in the L<TOC|toc> and L<Itemised index|glossary> pages.


New Pod Blocks


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


custom-ui

Collection-Plugin-Development v0.3.0

Authors

License

Dependencies

Test Dependencies

Provides

Documentation