summaryrefslogtreecommitdiff
path: root/doc/rsvg-docs.xml
blob: bff4007f424ae52e55bec63791a26ce27c4c2ca5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <!--
    Copyright © 2009, 2010 Christian Persch
    Copyright © 2017 Federico Mena Quintero

    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU General Public License, Version 2
    as published by the Free Software Foundation; or (at your option) any
    later version.

    A copy of the license is included in the COPYING file.
    -->
  <bookinfo>
    <title>Librsvg Reference Manual</title>
    <releaseinfo>
      For librsvg version &version;

      The latest version of this documentation can be found on-line at the
      <ulink url="http://library.gnome.org/devel/rsvg/index.html" role="online-location">GNOME Library</ulink>.
    </releaseinfo>

    <copyright>
      <year>2003</year>
      <year>2004</year>
      <year>2005</year>
      <year>2006</year>
      <year>2007</year>
      <year>2008</year>
      <year>2009</year>
      <holder>Dom Lachowicz</holder>
    </copyright>

    <copyright>
      <year>2010</year>
      <holder>Christian Persch</holder>
    </copyright>

    <copyright>
      <year>2017</year>
      <holder>Federico Mena Quintero</holder>
    </copyright>

    <legalnotice>
      <para>
        Permission is granted to copy, distribute and/or modify this document
        under the terms of the <citetitle>GNU General Public Licence</citetitle>
        published by the Free Software Foundation; either version 2 of the License,
        or (at your option) any later version.

        You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
        from the Free Software Foundation at
        <ulink url="http://www.gnu.org/licences/">GNU Licences web site</ulink>
        or by writing to:

        <address>
          The Free Software Foundation, Inc.,
          <street>51 Franklin St</street> – Fifth Floor,
          <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
          <country>USA</country>
        </address>
      </para>
    </legalnotice>
  </bookinfo>

  <part id="rsvg">
    <title>API Reference</title>
    <partintro>
      <para>
        Librsvg is a library for rendering Scalable Vector Graphics 1.1
        files (<ulink url="https://www.w3.org/TR/SVG/">SVG 1.1</ulink>).
        Specifically, it can take non-animated, non-scripted SVG data
        and render it into a <ulink url="https://www.cairographics.org/">Cairo</ulink>
        surface.  Normally this means an in-memory raster surface, but
        it could also be any of the other surface types that Cairo
        supports.
      </para>

      <para>
	Librsvg supports many of the graphic features in the <ulink
	url="https://www.w3.org/TR/SVG/">SVG 1.1
	specification</ulink>.  The main features of SVG 1.1 that
	librsvg does not support are the following:
      </para>

      <itemizedlist>
	<listitem>
	  <para>
	    Scripting or animation - Librsvg reads SVG data and
	    renders it to a static image.  There is no provision to
	    execute scripts that may control animation parameters.
	  </para>
	</listitem>

	<listitem>
	  <para>
	    Access to the DOM - Librsvg creates an internal
	    representation of the SVG data, but it does not provide
	    outside access to the resulting Document Object Model
	    (DOM).
	  </para>
	</listitem>

	<listitem>
	  <para>
	    SVG fonts - Instead, librsvg relies on the system's fonts,
	    particularly those that are available through Cairo/Pango.
	  </para>
	</listitem>
      </itemizedlist>
    </partintro>

    <xi:include href="overview.xml"/>

    <xi:include href="xml/rsvg-handle.xml"/>
    <xi:include href="xml/rsvg-gio.xml"/>
    <xi:include href="xml/rsvg-cairo.xml"/>
    <xi:include href="xml/rsvg-pixbuf.xml"/>
    <xi:include href="xml/rsvg-features.xml"/>
  </part>

  <chapter xml:id="object-tree">
    <title>Object Hierarchy</title>
     <xi:include href="xml/tree_index.sgml"/>
  </chapter>
  <index xml:id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"/>
  </index>
  <index xml:id="api-index-deprecated" role="deprecated">
    <title>Index of deprecated symbols</title>
    <xi:include href="xml/api-index-deprecated.xml"/>
  </index>
  <index xml:id="api-index-2-4" role="2.4">
    <title>Index of new symbols in 2.4</title>
    <xi:include href="xml/api-index-2.4.xml"/>
  </index>
  <index xml:id="api-index-2-8" role="2.8">
    <title>Index of new symbols in 2.8</title>
    <xi:include href="xml/api-index-2.8.xml"/>
  </index>
  <index xml:id="api-index-2-9" role="2.9">
    <title>Index of new symbols in 2.9</title>
    <xi:include href="xml/api-index-2.9.xml"/>
  </index>
  <index xml:id="api-index-2-14" role="2.14">
    <title>Index of new symbols in 2.14</title>
    <xi:include href="xml/api-index-2.14.xml"/>
  </index>
  <index xml:id="api-index-2-22" role="2.22">
    <title>Index of new symbols in 2.22</title>
    <xi:include href="xml/api-index-2.22.xml"/>
  </index>
  <index xml:id="api-index-2-32" role="2.32">
    <title>Index of new symbols in 2.32</title>
    <xi:include href="xml/api-index-2.32.xml"/>
  </index>
  <index xml:id="api-index-2-36" role="2.36">
    <title>Index of new symbols in 2.36</title>
    <xi:include href="xml/api-index-2.36.xml"/>
  </index>
  <index xml:id="api-index-2-46" role="2.46">
    <title>Index of new symbols in 2.46</title>
    <xi:include href="xml/api-index-2.46.xml"/>
  </index>

  <xi:include href="xml/annotation-glossary.xml"/>

  <appendix xml:id="licence">
    <title>Licence</title>

    <para>
      This library is free software; you can redistribute it and/or
      modify it under the terms of the <citetitle>GNU General Public
      Licence</citetitle> as published by the Free Software Foundation; either
      version 2 of the Licence, or (at your option) any later version.
    </para>

    <para>
      This library is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      <citetitle>GNU General Public Licence</citetitle> for
      more details.
    </para>

    <para>
      You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
      from the Free Software Foundation at
      <ulink url="http://www.gnu.org/licences/">GNU Licences web site</ulink>
      or by writing to:

      <address>
        The Free Software Foundation, Inc.,
        <street>51 Franklin St</street> – Fifth Floor,
        <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
        <country>USA</country>
      </address>
    </para>
  </appendix>

</book>