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.

diaCoords => sub { # convert $x, $y to Diagram coordinates }

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 SGF 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("$x$y"); }, # concatenate two letters

print => sub { my ($dg2tex, @tex) = @_; ... }

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:

topMargin => points

bottomMargin => points

leftMargin => points

rightMargin => points

Margins are set in PDF '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):

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

$dg2pdf->configure (option => value, ?...?)

Change Dg2PDF options from values passed at new time.

$dg2pdf->print ($text ? , ... ?)

prints raw PDF code to file as defined at new time. Whether or not file was defined, print accumulates the PDF code for later retrieval with converted.

$dg2pdf->printComment ($text ? , ... ?)

Adds $text to the diagram comments.

$dg2pdf->comment ($comment ? , ... ?)

Inserts the PDF 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.

my $canvas = $dg2pdf->convertDiagram ($diagram)

Converts a Games::Go::Diagram into PDF.

my $converted_text = $dg2pdf->convertText ($text)

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.

$title = $dg2pdf->convertProperties (\%sgfHash)

convertProperties takes a reference to a hash of properties as extracted from an SGF file. Each hash key is a property ID and the hash value is a reference to an array of property values: $hash->{propertyId}->[values]. The following SGF properties are recognized:

$dg2pdf->close

prints some final PDF code to the diagram and closes the pdf object (file).