git.maemo.org Git - modest/blob - docs/reference/modest-docs.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3           "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4
   5 <!ENTITY ModestAccountMgrHelpers SYSTEM "xml/modest-account-mgr-helpers.xml">
   6 <!ENTITY ModestAccountMgr SYSTEM "xml/modest-account-mgr.xml">
   7 <!ENTITY ModestAccountViewWindow SYSTEM "xml/modest-account-view-window.xml">
   8 <!ENTITY ModestAccountView SYSTEM "xml/modest-account-view.xml">
   9 <!ENTITY ModestCacheMgr SYSTEM "xml/modest-cache-mgr.xml">
  10 <!ENTITY ModestComboBox SYSTEM "xml/modest-combo-box.xml">
  11 <!ENTITY ModestConf SYSTEM "xml/modest-conf.xml">
  12 <!ENTITY ModestError SYSTEM "xml/modest-error.xml">
  13 <!ENTITY ModestFolderView SYSTEM "xml/modest-folder-view.xml">
  14 <!ENTITY ModestHeaderView SYSTEM "xml/modest-header-view.xml">
  15 <!ENTITY ModestIconNames SYSTEM "xml/modest-icon-names.xml">
  16 <!ENTITY ModestLocalFolderInfo SYSTEM "xml/modest-local-folder-info.xml">
  17 <!ENTITY ModestMailOperationQueue SYSTEM "xml/modest-mail-operation-queue.xml">
  18 <!ENTITY ModestMailOperations SYSTEM "xml/modest-mail-operation.xml">
  19 <!ENTITY ModestMainWindow SYSTEM "xml/modest-main-window.xml">
  20 <!ENTITY ModestMsgEditWindow SYSTEM "xml/modest-msg-edit-window.xml">
  21 <!ENTITY ModestMsgViewWindow SYSTEM "xml/modest-msg-view-window.xml">
  22 <!ENTITY ModestMsgView SYSTEM "xml/modest-msg-view.xml">
  23 <!ENTITY ModestPair SYSTEM "xml/modest-pair.xml">
  24 <!ENTITY ModestProtocolInfo SYSTEM "xml/modest-protocol-info.xml">
  25 <!ENTITY ModestRuntime SYSTEM "xml/modest-runtime.xml">
  26 <!ENTITY ModestSingletons SYSTEM "xml/modest-singletons.xml">
  27 <!ENTITY ModestTextUtils SYSTEM "xml/modest-text-utils.xml">
  28 <!ENTITY ModestTnyAccountStore SYSTEM "xml/modest-tny-account-store.xml">
  29 <!ENTITY ModestTnyAccount SYSTEM "xml/modest-tny-account.xml">
  30 <!ENTITY ModestTnyFolder SYSTEM "xml/modest-tny-folder.xml">
  31 <!ENTITY ModestTnyMsg SYSTEM "xml/modest-tny-msg.xml">
  32 <!ENTITY ModestTnyPlatformFactory SYSTEM "xml/modest-tny-platform-factory.xml">
  33 <!ENTITY ModestTnySendQueue SYSTEM "xml/modest-tny-send-queue.xml">
  34 <!ENTITY ModestTnyStreamGtkHtml SYSTEM "xml/modest-tny-stream-gtkhtml.xml">
  35 <!ENTITY ModestUIActions SYSTEM "xml/modest-ui-actions.xml">
  36 <!ENTITY ModestWidgetMemory SYSTEM "xml/modest-widget-memory.xml">
  37 <!ENTITY ModestWindow SYSTEM "xml/modest-window.xml">
  38
  39 <!-- <!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml"> -->
  40
  41 <!ENTITY preface SYSTEM "modest-preface.sgml">
  42 <!ENTITY architecture SYSTEM "modest-architecture.sgml">
  43 <!ENTITY design SYSTEM "modest-design.sgml">
  44 <!ENTITY coding-guidelines SYSTEM "modest-coding-guidelines.sgml">
  45
  46 ]>
  47
  48 <book id="index">
  49   <bookinfo>
  50     <title>modest technical documentation</title>
  51     <copyright>
  52       <year>2006, 2007</year>
  53       <holder>Nokia Corporation</holder>
  54     </copyright>
  55   </bookinfo>
  56
  57   &preface;
  58
  59   &architecture;
  60
  61   &design;
  62
  63   &coding-guidelines;
  64
  65 <!--
  66   <reference>
  67     <title>Object Index</title>
  68       &index-Object-Tree;
  69   </reference>
  70 -->
  71   <reference>
  72     <title>API Reference</title>
  73
  74       <chapter id="core">
  75         <title>Core/Runtime</title>
  76         &ModestRuntime;
  77         &ModestSingletons;
  78 <!--    &ModestPlatform; -->
  79 <!--    &ModestInit; -->
  80       </chapter>
  81
  82       <chapter id="mail">
  83         <title>Mail</title>
  84         &ModestTnyMsg;
  85         &ModestTnyFolder;
  86         &ModestTnySendQueue;
  87         &ModestTnyAccountStore;
  88 <!--    &ModestMailOperation; -->
  89         &ModestMailOperationQueue;
  90       </chapter>
  91
  92
  93       <chapter id="widgets">
  94         <title>Widgets</title>
  95         &ModestAccountView;
  96         &ModestAccountViewWindow;
  97         &ModestComboBox;
  98         &ModestFolderView;
  99         &ModestHeaderView;
 100         &ModestMainWindow;
 101         &ModestMsgView;
 102         &ModestMsgViewWindow;
 103         &ModestMsgEditWindow;
 104         &ModestWindow;
 105       </chapter>
 106
 107       <chapter id="accmgmt_settings">
 108         <title>Account Management and Settings</title>
 109         &ModestAccountMgr;
 110         &ModestAccountMgrHelpers;
 111         &ModestConf;
 112         &ModestWidgetMemory;
 113       </chapter>
 114
 115       <chapter id="other">
 116         <title>Other</title>
 117         &ModestCacheMgr;
 118         &ModestError;
 119         &ModestIconNames;
 120         &ModestPair;
 121         &ModestProtocolInfo;
 122         &ModestLocalFolderInfo;
 123         &ModestTextUtils;
 124       </chapter>
 125
 126   </reference>
 127
 128
 129   <index>
 130     <title>Index</title>
 131   </index>
 132
 133 </book>