help/reference/libdocument/libevdocument-docs.xml

   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="evince-document">
   9   <!--
  10     Copyright © 2009, 2010 Christian Persch
  11
  12     Permission is granted to copy, distribute and/or modify this document
  13     under the terms of the GNU General Public License, Version 2
  14     as published by the Free Software Foundation; or (at your option) any
  15     later version.
  16
  17     A copy of the license is included in the COPYING file.
  18     -->
  19   <bookinfo>
  20     <title>Evince Document Library Reference Manual</title>
  21     <releaseinfo>
  22       For Evince version &version;.
  23       The latest version of this documentation can be found on-line at the
  24       <ulink role="online-location" url="http://library.gnome.org/devel/libevdocument/index.html">GNOME Library</ulink>.
  25     </releaseinfo>
  26
  27     <copyright>
  28       <year>2007</year>
  29       <year>2008</year>
  30       <year>2009</year>
  31       <holder>Nickolay V. Shmyrev</holder>
  32     </copyright>
  33
  34     <copyright>
  35       <year>2008</year>
  36       <year>2009</year>
  37       <year>2010</year>
  38       <holder>Carlos Garcia Campo</holder>
  39     </copyright>
  40
  41     <copyright>
  42       <year>2009</year>
  43       <year>2010</year>
  44       <holder>Christian Persch</holder>
  45     </copyright>
  46
  47     <legalnotice>
  48       <para>
  49         Permission is granted to copy, distribute and/or modify this document
  50         under the terms of the <citetitle>GNU General Public Licence</citetitle>
  51         published by the Free Software Foundation; either version 2 of the License,
  52         or (at your option) any later version.
  53
  54         You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
  55         from the Free Software Foundation at
  56         <ulink type="http" url="http://www.gnu.org/licences/">GNU Licences web site</ulink>
  57         or by writing to:
  58
  59         <address>
  60           The Free Software Foundation, Inc.,
  61           <street>51 Franklin St</street> – Fifth Floor,
  62           <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
  63           <country>USA</country>
  64         </address>
  65       </para>
  66     </legalnotice>
  67   </bookinfo>
  68
  69   <part id="document-interfaces">
  70     <title>Document Interfaces</title>
  71     <partintro>
  72       <para>
  73         Provides support for writing Evince backends.
  74       </para>
  75     </partintro>
  76
  77     <xi:include href="xml/ev-async-renderer.xml"/>
  78     <xi:include href="xml/ev-document.xml"/>
  79     <xi:include href="xml/ev-document-annotations.xml"/>
  80     <xi:include href="xml/ev-document-attachments.xml"/>
  81     <xi:include href="xml/ev-document-find.xml"/>
  82     <xi:include href="xml/ev-document-fonts.xml"/>
  83     <xi:include href="xml/ev-document-forms.xml"/>
  84     <xi:include href="xml/ev-document-images.xml"/>
  85     <xi:include href="xml/ev-document-info.xml"/>
  86     <xi:include href="xml/ev-document-layers.xml"/>
  87     <xi:include href="xml/ev-document-links.xml"/>
  88     <xi:include href="xml/ev-document-misc.xml"/>
  89     <xi:include href="xml/ev-document-print.xml"/>
  90     <xi:include href="xml/ev-document-security.xml"/>
  91     <xi:include href="xml/ev-document-thumbnails.xml"/>
  92     <xi:include href="xml/ev-document-transition.xml"/>
  93     <xi:include href="xml/ev-selection.xml"/>
  94     <xi:include href="xml/ev-file-exporter.xml"/>
  95   </part>
  96
  97   <part id="document-data">
  98     <title>Document Data</title>
  99     <partintro>
 100       <para>
 101         Helper objects related to documents like attachments, links and
 102         images, etc.
 103       </para>
 104     </partintro>
 105
 106     <xi:include href="xml/ev-annotation.xml"/>
 107     <xi:include href="xml/ev-attachment.xml"/>
 108     <xi:include href="xml/ev-form-field.xml"/>
 109     <xi:include href="xml/ev-image.xml"/>
 110     <xi:include href="xml/ev-layer.xml"/>
 111     <xi:include href="xml/ev-link-action.xml"/>
 112     <xi:include href="xml/ev-link-dest.xml"/>
 113     <xi:include href="xml/ev-link.xml"/>
 114     <xi:include href="xml/ev-mapping.xml"/>
 115     <xi:include href="xml/ev-page.xml"/>
 116     <xi:include href="xml/ev-render-context.xml"/>
 117     <xi:include href="xml/ev-transition-effect.xml"/>
 118   </part>
 119
 120   <part id="document-helpers">
 121     <title>Helper Functions</title>
 122     <partintro>
 123       <para>
 124         Helper functions common for backend implementations, and for libevdocument library users.
 125       </para>
 126     </partintro>
 127
 128     <xi:include href="xml/ev-init.xml"/>
 129     <xi:include href="xml/ev-version.xml"/>
 130     <xi:include href="xml/ev-file-helpers.xml"/>
 131     <xi:include href="xml/ev-document-factory.xml"/>
 132     <xi:include href="xml/ev-backends-manager.xml"/>
 133   </part>
 134
 135   <chapter id="object-tree">
 136     <title>Object Hierarchy</title>
 137      <xi:include href="xml/tree_index.sgml"/>
 138   </chapter>
 139   <index id="api-index-full">
 140     <title>API Index</title>
 141     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 142   </index>
 143   <!--
 144   <index id="api-index-deprecated" role="deprecated">
 145     <title>Index of deprecated symbols</title>
 146     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 147   </index>
 148   -->
 149   <!--
 150   <index id="api-index-2-30" role="2.30">
 151     <title>Index of new symbols in 2.30</title>
 152     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
 153   </index>
 154   -->
 155
 156   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 157
 158   <appendix id="licence">
 159     <title>Licence</title>
 160
 161     <para>
 162       This library is free software; you can redistribute it and/or
 163       modify it under the terms of the <citetitle>GNU General Public
 164       Licence</citetitle> as published by the Free Software Foundation; either
 165       version 2 of the Licence, or (at your option) any later version.
 166     </para>
 167
 168     <para>
 169       This library is distributed in the hope that it will be useful,
 170       but WITHOUT ANY WARRANTY; without even the implied warranty of
 171       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 172       <citetitle>GNU General Public Licence</citetitle> for
 173       more details.
 174     </para>
 175
 176     <para>
 177       You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
 178       from the Free Software Foundation at
 179       <ulink type="http" url="http://www.gnu.org/licences/">GNU Licences web site</ulink>
 180       or by writing to:
 181
 182       <address>
 183         The Free Software Foundation, Inc.,
 184         <street>51 Franklin St</street> – Fifth Floor,
 185         <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
 186         <country>USA</country>
 187       </address>
 188     </para>
 189   </appendix>
 190
 191 </book>