/ 
MetaCPAN-Client-Pod-PDF-0.03
River stage zero No dependents
/ MetaCPAN::Client::Pod::PDF

NAME

MetaCPAN::Client::Pod::PDF - The great new MetaCPAN::Client::Pod::PDF!

VERSION

Version 0.03

SYNOPSIS

use MetaCPAN::Client::Pod::PDF;

my $client = MetaCPAN::Client::Pod::PDF->new();

$client->pdf('Moo');

$client->dist_pdf('Moo');

ATTRIBUTES

header

Configure the header of each page in the PDF.

$pdf->header({
	show_page_num => 'left',
	page_num_text => "page {num}",
	h => 10,
	padding => 5
});

footer

Configure the footer of each page in the PDF.

$pdf->footer({
	show_page_num => 'right',
	page_num_text => "page {num}",
	h => 10,
	padding => 5
});

styles

Configure the styles that are applied to the PDF.

$pdf->styles({
	plugins => [qw/h1 h2 h3 h4 h5 h6/],
	page => {
		padding => 15,
	},
	cover => {
		columns => 1
	},
	toc => {
		levels => [qw/title h1 h2 h3 h4 h5 h6/],
		font => { colour => '#00f' },
	},
	title => {
		margin_bottom => 3,
	},
	h1 => {
		margin_bottom => 3,
		font => {
			size => 26,
			line_height => 26
		}
	},
	h2 => {
		margin_bottom => 3,
		font => {
			size => 24,
			line_height => 24
		}
	},
	h3 => {
		margin_bottom => 3,
		font => {
			size => 22
		}
	},
	h4 => {
		margin_bottom => 3,
		font => {
			size => 20
		}
	},
	h5 => {
		margin_bottom => 3,
		font => {
			size => 18
		}
	},
	h6 => {
		margin_bottom => 3,
		font => {
			size => 16
		}
	},
	text => {
		margin_bottom => 3,
	},
});

SUBROUTINES/METHODS

new

Instantiate a new MetaCPAN::Client::Pod::PDF Object.

my $object = MetaCPAN::Client::Pod::PDF->new;

pdf

Generate a PDF for a individual module.

$pdf->pdf('DBIx::Class');

my $stringify = $pdf->pdf('DBIx::Class', 1);

dist_pdf

Generate a PDF for a distribution.

$pdf->dist_pdf('DBIx::Class');

my $stringify = $pdf->dist_pdf('DBIx::Class', 1);

raw

Generate a PDF from raw pod markup.

my $pod = q|=head1 title

picture yourself on a boat on a river.

|;

$pdf->raw('FileName', $pod);

$pdf->raw('FileName', $pod, 1);

AUTHOR

lnation, <email at lnation.org>

BUGS

Please report any bugs or feature requests to bug-metacpan-client-pod-pdf at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=MetaCPAN-Client-Pod-PDF. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc MetaCPAN::Client::Pod::PDF

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

This software is Copyright (c) 2020 by lnation.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)