Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/help/reference/evince-docs.sgml
diff options
context:
space:
mode:
authorNickolay V. Shmyrev <shmyrev@shadow.teleton>2007-01-29 17:41:17 (GMT)
committer Nickolay V. Shmyrev <nshmyrev@src.gnome.org>2007-01-29 17:41:17 (GMT)
commit601704e95712f26f4debff64a77cffbacdcc62f3 (patch)
treed513c8659e55602bbcce99d02f36287d6e236cd3 /help/reference/evince-docs.sgml
parent2ca95ac3cd6e57516f16a8ee3983c45e27d69cac (diff)
Added gtk-doc based documentation for Evince. Still in initial state but I
2007-01-29 Nickolay V. Shmyrev <shmyrev@shadow.teleton> * help/reference/* : * configure.ac: Added gtk-doc based documentation for Evince. Still in initial state but I hope it will grow. * configure.ac: Lower dbus requirement to 0.70 svn path=/trunk/; revision=2272
Diffstat (limited to 'help/reference/evince-docs.sgml')
-rw-r--r--help/reference/evince-docs.sgml41
1 files changed, 41 insertions, 0 deletions
diff --git a/help/reference/evince-docs.sgml b/help/reference/evince-docs.sgml
new file mode 100644
index 0000000..a90c772
--- /dev/null
+++ b/help/reference/evince-docs.sgml
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+ <!ENTITY ev-attachment SYSTEM "xml/ev-attachment.xml">
+ <!ENTITY ev-page-cache SYSTEM "xml/ev-attachment.xml">
+ <!ENTITY ev-window SYSTEM "xml/ev-window.xml">
+ <!ENTITY ev-view SYSTEM "xml/ev-view.xml">
+ <!ENTITY tree_index SYSTEM "xml/tree_index.sgml">
+ ]>
+<book id="index">
+ <bookinfo>
+ <title>Evince Programmer's Reference Manual</title>
+ </bookinfo>
+
+ <part id="libdocument">
+ <para>
+ Provides support for writing Evince backends. For example
+ EvAttachment is used to represent document attachments.
+ </para>
+ &ev-attachment;
+ </part>
+
+ <part id="shell">
+
+ <para>
+
+ Evince internals are rather simple. There are an application
+ singleton that maintains list of windows and provides common
+ services, each window shows loaded document, it has menus
+ sidebar, toolbar and main view.
+
+ </para>
+
+ &ev-window; - Main window class
+ &ev-view; - View for document
+ &ev-page-cache; - Document page cache
+ </part>
+
+ <index/>
+
+</book>