lib/RT/Pod/HTML.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2013 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 use strict;
  50 use warnings;
  51
  52 package RT::Pod::HTML;
  53 use base 'Pod::Simple::XHTML';
  54
  55 sub new {
  56     my $self = shift->SUPER::new(@_);
  57     $self->index(1);
  58     $self->anchor_items(1);
  59     return $self;
  60 }
  61
  62 sub perldoc_url_prefix { "http://metacpan.org/module/" }
  63
  64 sub html_header { '' }
  65 sub html_footer {
  66     my $self = shift;
  67     my $toc  = "../" x ($self->batch_mode_current_level - 1);
  68     return '<a href="./' . $toc . '">&larr; Back to index</a>';
  69 }
  70
  71 sub start_Verbatim { $_[0]{'scratch'} = "<pre>" }
  72 sub end_Verbatim   { $_[0]{'scratch'} .= "</pre>"; $_[0]->emit; }
  73
  74 sub _end_head {
  75     my $self = shift;
  76     $self->{scratch} = '<a href="#___top">' . $self->{scratch} . '</a>';
  77     return $self->SUPER::_end_head(@_);
  78 }
  79
  80 sub resolve_pod_page_link {
  81     my $self = shift;
  82     my ($name, $section) = @_;
  83
  84     # Only try to resolve local links if we're in batch mode and are linking
  85     # outside the current document.
  86     return $self->SUPER::resolve_pod_page_link(@_)
  87         unless $self->batch_mode and $name;
  88
  89     $section = defined $section
  90         ? '#' . $self->idify($section, 1)
  91         : '';
  92
  93     my $local;
  94     if ($name =~ /^RT::/) {
  95         $local = join "/",
  96                   map { $self->encode_entities($_) }
  97                 split /::/, $name;
  98     }
  99     elsif ($name =~ /^rt-/) {
 100         $local = $self->encode_entities($name);
 101     }
 102
 103     if ($local) {
 104         # Resolve links correctly by going up
 105         my $depth = $self->batch_mode_current_level - 1;
 106         return join "/",
 107                     ($depth ? ".." x $depth : ()),
 108                     "$local.html$section";
 109     } else {
 110         return $self->SUPER::resolve_pod_page_link(@_)
 111     }
 112 }
 113
 114 1;