[librsvg] Update the toplevel docs with a better description of what librsvg is
- From: Federico Mena Quintero <federico src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [librsvg] Update the toplevel docs with a better description of what librsvg is
- Date: Tue, 21 Nov 2017 20:51:00 +0000 (UTC)
commit 438acfed22789bf5013fd7916a79fa2cd7dad070
Author: Federico Mena Quintero <federico gnome org>
Date: Mon Nov 20 16:53:17 2017 -0600
Update the toplevel docs with a better description of what librsvg is
doc/rsvg-docs.xml | 59 +++++++++++++++++++++++++++++++++++++++++++++++++---
1 files changed, 55 insertions(+), 4 deletions(-)
---
diff --git a/doc/rsvg-docs.xml b/doc/rsvg-docs.xml
index 4615a92..1e72a63 100644
--- a/doc/rsvg-docs.xml
+++ b/doc/rsvg-docs.xml
@@ -1,10 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE book
+[
+ <!ENTITY version SYSTEM "version.xml">
+]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.1">
<!--
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
@@ -14,10 +19,10 @@
A copy of the license is included in the COPYING file.
-->
<info>
- <title>RSVG Libary Reference Manual</title>
+ <title>Librsvg Reference Manual</title>
<releaseinfo>
- For RSVG version 2.41.2
-.
+ For librsvg version &version;
+
The latest version of this documentation can be found on-line at the
<link xlink:href="http://library.gnome.org/devel/rsvg/index.html" role="online-location">GNOME
Library</link>.
</releaseinfo>
@@ -38,6 +43,11 @@
<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
@@ -64,8 +74,49 @@
<title>API Reference</title>
<partintro>
<para>
- The GNOME SVG Library (RSVG) is library for rendering SVG and SVGZ files.
+ Librsvg is a library for rendering Scalable Vector Graphics 1.1
+ files (<link
+ xlink:href="https://www.w3.org/TR/SVG/">SVG 1.1</link>).
+ Specifically, it can take non-animated, non-scripted SVG data
+ and render it into a <link
+ xlink:href="https://www.cairographics.org/">Cairo</link>
+ 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 <link
+ xlink:href="https://www.w3.org/TR/SVG/">SVG 1.1
+ specification</link>. 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="xml/rsvg-handle.xml"/>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]