1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
49 package RT::Shredder::POD;
58 my ($file, $out_fh) = @_;
59 my $parser = RT::Shredder::POD::HTML->new;
60 $parser->select('ARGUMENTS', 'USAGE');
61 $parser->parse_from_file( $file, $out_fh );
67 my ($file, $out_fh, $no_name) = @_;
68 local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
69 my $parser = Pod::PlainText->new();
70 $parser->select('SYNOPSIS', 'ARGUMENTS', 'USAGE');
71 $parser->add_selection('NAME') unless $no_name;
72 $parser->parse_from_file( $file, $out_fh );
78 my ($file, $out_fh) = @_;
79 local @Pod::PlainText::ISA = ('Pod::Select', @Pod::PlainText::ISA);
80 my $parser = Pod::PlainText->new();
81 $parser->select('NAME', 'SYNOPSIS', 'USAGE', 'OPTIONS');
82 $parser->parse_from_file( $file, $out_fh );
86 package RT::Shredder::POD::HTML;
87 use base qw(Pod::Select);
91 my( $self, $command, $paragraph, $line_num ) = @_;
94 if ($command =~ /^head(\d+)$/) { $tag = "h$1" }
95 my $out_fh = $self->output_handle();
96 my $expansion = $self->interpolate($paragraph, $line_num);
97 $expansion =~ s/^\s+|\s+$//;
99 print $out_fh "<$tag>" if $tag;
100 print $out_fh $expansion;
101 print $out_fh "</$tag>" if $tag;
108 my ($self, $paragraph, $line_num) = @_;
109 my $out_fh = $self->output_handle();
110 print $out_fh "<pre>";
111 print $out_fh $paragraph;
112 print $out_fh "</pre>";
118 my ($self, $paragraph, $line_num) = @_;
119 my $out_fh = $self->output_handle();
120 my $expansion = $self->interpolate($paragraph, $line_num);
121 $expansion =~ s/^\s+|\s+$//;
123 print $out_fh $expansion;
124 print $out_fh "</p>";
129 sub interior_sequence {
130 my ($self, $seq_command, $seq_argument) = @_;
131 ## Expand an interior sequence; sample actions might be:
132 return "<b>$seq_argument</b>" if $seq_command eq 'B';
133 return "<i>$seq_argument</i>" if $seq_command eq 'I';
134 return "<span class=\"pod-sequence-$seq_command\">$seq_argument</span>";