Add an overview to the docs

parent 438acfed
......@@ -95,7 +95,8 @@ HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files = \
content_files = \
overview.xml \
version.xml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
......
<?xml version="1.0" encoding="UTF-8" ?>
<chapter>
<title>Overview of Librsvg's API</title>
<para>
Librsvg's API is divided into two main parts: one for loading SVG
data and one for rendering it. In the <emphasis>loading
stage</emphasis>, you create an RsvgHandle object from SVG data,
which can come from a file or from a stream of bytes. In the
<emphasis>rendering stage</emphasis>, you take an RsvgHandle and ask
it to render itself to a Cairo context.
</para>
<formalpara>
<title>Loading</title>
<para>
RsvgHandle is an object that represents SVG data in memory.
Your program creates an RsvgHandle from an SVG file, or from a
memory buffer that contains SVG data, or in the most general
form, from a GIO stream that will provide SVG data. At this
stage you can get either I/O errors or parsing errors. If
loading completes successfully, the RsvgHandle will be ready for
rendering.
</para>
</formalpara>
<formalpara>
<title>Rendering</title>
<para>
Once you have a loaded RsvgHandle, you can render it to a Cairo
context any number of times, or to different Cairo contexts, as
needed.
</para>
</formalpara>
</chapter>
......@@ -119,6 +119,8 @@
</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"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment