]> www.fi.muni.cz Git - evince.git/blob - help/reference/libdocument/libevdocument-docs.sgml
Split API documentation into libdocument, libview and shell. Required
[evince.git] / help / reference / libdocument / libevdocument-docs.sgml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
4 [
5   <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
6   <!ENTITY version SYSTEM "version.xml">
7 ]>
8 <book id="index">
9   <bookinfo>
10     <title>libevdocument Reference Manual</title>
11     <releaseinfo>for Evince &version;</releaseinfo>
12   </bookinfo>
13
14   <part id="interfaces">
15     <title>Document Interfaces</title>
16     <partintro>
17       <para>
18         Provides support for writing Evince backends. For example
19         EvDocumentAttachments is used to represent document
20         attachments. The core have objects that represent various
21         document interfaces.
22       </para>
23     </partintro>
24     <xi:include href="xml/ev-async-renderer.xml"/>
25     <xi:include href="xml/ev-document-find.xml"/>
26     <xi:include href="xml/ev-document-fonts.xml"/>
27     <xi:include href="xml/ev-document-forms.xml"/>
28     <xi:include href="xml/ev-document-images.xml"/>
29     <xi:include href="xml/ev-document-links.xml"/>
30     <xi:include href="xml/ev-document-security.xml"/>
31     <xi:include href="xml/ev-document-thumbnails.xml"/>
32     <xi:include href="xml/ev-document-transition.xml"/>
33     <xi:include href="xml/ev-file-exporter.xml"/>
34     <xi:include href="xml/ev-document.xml"/>
35     <xi:include href="xml/ev-selection.xml"/>
36     <xi:include href="xml/ev-document-layers.xml"/>
37   </part>
38
39   <part id="data">
40     <title>Document data</title>
41     <partintro>
42       <para>
43         Helper objects related to document like attachments, links and
44         images.
45       </para>
46     </partintro>
47     <xi:include href="xml/ev-attachment.xml"/>
48     <xi:include href="xml/ev-document-info.xml"/>
49     <xi:include href="xml/ev-form-field.xml"/>
50     <xi:include href="xml/ev-image.xml"/>
51     <xi:include href="xml/ev-link-action.xml"/>
52     <xi:include href="xml/ev-link-dest.xml"/>
53     <xi:include href="xml/ev-link.xml"/>
54     <xi:include href="xml/ev-render-context.xml"/>
55     <xi:include href="xml/ev-layer.xml"/>
56     <xi:include href="xml/ev-page.xml"/>
57     <xi:include href="xml/ev-transition-effect.xml"/>
58   </part>
59
60   <part id="helper">
61     <title>Helper functions</title>
62     <partintro>
63       <para>
64         Helper functions common for backend implementation
65       </para>
66     </partintro>
67     <xi:include href="xml/ev-document-factory.xml"/>
68     <xi:include href="xml/ev-document-misc.xml"/>
69     <xi:include href="xml/ev-file-helpers.xml"/>
70     <xi:include href="xml/ev-backends-manager.xml"/>
71     <xi:include href="xml/ev-init.xml"/>
72   </part>
73
74 </book>