/usr/share/doc/opendict/Plugin-HOWTO.html is in opendict 0.6.3-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html;
charset=UTF-8"/>
<title>OpenDict Add-Ons Development HOWTO</title>
</head>
<style>
body
{
font-family: Verdana, Arial, Sans, sans-serif;
font-size: 12px;
color: #555;
}
h1
{
font-size: 26px;
text-align: center;
font-weight: normal;
color: #2b4d85;
}
h2
{
color: #2b4d85;
border-bottom: 1px dashed #2b4d85;
margin: 0px;
margin-top: 20px;
margin-bottom: 10px;
}
div.footer
{
text-align: center;
font-size: 10px;
background-color: #EEE;
border: 1px solid #D9D9D9;
color: #AAA;
}
a
{
color: #2b4d85;
}
a:active, a:hover
{
background-color: #DDD;
}
pre.file-contents
{
border: 1px solid #AAA;
margin-left: 30px;
width: 600px;
background-color: #EEE;
}
table
{
font: inherit;
border: 1px solid #AAA;
border-collapse: collapse;
margin-left: 30px;
width: 600px;
}
table td, table, th
{
border: 1px solid #DDD;
padding: 5px;
}
</style>
<body>
<h1>OpenDict Add-Ons Development HOWTO</h1>
<h2>Introduction</h2>
<p>
OpenDict is free multiplatform dictionary. More information about it
can be found on <a href="http://opendict.idiles.com">OpenDict website</a>.
</p>
<p>
This document is written for developers who want to make
easy-installable OpenDict dictionaries.
</p>
<p>
<i><b>Warning:</b> It is not necessary to make OpenDict dictionary if you
have a dictionary file in Slowo, Mova or DICT format. Such
dictionaries can be used right now by selecting <u>Dictionaries ->
Install Dictionary from File</u> from OpenDict menu.</i>
</p>
<h2>Types of OpenDict Dictionaries</h2>
<p>
OpenDict has two types of dictionaries: <i>plain</i> (simple) dictionaries and
<i>plugin</i> (complex)
dictionaries. <i>Plain</i> dictionaries consists of dictionary file (type of
that dictionary must be supported by OpenDict) and description file in
XML format. <i>Plugin</i> dictionaries consists of Python module with code
that handles search process and description file in XML format; it
may also have dictionary file which is processed by Python module
mentioned above.
</p>
<p>
Plain dictionaries are simple and handy. It is very easy to install
them using OpenDict itself. If you have dictionary file (format of
that dictionary must be supported by OpenDict) and want to attach some
information to it, like the name, the author, the description, you may
want to make <i>plain</i> dictionary.
</p>
<p>
If you have more complex task, like search the web, etc, you may want
to make a <i>plugin</i> for OpenDict. The plugin is a chunk of code
written in <a href="http://www.python.org">Python</a> programming
language that OpenDict attaches to itself at runtime.
</p>
<p>
The next sections of this document will describe how to make
<i>plain</i> dictionaries and <i>plugins</i>.
</p>
<h2>Plain Dictionary Example</h2>
<p>
Assume we have a small dictionary file named <i>mydict.dwa</i> in Slowo
format:
</p>
<pre class="file-contents">
above = ant ; virš ;
abroad = visur ; užsienyje ;
acoustic = akustinis ;
acquaint = pranešti ;
</pre>
<p>
Say we want to call this dictionary "My Personal Dictionary" and
attacht a description "This is my personal dictionary. It is very
small, but it is not the size that matters :)" to it.
<i>Each</i> plain dictionary must have XML description file named
<i>config.xml</i>, otherwise it will be treated as invalid dictionary. So we
write an XML file called config.xml with our favorite text or XML editor:
</p>
<pre class="file-contents">
<?xml version='1.0' encoding='UTF-8'?>
<plain-dictionary>
<format>slowo</format>
<name>My Personal Dictionarys</name>
<version>0.1</version>
<authors>
<author name="Your Name" email="your@email.tdl"/>
</authors>
<path>mydict.dwa</path>
<md5>9c62810c32ca20fe018b79987789daef</md5>
<encoding>UTF-8</encoding>
<description><![CDATA[
This is my personal dictionary. It is very small, but it is not the
size that matters :)
]]>
</description>
</plain-dictionary>
</pre>
<p>
As you can see, a little more information must be added to description
(i.e. configuration) file. Here is a short description of each section:
</p>
<table>
<tr>
<th>XML tag</th>
<th>Description</th>
</tr>
<tr>
<td>format</td>
<td>Dictionary format. OpenDict supports the following formats:
<ul>
<li>slowo -- Slowo format</li>
<li>mova -- Mova format</li>
<li>dict -- DICT format</li>
</ul>
<i>TODO: describe all supported format somewhere</i>
</td>
</tr>
<tr>
<td>name</td>
<td>Name of the dictionary. It will be shown in the
<i>Dictionaries</i> menu in OpenDict window.
</td>
</tr>
<tr>
<td>version</td>
<td>Version value is very important. It shows the freshness of
your dictionary. The more recent the dictionary, the greater
version value must be set. For example: 0.1, 0.2, 0.3, etc; or 1,
2, 3, etc.</td>
</tr>
<tr>
<td>author</td>
<td>
<p>The author of the dictionary. Notice that <i>author</i> tag is
inside <i>authors</i> tag, because there may be several
authors of the dictionary. So add as may <i>author</i> tags as you
want, but make them the childs of the <i>authors</i> tag.</p>
<p>This tag is a bit complicated, because you may not be the
author of the dictionary file you are using. If so, you may treat
the <i>author</i> tag as maintainance tag and write your <i>as
maintainer</i> name inside it. In addition to this, you should
write the name of the author in the <i>description</i> tag
mentioned below.
</td>
</tr>
<tr>
<td>path</td>
<td>Path to the dictionary file. It may be an absolute (i.e. full)
path to the dictionary file or relative path. If you write full
path, dictionary would be taken from there. Buf if you write only
the name of the dictionary (i.e. mydict.dwa), the dictionary will
be treated to be located at <i>$DICTDIR/file/mydict.dwa</i>, where
$DICTDIR is directory where you dictionary is located, for example
<i>/home/mjoc/.opendict/dictionaries/plain/mydict.dwa/file/mydict.dwa</i>.
If you are going to distribute dictionary file <i>with OpenDict
plain dictionary</i>, you want to write only the file name inside
<i>path</i> tag.
</td>
</tr>
<tr>
<td>md5</td>
<td>This is an MD5 checksum value of the dictionary file
(i.e. mydict.dwa). This MD5 code is used to determine changes
of the dictionary file. That means user is able to modify
dictionary file and OpenDict will recreate <i>index table</i>
before using that dictionary next time. If you want to get MD5
checksum value of you dictionary file, execute the following
command on your system (Linux, BSD) shell:
<pre>
$ md5sum myfile.dwa
9c62810c32ca20fe018b79987789daef myfile.dwa
</pre>
You can see the command and the output above. Just copy that
32-chars checksum to your XML file. <i>This is quite unfriendly,
so I will think about easer ways some day. Nevertheless, we are
developers today.</i>
</td>
</tr>
<tr>
<td>encoding</td>
<td>Character encoding of the dictionary file. Examples: UTF-8,
UTF-16, ISO-8859-1, ISO-8859-13, etc.</td>
</tr>
<tr>
<td>description</td>
<td>Description of your dictionary. You should not remove that
<i><![CDATA[ ... ]]></i> tag, because it lets you to write
any text inside using even XML (HTML) tags like <i>1 + 1 <
1</i> or <i><myemail@abcdef.tdl></i>
</td>
</tr>
</table>
<p>
The last file you need is an <i>index</i> file. This file contains
index table of the dictionary describing in what position what letter
begins. Index makes search <i>a lot faster</i>.
</p>
<p>
I do not recommend writing index file using your fingers and the
keyboard :), so we will use OpenDict to make one for ourselves. Lets
now make a directory tree containing these files and directories:
</p>
<pre>
mydict.dwa/
|
+-- conf/
| |
| +-- config.xml
|
+-- data/
|
|
+-- file/
|
+-- mydict.dwa
</pre>
<p>
As you see, the root direcory is called <i>mydict.dwa</i>, the same as
dictionary file is called. This is <i>the rule</i>. Now move that
directory to the directory where all the plain dictionaries are
located. On my machine I would do:
</p>
<pre>
mjoc@kumo:~/tmp/dict-factory$ <i>mv mydict.dwa/ ~/.opendict/dictionaries/plain/</i>
</pre>
<p>
After that you should start OpenDict and load the dictionary you've
just made. If everything goes well, you will be informed about
reindexing the dictionary. Press <i>OK</i> and, if everything goes
well, you will have index.xml file located at data/ directory. On my
machine the full path would be
<i>/home/mjoc/.opendict/dictionaries/plain/mydict.dwa/data/index.xml</i>.
Now the directory tree look in a way like that:
</p>
<pre>
mydict.dwa/
|
+-- conf/
| |
| +-- config.xml
|
+-- data/
| |
| +-- index.xml
|
+-- file/
|
+-- mydict.dwa
</pre>
<p>
Now we have all the files needed. They are located at $DICTDIR. The
last step is to make a ZIP archive of that directory. Notice that that
ZIP file must contain the dictionary directory (i.e. mydict.dwa/)
itself, not only files inside it. To zip the directory, I would do:
</p>
<pre>
mjoc@kumo:~/tmp/dict-factory$ cd ~/.opendict/dictionaries/plain/
mjoc@kumo:~/.opendict/dictionaries/plain$ zip -r MyDictionary-0.1.zip mydict.dwa/
mjoc@kumo:~/.opendict/dictionaries/plain$ mv MyDictionary-0.1.zip ~
mjoc@kumo:~/.opendict/dictionaries/plain$ cd
</pre>
<p>
Now file <i>MyDictionary-0.1.zip</i> can be found at my home direcory
(/home/mjoc/). That's all. Now you have made a dictionary that can be
installed by everyone using OpenDict by selecting <i>Dictionaries ->
Install Dictionary from File</i> from the menu.
</p>
<h2>Simple Plugin Example</h2>
<p>
In this section I am going to give an example of simple OpenDict
plugin dictionary. Good example is a network dictionary plugin that
fetches translations from the web and processed them locally.
</p>
<p>
At first we have to create file called <i>plugin.xml</i>. The contents
of this file may be similar to this one:
</p>
<pre class="file-contents">
<?xml version="1.0" encoding="UTF-8"?>
<plugin type="dictionary">
<name>Network Test</name>
<version>0.1</version>
<authors>
<author name="Martynas Jocius" email="mjoc@akl.lt" />
</authors>
<module lang="Python">mydict.py</module>
<encoding>UTF-8</encoding>
<uses-word-list>False</uses-word-list>
<opendict-version>0.5.7</opendict-version>
<python-version>2.3</python-version>
<platforms>
<platform name="Linux" />
<platform name="BSD" />
<platform name="Windows" />
</platforms>
<description>
Example plugin dictioary. Does nothing.
</description>
</plugin>
</pre>
<p>
As you may already noticed, some XML tags are the same as in the
previous <i>config.xml</i> example. There is the description of new
tags, like <i>encoding</i>, <i>module</i>, etc.
</p>
<table>
<tr>
<th>XML tag</th>
<th>Description</th>
</tr>
<tr>
<td>module</td>
<td>Main <a href="http://www.python.org">Python</a> module file name.</td>
</tr>
<tr>
<td>encoding</td>
<td>Character encoding of the result string that plugin module
returns (examples include UTF-8, ISO-8859-15, etc)</td>
</tr>
<tr>
<td>uses-word-list</td>
<td>This should be set to <i>True</i> if dictionary needs word
list to be shown, <i>False</i> otherwise. If dictionary uses word
list, it must return a list of alternative words in addition with
translation string (<i>see below for more information</i>)</td>
</tr>
<tr>
<td>opendict-version</td>
<td>The lowest OpenDict version plugin requires, for example
0.5.1, 0.5.7, etc. This is important when plugin structure is
different from one that old OpenDict versions provide (for example 0.5.1
and 0.5.7 plugin structure differs a lot)</td>
</tr>
<tr>
<td>python-version</td>
<td>The lowest Python version that plugin requires.</td>
</tr>
<tr>
<td>python-version</td>
<td>The lowest Python version that plugin requires.</td>
</tr>
<tr>
<td>platforms</td>
<td>Parent node for <i>platform</i> tag.</td>
</tr>
<tr>
<td>platform</td>
<td>This tag with attribute <i>name</i> value X means that this
plugin is tested and works on platform X. For example, Linux, BSD,
MacOS. <i>Currently not used</i></td>
</tr>
</table>
<p>
Now we should write the main module in Python programming
language. Module file name is <i>mydict.py</i> as we called it in
<i>plugin.xml</i>. The following code might be correct OpenDict plugin:
</p>
<pre class="file-contents">
#!/usr/bin/env python
#
# MyDict 0.1
# Copyright (c) 2005 Matynas Jocius <mjoc@akl.lt>
#
# Simple plugin dictionary for OpenDict.
#
# This code is licensed under the GNU GPL v2.
#
"""
Simple OpenDict plugin module
"""
import sys
import httplib
import urllib
def init(libraryPath):
"""Return dictionary instance"""
sys.path.insert(0, libraryPath)
return MyDict()
class MyDict:
"""MyDict plugin class"""
def __init__(self):
"""Initialize variables"""
# This trick is needed to have accessible modules from
# OpenDict library
from lib import errortype, meta
self.errorModule = errortype
self.metaModule = meta
def search(self, word):
"""Search and return HTML code."""
print type(word), len(word)
result = self.metaModule.SearchResult()
try:
self.conn = httplib.HTTPConnection("mjoc.sig.lt")
self.conn.request("GET", "/index.html")
response = self.conn.getresponse()
data = response.read()
trans = "<html><body><h3>"
if word in data:
trans += "Word <i>%s</i> was found on " \
"http://mjoc.sig.lt/index.html" % word
else:
trans += "Word <i>%s</i> was not found on " \
"http://mjoc.sig.lt/index.html" % word
trans += "</h3></body></html>"
result.setTranslation(trans)
except Exception, e:
import traceback
traceback.print_exc()
result.setError(self.errorModule.INTERNAL_ERROR)
return result
return result
</pre>
<p>
<i>TODO: describe how to write the class and other details.</i>
</p>
<p>
To make an installable plugin file in ZIP archive format, move
<i>plugin.xml</i> and <i>mydict.py</i> into some directory
(i.e. <i>mydict-0.1</i>) and zip that directory. After performing
these actions your new OpenDict plugin will be ready to be installed.
</p>
<h2>Conclusion</h2>
<p>
<i>TODO: This document is very short and fuzzy. It must be improved in
the future.</i>
</p>
<div class="footer">Copyright © 2005
<a href="mailto:mjoc@akl.lt">Martynas Jocius</a>
-- Last modified: 2005-09-06 22:57
</div>
</body>
</html>
|