Philip Crow > UML-Sequence-0.08 > UML::Sequence::Svg

Download:
UML-Sequence-0.08.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Module Version: 0.02   Source  

NAME ^

UML::Sequence::Svg - converts xml sequence files to svg

SYNOPSIS ^

    use UML::Sequence::Svg;

    seq2svg @ARGV;

DESCRIPTION ^

This module supports the seq2svg.pl script like Pod::Html supports pod2html. The array passed to seq2svg.pl should have the following form:

 ([ I<options-pairs>, ] [input_file_name])

where options-pairs are any of

-a color

specifies a color to be used to fill the activation boxes. Must be in a form acceptable to SVG.

-c color

specifies a color to be used to fill the class boxes. Must be in a form acceptable to SVG.

-e

specifies that embedded annotations are to be applied to any rasterized version of the SVG image. Only valid when the -m or -M option is also specified. When an arrow label has associated annotations, the labels with be suffixed with a superscript number linking to a text section containing the annotation text.

-g arrow-gap

If arrow-gap is an integer value, specifies number of pixels between arrows (default is 40 pixels). If arrow-gap is a fractional value, specifies a scaling factor for the default number of pixels between arrows.

-j

specifies that Javascript'ed tooltip annotations are to be applied to any rasterized version of the SVG image. Only valid when the -m or -M option is also specified. When an arrow label has associated annotations, the hyperlinks in the areamap for the label will include onmouseover() function calls containing the annotation text for use with the Javascript tooltip package available at http://www.walterzorn.com/tooltip/tooltip_e.htm.

-m areamap-path, -M areamap-path

specifies the name of a file to receive HTML containing an image element, areamap, and (optionally) either an ordered list of annotations (if -e was specified) or a script tag linking to the Javascript tooltip script (if -j was specified). to be applied to any rasterized version of the SVG image. Only valid when either the -p or -P option is specified. -M specifies append mode for the output file.

-o output_file_name

specifies the output file name.

-p classdocs-path, -P classdocs-path

specifies a base path to classdocs generated by psichedoc. -p causes hyperlinks to the documents for individual classes and/or methods to be embedded in the SVG file for both the class labels and method labels, excluding method labels w/ embedded whitespace. Additionally, the specified path is used with any generated HTML imagemap. -P is the same, except it does not embed hyperlinks in the SVG (due to Batik's current inability to handle rasterization of SVG's with embeded hyperlinks). In other words, use -P to specify a path for HTML imagemaps when the SVG output will be further processed by Batik.

-w box-width

specifies width of class box in pixels; default is 125. Used to compute class header boxes and areamap coordinates.

-x char-width

specifies width of characters in pixels; default is 6. Used to compute class header boxes and areamap coordinates.

-y char-height

specifies height of characters in pixels; default is 14. Used to compute class header boxes and areamap coordinates.

By default input is from standard in and output is to standard out.

SEE ALSO ^

UML::Sequence::Raster

AUTHOR ^

Phil Crow, <philcrow2000@yahoo.com>

Version 0.02 Updates by Dean Arnold, <darnold@presicient.com>

COPYRIGHT ^

Copyright 2003-2006, Philip Crow, all rights reserved. You may modify and/or redistribute this code in the same manner as Perl itself.

syntax highlighting: