[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / SVG.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 3"
.TH SVG 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.26, 12.01.03
.PP
Refer to SVG::Manual for the complete manual
.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.
.PP
Refer to SVG::Manual for the complete manual.
.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
.SH "EXAMPLES"
.IX Header "EXAMPLES"
http://www.roasp.com/index.shtml?svg.pod
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1),\s-1SVG\s0,\s-1SVG::DOM\s0,\s-1SVG::XML\s0,SVG::Element,SVG::Parser, SVG::Manual
http://www.roasp.com/
http://www.perlsvg.com/
http://www.roitsystems.com/
http://www.w3c.org/Graphics/SVG/
.SH "Methods"
.IX Header "Methods"
\&\s-1SVG\s0 provides both explicit and generic element constructor methods. Explicit
generators are generally (with a few exceptions) named for the element they
generate. If a tag method is required for a tag containing hyphens, the method 
name replaces the hyphen with an underscore. ie: to generate tag <column\-heading id=\*(L"new\*(R">
you would use method \f(CW$svg\fR\->column_heading(id=>'new').
.PP
All element constructors take a hash of element attributes and options;
element attributes such as 'id' or 'border' are passed by name, while options for the
method (such as the type of an element that supports multiple alternate forms)
are passed preceded by a hyphen, e.g '\-type'. Both types may be freely
intermixed; see the \*(L"fe\*(R" method and code examples througout the documentation
for more examples.
.Sh "new (constructor)"
.IX Subsection "new (constructor)"
$svg = \s-1SVG\-\s0>new(%attributes)
.PP
Creates a new \s-1SVG\s0 object. Attributes of the document \s-1SVG\s0 element be passed as
an optional list of key value pairs. Additionally, \s-1SVG\s0 options (prefixed with
a hyphen) may be set on a per object basis:
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $svg1=new SVG;
.Ve
.PP
.Vb 1
\&    my $svg2=new SVG(id => 'document_element');
.Ve
.PP
.Vb 14
\&    my $svg3=new SVG(
\&        -printerror => 1,
\&        -raiseerror => 0,
\&        -indent     => '  ',
\&    -elsep      =>"\en",  # element line (vertical) separator
\&        -docroot => 'svg', #default document root element (SVG specification assumes svg). Defaults to 'svg' if undefined
\&        -sysid      => 'abc', #optional system identifyer 
\&        -pubid      => "-//W3C//DTD SVG 1.0//EN", #public identifyer default value is "-//W3C//DTD SVG 1.0//EN" if undefined
\&        -namespace => 'mysvg',
\&        -inline   => 1
\&        id          => 'document_element',
\&        width       => 300,
\&        height      => 200,
\&    );
.Ve
.PP
Default \s-1SVG\s0 options may also be set in the import list. See \*(L"\s-1EXPORTS\s0\*(R" above
for more on the available options. 
.PP
Furthermore, the following options:
.PP
.Vb 7
\&    -version
\&    -encoding
\&    -standalone
\&    -namespace
\&    -inline
\&    -pubid (formerly -identifier)
\&    -sysid (standalone)
.Ve
.PP
may also be set in xmlify, overriding any corresponding values set in the \s-1SVG\-\s0>new declaration
.Sh "xmlify (alias: to_xml render)"
.IX Subsection "xmlify (alias: to_xml render)"
$string = \f(CW$svg\fR\->xmlify(%attributes);
.PP
Returns xml representation of svg document.
.PP
\&\fB\s-1XML\s0 Declaration\fR
.PP
.Vb 10
\&    Name               Default Value
\&    -version           '1.0'               
\&    -encoding          'UTF-8'
\&    -standalone        'yes'
\&    -namespace         'svg' - namespace for elements. 
\&                               Can also be used in any element method to over-ride
\&                               the current namespace
\&    -inline            '0' - If '1', then this is an inline document.
\&    -pubid             '-//W3C//DTD SVG 1.0//EN';
\&    -sysid             'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd'
.Ve
Commit	Line	Data
86530b38 AT	1	.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sh \" Subsection heading
	6	.br
	7	.if t .Sp
	8	.ne 5
	9	.PP
	10	\fB\\$1\fR
	11	.PP
	12	..
	13	.de Sp \" Vertical space (when we can't use .PP)
	14	.if t .sp .5v
	15	.if n .sp
	16	..
	17	.de Vb \" Begin verbatim text
	18	.ft CW
	19	.nf
	20	.ne \\$1
	21	..
	22	.de Ve \" End verbatim text
	23	.ft R
	24	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "SVG 3"
132	.TH SVG 3 "2003-11-02" "perl v5.8.0" "User Contributed Perl Documentation"
133	.SH "NAME"
134	SVG \- Perl extension for generating Scalable Vector Graphics (SVG) documents
135	.Sh "VERSION"
136	.IX Subsection "VERSION"
137	Version 2.26, 12.01.03
138	.PP
139	Refer to SVG::Manual for the complete manual
140	.SH "DESCRIPTION"
141	.IX Header "DESCRIPTION"
142	\&\s-1SVG\s0 is a 100% Perl module which generates a nested data structure containing the
143	\&\s-1DOM\s0 representation of an \s-1SVG\s0 (Scalable Vector Graphics) image. Using \s-1SVG\s0, you
144	can generate \s-1SVG\s0 objects, embed other \s-1SVG\s0 instances into it, access the \s-1DOM\s0
145	object, create and access javascript, and generate \s-1SMIL\s0 animation content.
146	.PP
147	Refer to SVG::Manual for the complete manual.
148	.SH "AUTHOR"
149	.IX Header "AUTHOR"
150	Ronan Oger, \s-1RO\s0 \s-1IT\s0 Systemms GmbH, ronan@roasp.com
151	.SH "CREDITS"
152	.IX Header "CREDITS"
153	Peter Wainwright, peter@roasp.com Excellent ideas, beta\-testing, SVG::Parser
154	.SH "EXAMPLES"
155	.IX Header "EXAMPLES"
156	http://www.roasp.com/index.shtml?svg.pod
157	.SH "SEE ALSO"
158	.IX Header "SEE ALSO"
159	\&\fIperl\fR\\|(1),\s-1SVG\s0,\s-1SVG::DOM\s0,\s-1SVG::XML\s0,SVG::Element,SVG::Parser, SVG::Manual
160	http://www.roasp.com/
161	http://www.perlsvg.com/
162	http://www.roitsystems.com/
163	http://www.w3c.org/Graphics/SVG/
164	.SH "Methods"
165	.IX Header "Methods"
166	\&\s-1SVG\s0 provides both explicit and generic element constructor methods. Explicit
167	generators are generally (with a few exceptions) named for the element they
168	generate. If a tag method is required for a tag containing hyphens, the method
169	name replaces the hyphen with an underscore. ie: to generate tag <column\-heading id=\(L"new\(R">
170	you would use method \f(CW$svg\fR\->column_heading(id=>'new').
171	.PP
172	All element constructors take a hash of element attributes and options;
173	element attributes such as 'id' or 'border' are passed by name, while options for the
174	method (such as the type of an element that supports multiple alternate forms)
175	are passed preceded by a hyphen, e.g '\-type'. Both types may be freely
176	intermixed; see the \(L"fe\(R" method and code examples througout the documentation
177	for more examples.
178	.Sh "new (constructor)"
179	.IX Subsection "new (constructor)"
180	$svg = \s-1SVG\-\s0>new(%attributes)
181	.PP
182	Creates a new \s-1SVG\s0 object. Attributes of the document \s-1SVG\s0 element be passed as
183	an optional list of key value pairs. Additionally, \s-1SVG\s0 options (prefixed with
184	a hyphen) may be set on a per object basis:
185	.PP
186	\&\fBExample:\fR
187	.PP
188	.Vb 1
189	\& my $svg1=new SVG;
190	.Ve
191	.PP
192	.Vb 1
193	\& my $svg2=new SVG(id => 'document_element');
194	.Ve
195	.PP
196	.Vb 14
197	\& my $svg3=new SVG(
198	\& -printerror => 1,
199	\& -raiseerror => 0,
200	\& -indent => ' ',
201	\& -elsep =>"\en", # element line (vertical) separator
202	\& -docroot => 'svg', #default document root element (SVG specification assumes svg). Defaults to 'svg' if undefined
203	\& -sysid => 'abc', #optional system identifyer
204	\& -pubid => "-//W3C//DTD SVG 1.0//EN", #public identifyer default value is "-//W3C//DTD SVG 1.0//EN" if undefined
205	\& -namespace => 'mysvg',
206	\& -inline => 1
207	\& id => 'document_element',
208	\& width => 300,
209	\& height => 200,
210	\& );
211	.Ve
212	.PP
213	Default \s-1SVG\s0 options may also be set in the import list. See \(L"\s-1EXPORTS\s0\(R" above
214	for more on the available options.
215	.PP
216	Furthermore, the following options:
217	.PP
218	.Vb 7
219	\& -version
220	\& -encoding
221	\& -standalone
222	\& -namespace
223	\& -inline
224	\& -pubid (formerly -identifier)
225	\& -sysid (standalone)
226	.Ve
227	.PP
228	may also be set in xmlify, overriding any corresponding values set in the \s-1SVG\-\s0>new declaration
229	.Sh "xmlify (alias: to_xml render)"
230	.IX Subsection "xmlify (alias: to_xml render)"
231	$string = \f(CW$svg\fR\->xmlify(%attributes);
232	.PP
233	Returns xml representation of svg document.
234	.PP
235	\&\fB\s-1XML\s0 Declaration\fR
236	.PP
237	.Vb 10
238	\& Name Default Value
239	\& -version '1.0'
240	\& -encoding 'UTF-8'
241	\& -standalone 'yes'
242	\& -namespace 'svg' - namespace for elements.
243	\& Can also be used in any element method to over-ride
244	\& the current namespace
245	\& -inline '0' - If '1', then this is an inline document.
246	\& -pubid '-//W3C//DTD SVG 1.0//EN';
247	\& -sysid 'http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd'
248	.Ve