Added support for setting References and In-Reply-To: mime fields

[modest] / docs / reference / modest-docs.sgml

diff --git a/docs/reference/modest-docs.sgml b/docs/reference/modest-docs.sgml
index 167deba..158c68f 100644 (file)
--- a/docs/reference/modest-docs.sgml
+++ b/docs/reference/modest-docs.sgml
@@ -1,43 +1,133 @@
 <?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" [
+          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
-<!ENTITY modest-ModestConf SYSTEM  "xml/modest-conf.xml">
+<!ENTITY ModestAccountMgrHelpers SYSTEM "xml/modest-account-mgr-helpers.xml">
+<!ENTITY ModestAccountMgr SYSTEM "xml/modest-account-mgr.xml">
+<!ENTITY ModestAccountViewWindow SYSTEM "xml/modest-account-view-window.xml">
+<!ENTITY ModestAccountView SYSTEM "xml/modest-account-view.xml">
+<!ENTITY ModestCacheMgr SYSTEM "xml/modest-cache-mgr.xml">
+<!ENTITY ModestComboBox SYSTEM "xml/modest-combo-box.xml">
+<!ENTITY ModestConf SYSTEM "xml/modest-conf.xml">
+<!ENTITY ModestError SYSTEM "xml/modest-error.xml">
+<!ENTITY ModestFolderView SYSTEM "xml/modest-folder-view.xml">
+<!ENTITY ModestHeaderView SYSTEM "xml/modest-header-view.xml">
+<!ENTITY ModestIconNames SYSTEM "xml/modest-icon-names.xml">
+<!ENTITY ModestLocalFolderInfo SYSTEM "xml/modest-local-folder-info.xml">
+<!ENTITY ModestMailOperationQueue SYSTEM "xml/modest-mail-operation-queue.xml">
+<!ENTITY ModestMailOperations SYSTEM "xml/modest-mail-operation.xml">
+<!ENTITY ModestMainWindow SYSTEM "xml/modest-main-window.xml">
+<!ENTITY ModestMsgEditWindow SYSTEM "xml/modest-msg-edit-window.xml">
+<!ENTITY ModestMsgViewWindow SYSTEM "xml/modest-msg-view-window.xml">
+<!ENTITY ModestMsgView SYSTEM "xml/modest-msg-view.xml">
+<!ENTITY ModestPair SYSTEM "xml/modest-pair.xml">
+<!ENTITY ModestProtocolInfo SYSTEM "xml/modest-protocol-info.xml">
+<!ENTITY ModestRuntime SYSTEM "xml/modest-runtime.xml">
+<!ENTITY ModestSingletons SYSTEM "xml/modest-singletons.xml">
+<!ENTITY ModestTextUtils SYSTEM "xml/modest-text-utils.xml">
+<!ENTITY ModestTnyAccountStore SYSTEM "xml/modest-tny-account-store.xml">
+<!ENTITY ModestTnyAccount SYSTEM "xml/modest-tny-account.xml">
+<!ENTITY ModestTnyFolder SYSTEM "xml/modest-tny-folder.xml">
+<!ENTITY ModestTnyMsg SYSTEM "xml/modest-tny-msg.xml">
+<!ENTITY ModestTnyPlatformFactory SYSTEM "xml/modest-tny-platform-factory.xml">
+<!ENTITY ModestTnySendQueue SYSTEM "xml/modest-tny-send-queue.xml">
+<!ENTITY ModestTnyStreamGtkHtml SYSTEM "xml/modest-tny-stream-gtkhtml.xml">
+<!ENTITY ModestUIActions SYSTEM "xml/modest-ui-actions.xml">
+<!ENTITY ModestWidgetMemory SYSTEM "xml/modest-widget-memory.xml">
+<!ENTITY ModestWindow SYSTEM "xml/modest-window.xml">
+
+<!-- <!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml"> -->
+
+<!ENTITY preface SYSTEM "modest-preface.sgml">
+<!ENTITY architecture SYSTEM "modest-architecture.sgml">
+<!ENTITY design SYSTEM "modest-design.sgml">
+<!ENTITY coding-guidelines SYSTEM "modest-coding-guidelines.sgml">
 
-<!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml">
-<!ENTITY index-Object-Index SYSTEM "xml/object_index.sgml">
 ]>
 
 <book id="index">
   <bookinfo>
-    <title>modest reference manual</title>
+    <title>modest technical documentation</title>
+    <copyright>
+      <year>2006, 2007</year>
+      <holder>Nokia Corporation</holder>
+    </copyright>
   </bookinfo>
 
-  <preface>
-    <title>Introduction</title>
-    <para>modest is a lightweight e-mail program, built on top of
-    tinymail and libcamel</para>
-  </preface>
+  &preface;
 
+  &architecture;
+  
+  &design;
+  
+  &coding-guidelines;
+  
+<!--
   <reference>
     <title>Object Index</title>
-       &index-Object-Index;
-       &index-Object-Tree;
+      &index-Object-Tree;
   </reference>
-
+-->
   <reference>
     <title>API Reference</title>
 
-       <chapter id="modest-core">
-               <title>modest general</title>
-               &modest-ModestConf;
-       </chapter>
+      <chapter id="core">
+        <title>Core/Runtime</title>
+       &ModestRuntime;
+       &ModestSingletons;
+<!--   &ModestPlatform; -->
+<!--   &ModestInit; -->
+      </chapter>
+      
+      <chapter id="mail">
+        <title>Mail</title>
+       &ModestTnyMsg;
+       &ModestTnyFolder;
+       &ModestTnySendQueue;
+       &ModestTnyAccountStore;
+<!--   &ModestMailOperation; -->
+        &ModestMailOperationQueue;
+      </chapter>
+
+     
+      <chapter id="widgets">
+        <title>Widgets</title>
+        &ModestAccountView;
+       &ModestAccountViewWindow;
+        &ModestComboBox;
+        &ModestFolderView;
+        &ModestHeaderView;
+        &ModestMainWindow;
+        &ModestMsgView;
+       &ModestMsgViewWindow;
+       &ModestMsgEditWindow;
+       &ModestWindow;
+      </chapter>
+
+      <chapter id="accmgmt_settings">
+        <title>Account Management and Settings</title>
+        &ModestAccountMgr;
+       &ModestAccountMgrHelpers;
+       &ModestConf;
+       &ModestWidgetMemory;
+      </chapter>
+      
+      <chapter id="other">
+        <title>Other</title>
+       &ModestCacheMgr;
+       &ModestError;
+       &ModestIconNames;
+       &ModestPair;
+       &ModestProtocolInfo;
+       &ModestLocalFolderInfo;
+       &ModestTextUtils;
+      </chapter>
 
   </reference>
 
+
   <index>
     <title>Index</title>
   </index>
-  
-</book>
 
+</book>