Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / SVG::Manual.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SVG::Manual 3"
.TH SVG::Manual 3 "2003-11-02" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
SVG \- Perl extension for generating Scalable Vector Graphics (SVG) documents
.Sh "VERSION"
.IX Subsection "VERSION"
Version 2.24 (29.01.03)
Covers SVG\-2.27 distribution
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    #!/usr/bin/perl -w
\&    use strict;
\&    use SVG;
.Ve
.PP
.Vb 2
\&    # create an SVG object
\&    my $svg= SVG->new(width=>200,height=>200);
.Ve
.PP
.Vb 5
\&    # use explicit element constructor to generate a group element
\&    my $y=$svg->group(
\&        id    => 'group_y',
\&        style => { stroke=>'red', fill=>'green' }
\&    );
.Ve
.PP
.Vb 2
\&    # add a circle to the group
\&    $y->circle(cx=>100, cy=>100, r=>50, id=>'circle_in_group_y');
.Ve
.PP
.Vb 8
\&    # or, use the generic 'tag' method to generate a group element by name
\&    my $z=$svg->tag('g',
\&                    id    => 'group_z',
\&                    style => {
\&                        stroke => 'rgb(100,200,50)',
\&                        fill   => 'rgb(10,100,150)'
\&                    }
\&                );
.Ve
.PP
.Vb 2
\&    # create and add a circle using the generic 'tag' method
\&    $z->tag('circle', cx=>50, cy=>50, r=>100, id=>'circle_in_group_z');
.Ve
.PP
.Vb 11
\&    # create an anchor on a rectangle within a group within the group z
\&    my $k = $z->anchor(
\&        id      => 'anchor_k',
\&        -href   => 'http://test.hackmare.com/',
\&        -target => 'new_window_0'
\&    )->rectangle(
\&        x     => 20, y      => 50,
\&        width => 20, height => 30,
\&        rx    => 10, ry     => 5,
\&        id    => 'rect_k_in_anchor_k_in_group_z'
\&    );
.Ve
.PP
.Vb 2
\&    # now render the SVG object, implicitly use svg namespace
\&    print $svg->xmlify;
.Ve
.PP
.Vb 3
\&    # or render a child node of the SVG object without rendering the entire object
\&    print $k->xmlify; #renders the anchor $k above containing a rectangle, but does not
\&                      #render any of the ancestor nodes of $k
.Ve
.PP
.Vb 2
\&    # or, explicitly use svg namespace and generate a document with its own DTD
\&    print $svg->xmlify(-namespace=>'svg');
.Ve
.PP
.Vb 6
\&    # or, explicitly use svg namespace and generate an in-line docunent
\&    print $svg->xmlify(
\&        -namespace => "svg",
\&        -pubid => "-//W3C//DTD SVG 1.0//EN",
\&        -inline   => 1
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1SVG\s0 is a 100% Perl module which generates a nested data structure containing the
\&\s-1DOM\s0 representation of an \s-1SVG\s0 (Scalable Vector Graphics) image. Using \s-1SVG\s0, you
can generate \s-1SVG\s0 objects, embed other \s-1SVG\s0 instances into it, access the \s-1DOM\s0
object, create and access javascript, and generate \s-1SMIL\s0 animation content.
.Sh "General Steps to generating an \s-1SVG\s0 document"
.IX Subsection "General Steps to generating an SVG document"
Generating \s-1SVG\s0 is a simple three step process:
.ie n .IP "1 The first step is to construct a new \s-1SVG\s0 object with ""new""." 4
.el .IP "1 The first step is to construct a new \s-1SVG\s0 object with ``new''." 4
.IX Item "1 The first step is to construct a new SVG object with new."
.PD 0
.ie n .IP "2 The second step is to call element constructors to create \s-1SVG\s0 elements. Examples of element constructors are ""circle"" and ""path""." 4
.el .IP "2 The second step is to call element constructors to create \s-1SVG\s0 elements. Examples of element constructors are ``circle'' and ``path''." 4
.IX Item "2 The second step is to call element constructors to create SVG elements. Examples of element constructors are circle and path."
.ie n .IP "3 The third and last step is to render the \s-1SVG\s0 object into \s-1XML\s0 using the ""xmlify"" method." 4
.el .IP "3 The third and last step is to render the \s-1SVG\s0 object into \s-1XML\s0 using the ``xmlify'' method." 4
.IX Item "3 The third and last step is to render the SVG object into XML using the xmlify method."
.PD
.PP
The \*(L"xmlify\*(R" method takes a number of optional arguments that control how \s-1SVG\s0
renders the object into \s-1XML\s0, and in particular determine whether a stand-alone
\&\s-1SVG\s0 document or an inline \s-1SVG\s0 document fragment is generated:
.IP "\-stand\-alone" 4
.IX Item "-stand-alone"
A complete \s-1SVG\s0 document with its own associated \s-1DTD\s0. A namespace for the \s-1SVG\s0
elements may be optionally specified.
.IP "\-in\-line" 4
.IX Item "-in-line"
An in-line \s-1SVG\s0 document fragment with no \s-1DTD\s0 that be embedded within other \s-1XML\s0
content. As with stand-alone documents, an alternate namespace may be specified.
.PP
No \s-1XML\s0 content is generated until the third step is reached. Up until this
point, all constructed element definitions reside in a DOM-like data structure
from which they can be accessed and modified.
.Sh "\s-1EXPORTS\s0"
.IX Subsection "EXPORTS"
None. However, \s-1SVG\s0 permits both options and additional element methods to be
specified in the import list. These options and elements are then available
for all \s-1SVG\s0 instances that are created with the \*(L"new\*(R" constructor. For example,
to change the indent string to two spaces per level:
.PP
.Vb 1
\&    use SVG qw(-indent => "  ");
.Ve
.PP
With the exception of \-auto, all options may also be specified to the \*(L"new\*(R"
constructor. The currently supported options are:
.PP
.Vb 6
\&    -auto        enable autoloading of all unrecognised method calls (0)
\&    -indent      the indent to use when rendering the SVG into XML ("\et")
\&    -inline      whether the SVG is to be standalone or inlined (0)
\&    -printerror  print SVG generation errors to standard error (1)
\&    -raiseerror  die if a generation error is encountered (1)
\&    -nostub      only return the handle to a blank SVG document without any elements
.Ve
.PP
\&\s-1SVG\s0 also allows additional element generation methods to be specified in the
import list. For example to generate 'star' and 'planet' element methods:
.PP
.Vb 1
\&    use SVG qw(star planet);
.Ve
.PP
or:
.PP
.Vb 1
\&    use SVG ("star","planet");
.Ve
.PP
This will add 'star' to the list of elements supported by \s-1SVG\s0.pm (but not of
course other \s-1SVG\s0 parsers...). Alternatively the '\-auto' option will allow
any unknown method call to generate an element of the same name:
.PP
.Vb 1
\&    use SVG (-auto => 1, "star", "planet");
.Ve
.PP
Any elements specified explicitly (as 'star' and 'planet' are here) are
predeclared; other elements are defined as and when they are seen by Perl. Note
that enabling '\-auto' effectively disables compile-time syntax checking for
valid method names.
.PP
\&\fBExample:\fR
.PP
.Vb 7
\&    use SVG (
\&        -auto       => 0,
\&        -indent     => "  ",
\&        -raiserror  => 0,
\&        -printerror => 1,
\&        "star", "planet", "moon"
\&    );
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 3
\&    perl(1), L<SVG::XML>, L<SVG::Element>, L<SVG::DOM>, L<SVG::Parser>
\&    http://roasp.com/
\&    http://www.w3c.org/Graphics/SVG/
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Ronan Oger, \s-1RO\s0 \s-1IT\s0 Systemms GmbH, ronan@roasp.com
.SH "CREDITS"
.IX Header "CREDITS"
Peter Wainwright, peter@roasp.com Excellent ideas, beta\-testing, SVG::Parser
Fredo, http://www.penguin.at0.net/~fredo/ \- provided initial feedback
for early \s-1SVG\s0.pm versions
Adam Schneider, improvements to xmlescp providing improved character support