SYNOPSIS

use Games::Go::Dg2PDF

 my $dg2pdf = B<Games::Go::Dg2PDF-E<gt>new> (options);
 $dg2pdf->convertDiagram($diagram);

DESCRIPTION

A Games::Go::Dg2PDF object converts a Games::Go::Diagram object into a \s-1PDF\s0 file.

METHODS

A new Games::Go::Dg2PDF takes the following options:

General Dg2 Converter Options:

boardSize => number

Sets the size of the board. Default: 19

doubleDigits => true | false

Numbers on stones are wrapped back to 1 after they reach 100. Numbers associated with comments and diagram titles are not affected. Default: false

coords => true | false

Generates a coordinate grid. Default: false

topLine => number (Default: 1)
bottomLine => number (Default: 19)
leftLine => number (Default: 1)
rightLine => number (Default: 19)

The edges of the board that should be displayed. Any portion of the board that extends beyond these numbers is not included in the output. This callback defines a subroutine to convert coordinates from $x, $y to whatever coordinates are used in the Games::Go::Diagram object. The default diaCoords converts 1-based $x, $y to the same coordinates used in \s-1SGF\s0 format files. You only need to define this if you're using a different coordinate system in the Diagram. Default:

    sub { my ($x, $y) = @_;
          $x = chr($x - 1 + ord('a')); # convert 1 to 'a', etc
          $y = chr($y - 1 + ord('a'));
          return(\*(L"$x$y\*(R"); },           # concatenate two letters

A user defined subroutine to replace the default printing method. This callback is called from the print method (below) with the reference to the Dg2TeX object and a list of lines that are part of the TeX diagram source.

Dg2PDF-specific options:

pageSize => 'page size'

May be one of:

a0 - a6
letter
broadsheet
ledger
tabloid
legal
executive
36x36

Default: 'letter'

topMargin => points
bottomMargin => points
leftMargin => points
rightMargin => points

Margins are set in \s-1PDF\s0 'user space units' which are approximately equivilent to points (1/72 of an inch). Default for all margins: 72 * .70 (7/10s of an inch)

text_fontName => 'font' Default: 'Times-Roman',
stone_fontName => 'font' Default: 'Courier-Bold'

Text and stone fonts names may be one of these (case sensitive):

Courier
Courier-Bold
Courier-BoldOblique
Courier-Oblique
Helvetica
Helvetica-Bold
Helvetica-BoldOblique
Helvetica-Oblique
Times-Roman
Times-Bold
Times-Italic
Times-BoldItalic
text_fontSize => points

The point size for the comment text. Diagram titles use this size plus 4, and the game title uses this size plus 6. Default: 11

stone_fontSize => points

The stone_fontSize determines the size of the text inside stones, and may also determine the size of the stones and diagrams (see stone_height and stone_width below). Default: 5

stone_width => points
stone_height => points

The stone_width and stone_height determine the size of the stones and diagrams. If stone_width is not explicitly set, it is calculated from the stone_fontSize to allow up to three digits on a stone . The default stone_fontSize allows for three diagrams (with -coords) per 'letter' page if comments don't take up extra space below diagrams. If doubleDigits is specified, the stones and board are slightly smaller (stone 100 may look a bit cramped). If stone_height is not explicitly set, it will be 1.05 * stone_width, creating a slightly rectangular diagram. Default: undef - determined from stone_fontSize Change Dg2PDF options from values passed at new time. prints raw \s-1PDF\s0 code to file as defined at new time. Whether or not file was defined, print accumulates the \s-1PDF\s0 code for later retrieval with converted. Adds $text to the diagram comments. Inserts the \s-1PDF\s0 comment character ('%') in front of each line of each comment and prints it to file. Note that this is not the same as the printComment method. Converts a Games::Go::Diagram into \s-1PDF\s0. Converts $text into text for display - gee, that's not very hard. In fact, this method simply returns whatever is passed to it. This is really just a place-holder for more complicated converters. Returns the converted text. convertProperties takes a reference to a hash of properties as extracted from an \s-1SGF\s0 file. Each hash key is a property \s-1ID\s0 and the hash value is a reference to an array of property values: $hash->{propertyId}->[values]. The following \s-1SGF\s0 properties are recognized:

\s-1GN\s0 GameName
\s-1EV\s0 EVent
\s-1RO\s0 ROund
\s-1PW\s0 PlayerWhite
\s-1WR\s0 WhiteRank
\s-1PB\s0 PlayerBlack
\s-1BR\s0 BlackRank
\s-1DT\s0 DaTe
\s-1PC\s0 PlaCe
\s-1GC\s0 GameComment
\s-1KM\s0 KoMi
\s-1RE\s0 REsult
\s-1TM\s0 TiMe

Both long and short property names are recognized, and all unrecognized properties are ignored with no warnings. Note that these properties are all intended as game-level notations.

prints some final \s-1PDF\s0 code to the diagram and closes the pdf object (file).

RELATED TO Games::Go::Dg2PDF…

sgf2dg(1)

Script to convert \s-1SGF\s0 format files to Go diagrams

BUGS

You think I'd admit it?

AUTHOR

Reid Augustin, <[email protected]>

COPYRIGHT AND LICENSE

Copyright (C) 2005 by Reid Augustin

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.5 or, at your option, any later version of Perl 5 you may have available.