File Coverage

blib/lib/Kwiki/PrinterFriendly.pm

Criterion	Covered	Total	%
statement	1	3	33.3
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	2	4	50.0

package Kwiki::PrinterFriendly;
use Kwiki::Plugin -Base;
use Kwiki::Installer '-base';
use strict;
use warnings;

our $VERSION = '0.13';

const class_id => 'printer_friendly';
const class_title => 'Printer Friendly';
const screen_template => 'printer_friendly_screen.html';
const cgi_class => 'Kwiki::PrinterFriendly::CGI';

sub register {
    my $registry = shift;
    $registry->add(action => 'printer_friendly');
    $registry->add(toolbar => 'printer_friendly_button',
                   template => 'printer_friendly_button.html',
		   show_for => ['display', 'revisions']
                  );
}

sub printer_friendly {
  my $page = $self->pages->current;
  my $content = $self->cgi->revision_id
    ? $self->hub->archive->fetch($page, $self->cgi->revision_id)
      : $page->content;
  my $html = $self->hub->formatter->text_to_html($content);
  $self->render_screen(
		       page_html => $html,
		       screen_title => $page->title,
		       site_title => $page->title,
		       page_content => $content,
		       page_time => $page->modified_time,
		      );
}

package Kwiki::PrinterFriendly::CGI;
use base 'Kwiki::CGI';
cgi 'revision_id';
package Kwiki::PrinterFriendly;

=head1 NAME

Kwiki::PrinterFriendly - A Kwiki plugin to format pages for printing

=head1 SYNOPSIS

Provides an printer friendly display of the current page.

=head1 REQUIRES

   Kwiki

=head1 INSTALLATION

   perl Makefile.PL
   make
   make test
   make install

   cd ~/where/your/kwiki/is/located
   echo "Kwiki::PrinterFriendly" >>plugins

   kwiki -update

=head1 UPGRADING

You should always run 'kwiki -update' after upgrading Kwiki::PrinterFriendly

=head1 CONFIGURATION

In config.yaml, following are necessary for proper functioning:

=over

=item toolbar_order

Add the item printer_friendly_button in the position where you
want the printer icon to appear

=item printer_icon

Included in this distribution is a sample icon, printer.png.  To use it, put

   printer_icon: printer.png

in your config.yaml file.  If you have a better one, just put it in
the top of your Kwiki directory.

=back

=head1 ACKNOWLEDGEMENTS

This is a hacked together version of Kwiki::Edit,
Kwiki::RecentChangesRSS, and various bits and pieces from other
modules.  Thanks to James Peregrino and Brian Ingerson for doing
the heavy lifting.

=head1 AUTHOR

Henry Laxen

=head1 COPYRIGHT

Copyright (c) 2004. Henry Laxen. All rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

=cut

__DATA__