X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=docs%2Freference%2Fmodest-docs.sgml;h=43160a943d14cb7fde69d4f826ba162979add5e9;hp=2b5afe3a8fec9ac12c8df4b0f0c782b85e7520e2;hb=d5bee34a102dfc92754e669bf930a290d69586be;hpb=345ca277f43ebd369dff0cae6cdf4f1501e80bfa

diff --git a/docs/reference/modest-docs.sgml b/docs/reference/modest-docs.sgml
index 2b5afe3..43160a9 100644
--- a/docs/reference/modest-docs.sgml
+++ b/docs/reference/modest-docs.sgml
@@ -1,7 +1,53 @@
 <?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">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+
+<!ENTITY ModestAccountKeys SYSTEM "xml/modest-account-keys.xml">
+<!ENTITY ModestAccountMgr SYSTEM "xml/modest-account-mgr.xml">
+<!ENTITY ModestConfKeys SYSTEM "xml/modest-conf-keys.xml">
+<!ENTITY ModestConf SYSTEM "xml/modest-conf.xml">
+<!ENTITY ModestError SYSTEM "xml/modest-error.xml">
+<!ENTITY ModestFormatter SYSTEM "xml/modest-formatter.xml">
+<!ENTITY ModestIconFactory SYSTEM "xml/modest-icon-factory.xml">
+<!ENTITY ModestIconNames SYSTEM "xml/modest-icon-names.xml">
+<!ENTITY ModestMailOperation SYSTEM "xml/modest-mail-operation.xml">
+<!ENTITY ModestMailOperationQueue SYSTEM "xml/modest-mail-operation-queue.xml">
+<!ENTITY ModestMarshal SYSTEM "xml/modest-marshal.xml">
+<!ENTITY ModestPair SYSTEM "xml/modest-pair.xml">
+<!ENTITY ModestPresets SYSTEM "xml/modest-presets.xml">
+<!ENTITY ModestProtocolMgr SYSTEM "xml/modest-protocol-mgr.xml">
+<!ENTITY ModestProto SYSTEM "xml/modest-proto.xml">
+<!ENTITY ModestTextUtils SYSTEM "xml/modest-text-utils.xml">
+<!ENTITY ModestTnyAccountStore SYSTEM "xml/modest-tny-account-store.xml">
+<!ENTITY ModestTnyAttachment SYSTEM "xml/modest-tny-attachment.xml">
+<!ENTITY ModestTnyMsgActions SYSTEM "xml/modest-tny-msg-actions.xml">
+<!ENTITY ModestTnyPlatformFactory SYSTEM "xml/modest-tny-platform-factory.xml">
+<!ENTITY ModestTnyStoreActions SYSTEM "xml/modest-tny-store-actions.xml">
+<!ENTITY ModestTnyStreamGtkhtml SYSTEM "xml/modest-tny-stream-gtkhtml.xml">
+<!ENTITY ModestWidgetFactory SYSTEM "xml/modest-widget-factory.xml">
+<!ENTITY ModestWidgetMemory SYSTEM "xml/modest-widget-memory.xml">
+
+<!ENTITY widgets-ModestAccountView SYSTEM "xml/modest-account-view.xml">
+<!ENTITY widgets-ModestComboBox SYSTEM "xml/modest-combo-box.xml">
+<!ENTITY widgets-ModestFolderView SYSTEM "xml/modest-folder-view.xml">
+<!ENTITY widgets-ModestHeaderView SYSTEM "xml/modest-header-view.xml">
+<!ENTITY widgets-ModestMsgView SYSTEM "xml/modest-msg-view.xml">
+<!ENTITY widgets-modestToolbar SYSTEM "xml/modest-toolbar.xml">
+
+<!ENTITY gtk-ModestAccountViewWindow SYSTEM "xml/modest-account-view-window.xml">
+<!ENTITY gtk-ModestAccountAssistant SYSTEM "xml/modest-account-assistant.xml">
+<!ENTITY gtk-ModestEditMsgWindow SYSTEM "xml/modest-edit-msg-window.xml">
+<!ENTITY gtk-ModestMainWindow SYSTEM "xml/modest-main-window.xml">
+<!ENTITY gtk-ModestStoreWidget SYSTEM "xml/modest-store-widget.xml">
+<!ENTITY gtk-modestTransportWidget SYSTEM "xml/modest-transport-widget.xml">
+<!ENTITY gtk-modestUi SYSTEM "xml/modest-ui.xml">
+
+<!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml">
+
+]>
+
+<!--<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">-->
+<book id="index">
   <bookinfo>
     <title>modest technical documentation</title>
     <copyright>
@@ -304,7 +350,16 @@
       with <command>gcc</command>'s <symbol>-Wall</symbol> compile option. Of
       course this might not always be possible due to problems in dependent
       libraries and/or compiler version. Therefore, do not
-      include <symbol>-Werror</symbol> in the standard compile options.
+      include <symbol>-Werror</symbol> in the standard compile options; but
+      do use it when building / testing things yourself.
+    </para>
+
+    <para>
+      Code should also run cleanly. GTK+/GLib warnings and errors must be
+      taken very seriously. If you run <application>modest</application> with
+      the <symbol>-d</symbol>-flag, it will <symbol>abort</symbol> whenever
+      there is such a warning. This can be useful when running inside the
+      debugger. 
     </para>
     
     <para>Global functions (the ones in <filename>.h</filename>-files) must
@@ -337,20 +392,38 @@
   
   <chapter>
     <title>API Reference</title>
-    <xi:include href="xml/modest-ui.xml"/>
-    <xi:include href="xml/modest-tny-header-tree-view.xml"/>
-    <xi:include href="xml/modest-tny-msg-view.xml"/>
-    <xi:include href="xml/modest-account-mgr.xml"/>
-    <xi:include href="xml/modest-conf.xml"/>
-    <xi:include href="xml/modest-window-mgr.xml"/>
-    <xi:include href="xml/modest-tny-folder-tree-view.xml"/>
-    <xi:include href="xml/modest-tny-account-store.xml"/>
-    <xi:include href="xml/modest-tny-transport-actions.xml"/>
-    <xi:include href="xml/modest-main-window.xml"/>
-    <xi:include href="xml/modest-editor-window.xml"/>
-    <xi:include href="xml/modest-viewer-window.xml"/>
-    <xi:include href="xml/modest-proto.xml"/>
-    <xi:include href="xml/modest-account-keys.xml"/>
-    <xi:include href="xml/modest-conf-keys.xml"/>
+      <chapter id="src">
+        <title>Modest</title>
+          &ModestAccountKeys;
+          &ModestAccountMgr;
+          &ModestConfKeys;
+          &ModestConf;
+          &ModestError;
+          &ModestFormatter;
+          &ModestIconFactory;
+          &ModestIconNames;
+          &ModestMailOperation;
+          &ModestMailOperationQueue;
+          &ModestMarshal;
+          &ModestPair;
+          &ModestPresets;
+          &ModestProtocolMgr;
+          &ModestProto;
+          &ModestTextUtils;
+          &ModestTnyAccountStore;
+          &ModestTnyAttachment;
+          &ModestTnyMsgActions;
+          &ModestTnyPlatformFactory;
+          &ModestTnyStoreActions;
+          &ModestTnyStreamGtkhtml;
+          &ModestWidgetFactory;
+          &ModestWidgetMemory;
+      </chapter>
+      <chapter id="gtk">
+        <title>Gtk</title>
+      </chapter>
+      <chapter id="widgets">
+        <title>Widgets</title>
+      </chapter>
   </chapter>
 </book>