summaryrefslogtreecommitdiff
path: root/rt/lib/RT/Shredder/POD.pm
diff options
context:
space:
mode:
Diffstat (limited to 'rt/lib/RT/Shredder/POD.pm')
-rw-r--r--rt/lib/RT/Shredder/POD.pm131
1 files changed, 131 insertions, 0 deletions
diff --git a/rt/lib/RT/Shredder/POD.pm b/rt/lib/RT/Shredder/POD.pm
new file mode 100644
index 0000000..a3538b3
--- /dev/null
+++ b/rt/lib/RT/Shredder/POD.pm
@@ -0,0 +1,131 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
+# <jesse@bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
+# This work is made available to you under the terms of Version 2 of
+# the GNU General Public License. A copy of that license should have
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org.
+#
+# This work is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
+
+package RT::Shredder::POD;
+
+use strict;
+use warnings;
+use Pod::Select;
+
+sub plugin_html
+{
+ my ($file, $out_fh) = @_;
+ my $parser = new RT::Shredder::POD::HTML;
+ $parser->select('ARGUMENTS', 'USAGE');
+ $parser->parse_from_file( $file, $out_fh );
+}
+
+sub plugin_cli
+{
+ my ($file, $out_fh, $no_name) = @_;
+ use Pod::PlainText;
+ local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
+ my $parser = new Pod::PlainText;
+ $parser->select('SYNOPSIS', 'ARGUMENTS', 'USAGE');
+ $parser->add_selection('NAME') unless $no_name;
+ $parser->parse_from_file( $file, $out_fh );
+}
+
+sub shredder_cli
+{
+ my ($file, $out_fh) = @_;
+ use Pod::PlainText;
+ local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
+ my $parser = new Pod::PlainText;
+ $parser->select('NAME', 'SYNOPSIS', 'USAGE', 'OPTIONS');
+ $parser->parse_from_file( $file, $out_fh );
+}
+
+package RT::Shredder::POD::HTML;
+use base qw(Pod::Select);
+
+sub command
+{
+ my( $self, $command, $paragraph, $line_num ) = @_;
+
+ my $tag;
+ if ($command =~ /^head(\d+)$/) { $tag = "h$1" }
+ my $out_fh = $self->output_handle();
+ my $expansion = $self->interpolate($paragraph, $line_num);
+ $expansion =~ s/^\s+|\s+$//;
+
+ print $out_fh "<$tag>" if $tag;
+ print $out_fh $expansion;
+ print $out_fh "</$tag>" if $tag;
+ print $out_fh "\n";
+}
+
+sub verbatim
+{
+ my ($self, $paragraph, $line_num) = @_;
+ my $out_fh = $self->output_handle();
+ print $out_fh "<pre>";
+ print $out_fh $paragraph;
+ print $out_fh "</pre>";
+ print $out_fh "\n";
+}
+
+sub textblock {
+ my ($self, $paragraph, $line_num) = @_;
+ my $out_fh = $self->output_handle();
+ my $expansion = $self->interpolate($paragraph, $line_num);
+ $expansion =~ s/^\s+|\s+$//;
+ print $out_fh "<p>";
+ print $out_fh $expansion;
+ print $out_fh "</p>";
+ print $out_fh "\n";
+}
+
+sub interior_sequence {
+ my ($self, $seq_command, $seq_argument) = @_;
+ ## Expand an interior sequence; sample actions might be:
+ return "<b>$seq_argument</b>" if $seq_command eq 'B';
+ return "<i>$seq_argument</i>" if $seq_command eq 'I';
+ return "<span class=\"pod-sequence-$seq_command\">$seq_argument</span>";
+}
+1;