Upgrade to 4.2.8
[usit-rt.git] / lib / RT / Shredder / POD.pm
CommitLineData
84fb5b46
MKG
1# BEGIN BPS TAGGED BLOCK {{{
2#
3# COPYRIGHT:
4#
3ffc5f4f 5# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
84fb5b46
MKG
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
49package RT::Shredder::POD;
50
51use strict;
52use warnings;
53use Pod::Select;
54use Pod::PlainText;
55
56sub plugin_html
57{
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 );
3ffc5f4f 62 return;
84fb5b46
MKG
63}
64
65sub plugin_cli
66{
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 );
3ffc5f4f 73 return;
84fb5b46
MKG
74}
75
76sub shredder_cli
77{
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 );
3ffc5f4f 83 return;
84fb5b46
MKG
84}
85
86package RT::Shredder::POD::HTML;
87use base qw(Pod::Select);
88
89sub command
90{
91 my( $self, $command, $paragraph, $line_num ) = @_;
92
93 my $tag;
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+$//;
98
99 print $out_fh "<$tag>" if $tag;
100 print $out_fh $expansion;
101 print $out_fh "</$tag>" if $tag;
102 print $out_fh "\n";
3ffc5f4f 103 return;
84fb5b46
MKG
104}
105
106sub verbatim
107{
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>";
113 print $out_fh "\n";
3ffc5f4f 114 return;
84fb5b46
MKG
115}
116
117sub textblock {
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+$//;
122 print $out_fh "<p>";
123 print $out_fh $expansion;
124 print $out_fh "</p>";
125 print $out_fh "\n";
3ffc5f4f 126 return;
84fb5b46
MKG
127}
128
129sub 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>";
135}
1361;