Image

head

Html

nested

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

TITLE

Mainly used to generate a README.md from <Modulename>.pm6, which contain POD6

SUBTITLE

Run C<Extractor> in the directory where the transformed files are needed.
Select POD6 files (C<.pod6>, C<.pm6>, C<.rakudoc>) by
clicking on the FileChooser button at the top of the panel. The Output file name by default is the same
as the basename of the input file, but can be changed. Select the output formats.

Select C<add github badge> to add a github badge at the beginning of the md file (typically README.md).
The name of the module and the source url is taken from the META6.json file. An exception is
generated if there is no META6.json file.

Will also generate HTML files from POD6 with css to be used as a static file. For HTML generation,
the CSS and Images/favicons can be replaced with non-functional divs.


If a file was selected by mistake, uncheck the 'convert' box on the far left and it will not be processed.


When the list is complete, click on B<Convert>. The converted files will be shown, or the failure message.

This tool is fairly primitive and it may not handle all error conditions. The tool is intended for generating
md and html files in an adhoc manner.


C<Extractor> requires GTK::Simple. It is known that this is difficult to install on Windows. However, if
the GTK library has already been installed on Windows, then GTK::Simple will load with no problem. Look at the GTK website
for information about Windows installations of GTK.

Extractor GUI


use v6.*;
use ExtractPod;
use Pod::To::HTML2:auth<github:finanalyst>;
use Pod::To::MarkDown:auth<github:finanalyst>;

use GTK::Simple::App;
use GTK::Simple::FileChooserButton;
use GTK::Simple::MarkUpLabel;
use GTK::Simple::VBox;
use GTK::Simple::HBox;
use GTK::Simple::CheckButton;
use GTK::Simple::Entry;
use GTK::Simple::Button;
use GTK::Simple::TextView;
use GTK::Simple::Grid;

unit module PodExtraction;

sub Extractor is export {
 my @files;
 my $cancel;
 my $action;
 my Str $badge-path;

 my $app = GTK::Simple::App.new(:title("Pod Extractor Utility"));
 $app.border-width = 5;
 my $file-chooser-button = GTK::Simple::FileChooserButton.new;
 #

Processing ==================================================
 my $html-options = GTK::Simple::Grid.new(
 [0, 0, 1, 1] => GTK::Simple::MarkUpLabel.new(
 text => 'HTML options'
 ),
 [0, 1, 1, 1] => my $hilite = GTK::Simple::CheckButton.new(:label('')),
 [1, 1, 1, 1] => GTK::Simple::MarkUpLabel.new(text => 'highlight'),
 [0, 2, 1, 1] => my $no-css = GTK::Simple::CheckButton.new(:label('')),
 [1, 2, 1, 1] => GTK::Simple::MarkUpLabel.new(text => 'minimise css, camelia image, and favicon'),
 [0, 3, 1, 1] => GTK::Simple::MarkUpLabel.new(
 text => 'Markdown options'
 ),
 [0, 4 , 1, 1] => my $badge = GTK::Simple::CheckButton.new(:label('')),
 [1, 4, 1, 1] => GTK::Simple::MarkUpLabel.new(text => 'Add github badge'),
 [0, 5, 1, 1] => GTK::Simple::MarkUpLabel.new(
 text => 'Github badge path [module name]'),
 [1, 6, 1, 1] => my $b-path-entry = GTK::Simple::Entry.new(
 placeholder-text => 'Using default calculated path' ),
 );
 my Bool $highlight-code = $hilite.status = False;
 my Bool $min-top = $no-css.status = False;
 my Bool $md-badge = $badge.status = False;
 $hilite.toggled.tap: -> $b { $highlight-code = !$highlight-code }
 $no-css.toggled.tap: -> $b { $min-top = !$min-top }
 $badge.toggled.tap: -> $b { $md-badge = !$md-badge }
 $b-path-entry.changed.tap: -> $b { $badge-path = $b-path-entry.text }
 $html-options.column-spacing = 10;
 # ====================================================================
 # =FILE BOX ==========================================================
 my $files-box = GTK::Simple::Grid.new(
 [0, 0, 1, 1] => GTK::Simple::MarkUpLabel.new(text => 'convert'),
 [1, 0, 1, 1] => GTK::Simple::MarkUpLabel.new(text => 'path/input filename'),
 [2, 0, 1, 1] => GTK::Simple::MarkUpLabel.new(text => 'output filename'),
 [3, 0, 1, 1] => GTK::Simple::MarkUpLabel.new(text => '.md'),
 [4, 0, 1, 1] => GTK::Simple::MarkUpLabel.new(text => '.html'),
 );
 $files-box.column-spacing = 10;
 # ===========================================================
 # =Bottom buttons ============================================
 my $buttons = GTK::Simple::HBox.new([
 $cancel = GTK::Simple::Button.new(:label<Cancel>),
 $action = GTK::Simple::Button.new(:label<Convert>)
 ]);
 # ===============================================================
 my $report = GTK::Simple::MarkUpLabel.new;
 # == Main Contain ===============================================
 my $convert = GTK::Simple::VBox.new([
 { :widget(GTK::Simple::HBox.new([
 { :widget(GTK::Simple::MarkUpLabel.new(text => "Select files with POD6 by clicking on the button"))
 , :padding(15)},
 $file-chooser-button])), :!expand },
 $html-options,
 $files-box,
 { :widget($report), :!expand },
 { :widget($buttons), :!expand }
 ]);
 # ===============================================================

HTML

Action

$file-chooser-button.file-set.tap: {
 $action.sensitive = True;
 add-to-files($file-chooser-button.file-name, $highlight-code);
 }
 $cancel.clicked.tap: -> $b { $app.exit };
 $action.sensitive = False;
 $action.clicked.tap: -> $b {
 $cancel.label = 'Finish';
 my @md = @files.grep({ .<md> and .<convert> });
 my @html = @files.grep({ .<html> and .<convert> });
 HTML(@html, $report, $highlight-code, $min-top) if ?@html;
 MarkDown(@md, $report, $md-badge, $badge-path) if ?@md;
 };

 $app.set-content($convert);

 $app.show;
 $app.run;
}

sub HTML(@fn, $report, $highlight-code, $min-top) {
 # when there is no highlighting, the code needs escaping
 my Pod::To::HTML2 $pr .= new(:$min-top,:$highlight-code);
 process(@fn, $report, $pr, 'html')
}

sub MarkDown(@fn, $report, $github-badge, $badge-path) {
 my Pod::To::MarkDown $pr .= new(:$github-badge,:$badge-path);
 process(@fn, $report, $pr, 'md')
}

sub process(@fn, $report, $pr, $ext) {
 for @fn -> $fn {
 $pr.pod-file.path = $pr.pod-file.name = $pr.pod-file.title = $fn<oname>;
 my $pod = load($fn<path> ~ '/' ~ $fn<name>);
 $pr.render-tree($pod);
 $pr.file-wrap;
 $pr.emit-and-renew-processed-state;
 $report.text ~= "｢{ $fn<path> }/{ $fn<name> }｣"
 ~ " converted and written to ｢{ $fn<oname> }.$ext｣\n";
 CATCH {
 default {
 my $msg = .message;
 $msg = $msg.substr(0, 150) ~ "\n{ '... (' ~ $msg.chars - 150 ~ ' more chars)' if $msg.chars > 150 }";
 $report.text ~= "｢{ $fn<path> }/{ $fn<name> }｣"
 ~ " to .$ext "
 ~ ' encountered error: '
 ~ .message ~ "\n";
 .continue;
 }
 }
 }
}

PodExtraction

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

image i_github_com_finanalyst_raku_pod_extraction_actions_workflows_test_yaml_badge_svg not found

Extractor GUI

Table of Contents

Dependencies

raku-pod-extraction v0.2.4

Authors

License

Dependencies

Test Dependencies

Provides

Documentation