summaryrefslogtreecommitdiffstats
path: root/docs/reference/ibus/ibus-docs.sgml
blob: 043890cf4b9ec4f694a35c785c7dd71401ea3465 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?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">
  <bookinfo>
    <title>iBus Reference Manual</title>
    <releaseinfo>
      iBus 1.1.0 reference manual.
      The latest version of this documentation can be found on-line at
      <ulink role="online-location" url="http://code.google.com/p/ibus">http://code.google.com/p/ibus</ulink>.
    </releaseinfo>
  </bookinfo>

  <chapter>
      <title>API Overviews</title>
      <para>The iBus API consists 3 parts:
	  <emphasis>User interfaces</emphasis> for objects and services which
	  are relateed to iBus UI such as language bar;
          <emphasis>Input method engine</emphasis> for input method main logic and input/output handling;
	  <emphasis>Configure</emphasis> for services for save, load and listening configures.
      </para>
  </chapter>
  <chapter>
      <title>User Interfaces</title>
      <para>These APIs directly related to User interfaces, such as
	  pre-edit buffer, auxiliary text, language bar, button,
	  radio boxes, and so on.
      </para>
      <xi:include href="xml/ibusattribute.xml"/>
      <xi:include href="xml/ibuslookuptable.xml"/>
      <xi:include href="xml/ibusproperty.xml"/>
      <xi:include href="xml/ibustext.xml"/>
  </chapter>
  <chapter>
      <title>Input method engine</title>
      <para>
      </para>
      <xi:include href="xml/ibusbus.xml"/>
      <xi:include href="xml/ibuscomponent.xml"/>
      <xi:include href="xml/ibusconnection.xml"/>
      <xi:include href="xml/ibusengine.xml"/>
      <xi:include href="xml/ibusenginedesc.xml"/>
      <xi:include href="xml/ibusfactory.xml"/>
      <xi:include href="xml/ibushotkey.xml"/>
      <xi:include href="xml/ibuskeysyms.xml"/>
  </chapter>
  <chapter>
      <title>Configure</title>
      <para>
      </para>
      <xi:include href="xml/ibusconfig.xml"/>
      <xi:include href="xml/ibusconfigservice.xml"/>
      <xi:include href="xml/ibusxml.xml"/>
  </chapter>
  <chapter>
      <title>Others</title>
      <para>
      </para>
      <xi:include href="xml/ibusdebug.xml"/>
      <xi:include href="xml/ibusenumtypes.xml"/>
      <xi:include href="xml/ibuserror.xml"/>
      <xi:include href="xml/ibusinputcontext.xml"/>
      <xi:include href="xml/ibusinternal.xml"/>
      <xi:include href="xml/ibusmarshalers.xml"/>
      <xi:include href="xml/ibusmessage.xml"/>
      <xi:include href="xml/ibusobject.xml"/>
      <xi:include href="xml/ibusobservedpath.xml"/>
      <xi:include href="xml/ibuspendingcall.xml"/>
      <xi:include href="xml/ibusproxy.xml"/>
      <xi:include href="xml/ibusserver.xml"/>
      <xi:include href="xml/ibusservice.xml"/>
      <xi:include href="xml/ibusserializable.xml"/>
      <xi:include href="xml/ibusshare.xml"/>
      <xi:include href="xml/ibustypes.xml"/>
      <xi:include href="xml/keyname-table.xml"/>
  </chapter>
</book>