| 1 |
#! /usr/bin/env perl |
| 2 |
|
| 3 |
my $template = "$ARGV[0]_XXXX"; |
| 4 |
|
| 5 |
use 5.010; |
| 6 |
use warnings; |
| 7 |
|
| 8 |
my $source = do { local $/; readline *ARGV }; |
| 9 |
|
| 10 |
our @N = [0]; |
| 11 |
|
| 12 |
$source =~ s{ |
| 13 |
^ \h* ECCE \h+ |
| 14 |
(?: EXPLICO \b (?<pod> (?&content) ) |
| 15 |
| PROSUM \b (?<for> (?&content) ) |
| 16 |
| INCIPIO \b (?<begin> (?&content) ) |
| 17 |
| FINIO \b (?<end> (?&content) ) |
| 18 |
| INTITULO \h+ PRIMUM \b (?<head1> (?&content) ) |
| 19 |
| INTITULO \h+ SECUNDUM \b (?<head2> (?&content) ) |
| 20 |
| INTITULO \h+ TERTIUM \b (?<head3> (?&content) ) |
| 21 |
| INTITULO \h+ QUARTUM \b (?<head4> (?&content) ) |
| 22 |
| INTITULO \h+ QUINTUM \b (?<head5> (?&content) ) |
| 23 |
| INTITULO \h+ SEXTUM \b (?<head6> (?&content) ) |
| 24 |
| AD \h+ DEXTRAM \b (?<over> (?&content) ) |
| 25 |
| AD \h+ SINISTRAM \b (?<back> (?&content) ) |
| 26 |
| FACIO \h+ PUNCTUM \b (?<bullet> (?&content) ) |
| 27 |
| NUMERO \h+ PUNCTUM \b (?<number> (?&content) ) |
| 28 |
| DEFINIO \b (?<defn> (?&content) ) |
| 29 |
| SECO \b (?<cut> (?&content) ) |
| 30 |
) |
| 31 |
|
| 32 |
(?(DEFINE) |
| 33 |
(?<content> .*? (?: ^ \h* (?:\n|\Z) | \Z | (?= ^ \h* ecce \h+)) ) |
| 34 |
) |
| 35 |
}{ |
| 36 |
my ($block) = keys %+; |
| 37 |
|
| 38 |
if ($block eq 'over' ) { push @N, 0 } |
| 39 |
elsif ($block eq 'back' ) { pop @N } |
| 40 |
|
| 41 |
if ($block eq 'defn') { "\n=item $+{$block}\n" } |
| 42 |
elsif ($block eq 'bullet') { "\n=item * $+{$block}\n" } |
| 43 |
elsif ($block eq 'number') { $N[-1]++; "\n=item $N[-1]. $+{$block}\n" } |
| 44 |
else { "\n=$block $+{$block}\n" } |
| 45 |
}gexmsi; |
| 46 |
|
| 47 |
use File::Temp 'tempfile'; |
| 48 |
|
| 49 |
my ($fh, $filename) = tempfile($template, UNLINK => 1); |
| 50 |
|
| 51 |
print {$fh} $source; |
| 52 |
|
| 53 |
system "perldoc $filename"; |
| 54 |
|
| 55 |
|
| 56 |
__END__ |
| 57 |
|
| 58 |
=head1 NAME |
| 59 |
|
| 60 |
explica - Translate Perligata's ERL documentation format to POD and then format it with Perldoc |
| 61 |
|
| 62 |
=head1 VERSION |
| 63 |
|
| 64 |
This documentation refers to explica version 0.0.1 |
| 65 |
|
| 66 |
=head1 USAGE |
| 67 |
|
| 68 |
explica <FILENAME> |
| 69 |
|
| 70 |
=head1 REQUIRED ARGUMENTS |
| 71 |
|
| 72 |
=over |
| 73 |
|
| 74 |
=item <FILENAME> |
| 75 |
|
| 76 |
The name or filepath of a Perligata file |
| 77 |
|
| 78 |
=back |
| 79 |
|
| 80 |
=head1 OPTIONS |
| 81 |
|
| 82 |
=over |
| 83 |
|
| 84 |
None |
| 85 |
|
| 86 |
=back |
| 87 |
|
| 88 |
=head1 DIAGNOSTICS |
| 89 |
|
| 90 |
None. |
| 91 |
|
| 92 |
=head1 CONFIGURATION AND ENVIRONMENT |
| 93 |
|
| 94 |
Requires no configuration files or environment variables. |
| 95 |
|
| 96 |
|
| 97 |
=head1 DEPENDENCIES |
| 98 |
|
| 99 |
None. |
| 100 |
|
| 101 |
|
| 102 |
=head1 BUGS |
| 103 |
|
| 104 |
None reported. |
| 105 |
Bug reports and other feedback are most welcome. |
| 106 |
|
| 107 |
|
| 108 |
=head1 AUTHOR |
| 109 |
|
| 110 |
Damian Conway C<< <[email protected]> >> |
| 111 |
|
| 112 |
|
| 113 |
=head1 COPYRIGHT |
| 114 |
|
| 115 |
Copyright (c) 2022, Damian Conway. All rights reserved. |
| 116 |
|
| 117 |
This module is free software. It may be used, redistributed |
| 118 |
and/or modified under the terms of the Perl Artistic License |
| 119 |
(see http://www.perl.com/perl/misc/Artistic.html) |
| 120 |
|
| 121 |
|
| 122 |
=head1 DISCLAIMER OF WARRANTY |
| 123 |
|
| 124 |
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY |
| 125 |
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN |
| 126 |
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES |
| 127 |
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER |
| 128 |
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| 129 |
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. |
| 130 |
ALL SUCH WARRANTIES ARE EXPLICITLY DISCLAIMED. THE ENTIRE RISK AS TO THE |
| 131 |
QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE |
| 132 |
PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, |
| 133 |
OR CORRECTION. |
| 134 |
|
| 135 |
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
| 136 |
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR |
| 137 |
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE |
| 138 |
FOR DAMAGES, INCLUDING ANY DIRECT, INDIRECT, GENERAL, SPECIAL, INCIDENTAL, |
| 139 |
EXEMPLARY, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF |
| 140 |
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| 141 |
NEGLIGENCE OR OTHERWISE) ARISING OUT OF THE USE OR INABILITY TO USE THE |
| 142 |
SOFTWARE (INCLUDING BUT NOT LIMITED TO PROCUREMENT OF SUBSTITUTE GOODS |
| 143 |
OR SERVICES, LOSS OF DATA OR DATA BEING RENDERED INACCURATE, OR LOSSES |
| 144 |
SUSTAINED BY YOU OR THIRD PARTIES, OR A FAILURE OF THE SOFTWARE TO |
| 145 |
OPERATE WITH ANY OTHER SOFTWARE) EVEN IF SUCH HOLDER OR OTHER PARTY HAS |
| 146 |
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. |
| 147 |
|