docs/reference/ibus/ibus-docs.sgml.in

   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 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   5   <bookinfo>
   6     <title>IBus Reference Manual</title>
   7     <releaseinfo>
   8       Intelligent Input Bus (IBus) @VERSION@ reference manual.
   9       The latest version of this documentation can be found on-line at
  10       <ulink role="online-location" url="http://code.google.com/p/ibus">http://code.google.com/p/ibus</ulink>.
  11     </releaseinfo>
  12   </bookinfo>
  13
  14   <chapter>
  15       <title>Overview</title>
  16       <para>This manual is the API specification for the IBus.
  17             IBus is built upon GObject and D-Bus,
  18             so you may find that modules are named as classes and objects in the sense of GObject,
  19             and may D-Bus wrapper API.</para>
  20
  21       <para>According to the puroposes of modules, we categorized them into following parts:</para>
  22       <variablelist>
  23           <varlistentry>
  24               <term>Panel</term>
  25               <listitem><para>A IBus-panel is an UI which provides UI components such as language bar,
  26                       property buttons and so on.</para></listitem>
  27           </varlistentry>
  28           <varlistentry>
  29               <term>Input method engine (IME)</term>
  30               <listitem><para>An Input method engine is an implementation of certain input method.
  31                       Here lists essential classes and functions for input method engine building,
  32                       such as engine specification, and class abstracts.</para></listitem>
  33           </varlistentry>
  34           <varlistentry>
  35               <term>Configuration</term>
  36               <listitem><para>This part lists functions for configuring IBus and engines.
  37                       Since most configuration files are in XML format,
  38                       XML handling functions are also listed here.</para></listitem>
  39           </varlistentry>
  40           <varlistentry>
  41               <term>Communication</term>
  42               <listitem><para>Here lists the service communication functions.</para></listitem>
  43           </varlistentry>
  44           <varlistentry>
  45               <term>Internal</term>
  46               <listitem><para>Definition and functions for IBus internal use.</para></listitem>
  47           </varlistentry>
  48       </variablelist>
  49       <para>Normally input method developers need only to read the first three parts.
  50       </para>
  51   </chapter>
  52   <chapter>
  53       <title>Panel (User Interfaces)</title>
  54       <para>These API pages directly related to user interfaces, such as
  55           pre-edit buffer, auxiliary text, language bar, button,
  56           radio boxes, and so on.
  57       </para>
  58       <xi:include href="xml/ibusattribute.xml"/>
  59       <xi:include href="xml/ibusattrlist.xml"/>
  60       <xi:include href="xml/ibushotkey.xml"/>
  61       <xi:include href="xml/ibuslookuptable.xml"/>
  62       <xi:include href="xml/ibuspanelservice.xml"/>
  63       <xi:include href="xml/ibusproperty.xml"/>
  64       <xi:include href="xml/ibusproplist.xml"/>
  65       <xi:include href="xml/ibustext.xml"/>
  66   </chapter>
  67   <chapter>
  68       <title>Input method engine</title>
  69       <para>An Input method engine is an implementation of certain input method.
  70           Here lists essential classes and functions for input method engine building,
  71           such as engine specification, and class abstracts.</para>
  72       <xi:include href="xml/ibuscomponent.xml"/>
  73       <xi:include href="xml/ibusengine.xml"/>
  74       <xi:include href="xml/ibusenginedesc.xml"/>
  75       <xi:include href="xml/ibusenginesimple.xml"/>
  76       <xi:include href="xml/ibusfactory.xml"/>
  77       <xi:include href="xml/ibusinputcontext.xml"/>
  78       <xi:include href="xml/ibuskeys.xml"/>
  79       <xi:include href="xml/ibuskeymap.xml"/>
  80       <xi:include href="xml/ibuskeysyms-compat.xml"/>
  81       <xi:include href="xml/ibuskeysyms.xml"/>
  82       <xi:include href="xml/ibusutil.xml"/>
  83   </chapter>
  84   <chapter>
  85       <title>Configuration</title>
  86       <para>This part lists functions for configuring IBus and engines.
  87           Since most configuration files are in XML format,
  88           XML handling functions are also listed here.</para>
  89       <xi:include href="xml/ibusconfig.xml"/>
  90       <xi:include href="xml/ibusconfigservice.xml"/>
  91       <xi:include href="xml/ibusobservedpath.xml"/>
  92       <xi:include href="xml/ibusregistry.xml"/>
  93       <xi:include href="xml/ibusversion.xml"/>
  94       <xi:include href="xml/ibusxml.xml"/>
  95   </chapter>
  96   <chapter>
  97       <title>Communication</title>
  98       <para>Here lists the service communication functions.</para>
  99       <xi:include href="xml/ibusbus.xml"/>
 100       <xi:include href="xml/ibusproxy.xml"/>
 101       <xi:include href="xml/ibusserializable.xml"/>
 102       <xi:include href="xml/ibusservice.xml"/>
 103   </chapter>
 104   <chapter>
 105       <title>Internal</title>
 106       <para>Definition and functions for IBus internal use.</para>
 107       <xi:include href="xml/ibusdebug.xml"/>
 108       <xi:include href="xml/ibuserror.xml"/>
 109       <xi:include href="xml/ibusobject.xml"/>
 110       <xi:include href="xml/ibusshare.xml"/>
 111       <xi:include href="xml/ibustypes.xml"/>
 112   </chapter>
 113   <index id="api-index-full">
 114     <title>Index</title>
 115     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 116   </index>
 117   <index id="api-index-deprecated" role="deprecated">
 118     <title>Index of deprecated symbols</title>
 119     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 120   </index>
 121   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 122 </book>
 123