191 lines
6.5 KiB
XML
191 lines
6.5 KiB
XML
<?xml version="1.0"?>
|
||
<!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="atril-document">
|
||
<!--
|
||
Copyright © 2009, 2010 Christian Persch
|
||
|
||
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>Atril Document Library Reference Manual</title>
|
||
<releaseinfo>
|
||
For Atril version &version;.
|
||
The latest version of this documentation can be found on-line at the
|
||
<ulink role="online-location" url="http://library.mate.org/devel/libevdocument/index.html">MATE Library</ulink>.
|
||
</releaseinfo>
|
||
|
||
<copyright>
|
||
<year>2007</year>
|
||
<year>2008</year>
|
||
<year>2009</year>
|
||
<holder>Nickolay V. Shmyrev</holder>
|
||
</copyright>
|
||
|
||
<copyright>
|
||
<year>2008</year>
|
||
<year>2009</year>
|
||
<year>2010</year>
|
||
<holder>Carlos Garcia Campos</holder>
|
||
</copyright>
|
||
|
||
<copyright>
|
||
<year>2009</year>
|
||
<year>2010</year>
|
||
<holder>Christian Persch</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 type="http" 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="document-interfaces">
|
||
<title>Document Interfaces</title>
|
||
<partintro>
|
||
<para>
|
||
Provides support for writing Atril backends.
|
||
</para>
|
||
</partintro>
|
||
|
||
<xi:include href="xml/ev-async-renderer.xml"/>
|
||
<xi:include href="xml/ev-document.xml"/>
|
||
<xi:include href="xml/ev-document-annotations.xml"/>
|
||
<xi:include href="xml/ev-document-attachments.xml"/>
|
||
<xi:include href="xml/ev-document-find.xml"/>
|
||
<xi:include href="xml/ev-document-fonts.xml"/>
|
||
<xi:include href="xml/ev-document-forms.xml"/>
|
||
<xi:include href="xml/ev-document-images.xml"/>
|
||
<xi:include href="xml/ev-document-info.xml"/>
|
||
<xi:include href="xml/ev-document-layers.xml"/>
|
||
<xi:include href="xml/ev-document-links.xml"/>
|
||
<xi:include href="xml/ev-document-misc.xml"/>
|
||
<xi:include href="xml/ev-document-print.xml"/>
|
||
<xi:include href="xml/ev-document-security.xml"/>
|
||
<xi:include href="xml/ev-document-thumbnails.xml"/>
|
||
<xi:include href="xml/ev-document-transition.xml"/>
|
||
<xi:include href="xml/ev-selection.xml"/>
|
||
<xi:include href="xml/ev-file-exporter.xml"/>
|
||
</part>
|
||
|
||
<part id="document-data">
|
||
<title>Document Data</title>
|
||
<partintro>
|
||
<para>
|
||
Helper objects related to documents like attachments, links and
|
||
images, etc.
|
||
</para>
|
||
</partintro>
|
||
|
||
<xi:include href="xml/ev-annotation.xml"/>
|
||
<xi:include href="xml/ev-attachment.xml"/>
|
||
<xi:include href="xml/ev-form-field.xml"/>
|
||
<xi:include href="xml/ev-image.xml"/>
|
||
<xi:include href="xml/ev-layer.xml"/>
|
||
<xi:include href="xml/ev-link-action.xml"/>
|
||
<xi:include href="xml/ev-link-dest.xml"/>
|
||
<xi:include href="xml/ev-link.xml"/>
|
||
<xi:include href="xml/ev-mapping.xml"/>
|
||
<xi:include href="xml/ev-page.xml"/>
|
||
<xi:include href="xml/ev-render-context.xml"/>
|
||
<xi:include href="xml/ev-transition-effect.xml"/>
|
||
</part>
|
||
|
||
<part id="document-helpers">
|
||
<title>Helper Functions</title>
|
||
<partintro>
|
||
<para>
|
||
Helper functions common for backend implementations, and for libevdocument library users.
|
||
</para>
|
||
</partintro>
|
||
|
||
<xi:include href="xml/ev-init.xml"/>
|
||
<xi:include href="xml/ev-version.xml"/>
|
||
<xi:include href="xml/ev-file-helpers.xml"/>
|
||
<xi:include href="xml/ev-document-factory.xml"/>
|
||
<xi:include href="xml/ev-backends-manager.xml"/>
|
||
</part>
|
||
|
||
<chapter id="object-tree">
|
||
<title>Object Hierarchy</title>
|
||
<xi:include href="xml/tree_index.sgml"/>
|
||
</chapter>
|
||
<index id="api-index-full">
|
||
<title>API Index</title>
|
||
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
||
</index>
|
||
<!--
|
||
<index id="api-index-deprecated" role="deprecated">
|
||
<title>Index of deprecated symbols</title>
|
||
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
|
||
</index>
|
||
-->
|
||
<!--
|
||
<index id="api-index-2-30" role="2.30">
|
||
<title>Index of new symbols in 2.30</title>
|
||
<xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
|
||
</index>
|
||
-->
|
||
|
||
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
||
|
||
<appendix 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 type="http" 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>
|