rt/lib/RT/Shredder/POD.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
   6 #                                          <sales@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 package RT::Shredder::POD;
  50
  51 use strict;
  52 use warnings;
  53 use Pod::Select;
  54
  55 sub plugin_html
  56 {
  57     my ($file, $out_fh) = @_;
  58     my $parser = new RT::Shredder::POD::HTML;
  59     $parser->select('ARGUMENTS', 'USAGE');
  60     $parser->parse_from_file( $file, $out_fh );
  61 }
  62
  63 sub plugin_cli
  64 {
  65     my ($file, $out_fh, $no_name) = @_;
  66     use Pod::PlainText;
  67     local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
  68     my $parser = new Pod::PlainText;
  69     $parser->select('SYNOPSIS', 'ARGUMENTS', 'USAGE');
  70     $parser->add_selection('NAME') unless $no_name;
  71     $parser->parse_from_file( $file, $out_fh );
  72 }
  73
  74 sub shredder_cli
  75 {
  76     my ($file, $out_fh) = @_;
  77     use Pod::PlainText;
  78     local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
  79     my $parser = new Pod::PlainText;
  80     $parser->select('NAME', 'SYNOPSIS', 'USAGE', 'OPTIONS');
  81     $parser->parse_from_file( $file, $out_fh );
  82 }
  83
  84 package RT::Shredder::POD::HTML;
  85 use base qw(Pod::Select);
  86
  87 sub command
  88 {
  89     my( $self, $command, $paragraph, $line_num ) = @_;
  90
  91     my $tag;
  92     if ($command =~ /^head(\d+)$/) { $tag = "h$1" }
  93     my $out_fh = $self->output_handle();
  94     my $expansion = $self->interpolate($paragraph, $line_num);
  95     $expansion =~ s/^\s+|\s+$//;
  96
  97     print $out_fh "<$tag>" if $tag;
  98     print $out_fh $expansion;
  99     print $out_fh "</$tag>" if $tag;
 100     print $out_fh "\n";
 101 }
 102
 103 sub verbatim
 104 {
 105     my ($self, $paragraph, $line_num) = @_;
 106     my $out_fh = $self->output_handle();
 107     print $out_fh "<pre>";
 108     print $out_fh $paragraph;
 109     print $out_fh "</pre>";
 110     print $out_fh "\n";
 111 }
 112
 113 sub textblock {
 114     my ($self, $paragraph, $line_num) = @_;
 115     my $out_fh = $self->output_handle();
 116     my $expansion = $self->interpolate($paragraph, $line_num);
 117     $expansion =~ s/^\s+|\s+$//;
 118     print $out_fh "<p>";
 119     print $out_fh $expansion;
 120     print $out_fh "</p>";
 121     print $out_fh "\n";
 122 }
 123
 124 sub interior_sequence {
 125     my ($self, $seq_command, $seq_argument) = @_;
 126     ## Expand an interior sequence; sample actions might be:
 127     return "<b>$seq_argument</b>" if $seq_command eq 'B';
 128     return "<i>$seq_argument</i>" if $seq_command eq 'I';
 129     return "<span class=\"pod-sequence-$seq_command\">$seq_argument</span>";
 130 }
 131 1;