blob: 19c4555a6c80e2a9ee94ef612d36107095c54f60 (
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book xmlns:xi="http://www.w3.org/2003/XInclude" id="libgdict">
<bookinfo>
<title>MATE Dictionary Library Reference Manual</title>
<authorgroup>
<author>
<firstname>Emmanuele</firstname>
<surname>Bassi</surname>
<affiliation>
<address>
<email>ebassi@gnome.org</email>
</address>
</affiliation>
</author>
</authorgroup>
<copyright>
<year>2005</year>
<holder>Emmanuele Bassi</holder>
</copyright>
<abstract>
<para>
This manual documents the &version; release of the Dictionary
Library for MATE 2.x
</para>
</abstract>
</bookinfo>
<part id="introduction">
<title>Introduction</title>
<partintro>
<para>
The MATE Dictionary Library is a simple yet powerful collection of
classes that can be used to access various dictionary sources.
</para>
<para>
It was created for the MATE Dictionary application, but it has been
made available for each developer whom wishes to access and display
definitions stored inside language dictionaries.
</para>
</partintro>
</part>
<part id="gdict">
<title>The MATE Dictionary Library</title>
<chapter id="context">
<title>Dictionary Context</title>
<para>A dictionary context is a representation of a transport method,
that is a way to access a dictionary source.</para>
<para>A dictionary source is any digital representation of a language
dictionary which provides a way to programmatically query its contents
for the available definitions of a word, phrase or any kind of
text.</para>
<para>A dictionary source might use files encoded using the DICT or the
StarDict formats, and offer an interface for queries compliant to the
Dictionary Protocol as defined by the RFC 2229.</para>
<xi:include href="xml/gdict-context.xml"/>
</chapter>
<chapter id="context-types">
<title>Context Implementations</title>
<para>The only context implementation currently available is a client
for the Dictionary Protocol.</para>
<xi:include href="xml/gdict-client-context.xml"/>
</chapter>
<chapter id="sources">
<title>Dictionary Source</title>
<para>A dictionary source is repesented using a specially crafted file,
and can be accessed using the GdictSource class.</para>
<para>Dictionary sources can be created at runtime or stored inside a
file and loaded directly using its path. Usually, sources files are
stored inside a predefined path and loaded using the GdictSourceLoader
class.</para>
<xi:include href="xml/gdict-source.xml"/>
<xi:include href="xml/gdict-source-loader.xml"/>
</chapter>
<chapter id="gdict-utils">
<title>Gdict Utilities</title>
<xi:include href="xml/gdict-utils.xml"/>
<xi:include href="xml/gdict-version.xml"/>
</chapter>
</part>
<part id="gdictui">
<title>The MATE Dictionary Library Widgets</title>
<partintro>
<para>
Apart from the low-level classes, the MATE Dictionary library
offers a set of widgets for accessing the dictionary sources and showing
the results of queries.
</para>
</partintro>
<chapter>
<title>Base widgets</title>
<xi:include href="xml/gdict-defbox.xml"/>
<xi:include href="xml/gdict-speller.xml"/>
</chapter>
<chapter>
<title>Advanced widgets</title>
<xi:include href="xml/gdict-database-chooser.xml"/>
<xi:include href="xml/gdict-strategy-chooser.xml"/>
<xi:include href="xml/gdict-source-chooser.xml"/>
</chapter>
</part>
<index>
<title>Index</title>
</index>
<index role="deprecated">
<title>Index of deprecated symbols</title>
</index>
<index role="0.10">
<title>Index of new symbols in 0.10</title>
</index>
<index role="0.12">
<title>Index of new symbols in 0.12</title>
</index>
</book>
|
