* updating screenshots on User Guide page.
[mdictionary] / howto.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-type" content="text/html; charset=iso-8859-2">
5 <title>WhiteStork Multilingual Dictionary</title>
6 <link rel="Stylesheet" type="text/css" href="./css/style.css">
7 </head>
8 <body>
9 <table id="top">
10 <tr><td colspan="2"><center><img src="./images/label2.png"></center></td></tr>
11 <tr>
12         <td id="left_border">&nbsp;</td>
13         <td id="center">
14                 <table id="body">
15                 <tr>
16                         <td id="left">
17                                 <table class="menu">
18                                 <tr><th>Menu</th></tr>
19                                 <tr>
20                                         <td>
21                                                 <a href="index.html">About</a><br>
22                                                 <a href="licence.html">Licence</a><br>
23                                                 <a href="howto.html">How to...</a><br>
24                                                 <a href="devhowto.html">For developers</a><br>
25                                                 <a href="faq.html">FAQ</a><br>
26                                                 <a href="http://mdictionary.garage.maemo.org/userguide/" target="blank">User Guide</a><br>
27                                                 <a href="screen.html">Screenshots</a><br>
28                                                 <a href="download.html">Download</a><br>
29                                                 <a href="contact.html">Contact us</a><br>
30                                         </td>
31                                 </tr>
32                                 <tr><th class="footer">&nbsp;</th></tr>
33                                 </table>
34                                 <br>
35                                 <br>
36                         </td>
37                         <td id="content">
38                                 <table class="menu">
39                                 <tr><th>&nbsp;</th></tr>
40                                 <tr>
41                                         <td class="content">
42                                                 <p><b>WhiteStork Multilingual Dictionary Installation.</b><br><br> 
43                                                 This piece of software consists of three binary packages:
44                                                 <ul><li>engine_xdxf - XDXF dictionary format parsing engine</li>
45                                                 <li>whitestork - core application</li>
46                                                 <li>whitestorkgui - the graphical user interface</ul></p>
47                                                 <p><b>Nokia 770 installation<br><br></b>
48                                                 In order to install our application make the following steps:<br>
49 <ul><b>1.</b> Download the binary packages from our download section<br>
50 <b>2.</b> Open the file manager and double click on each of the downloaded files in order they were mentioned above.<br>
51 <b>3.</b> A window will pop up notifying you that the packages haven't been verified by Nokia. In order to install the dictionary you will have to ignore these warnings.<br>
52 <b>4.</b> The whitestorkgui package is distributed under commercial license, so you will have to agree for the license terms, otherwise the program will not run.<br></ul></p>
53 <p><b> Scratchbox installation<br></b>
54  
55 <ul><b>1.</b> Download the binary packages from our download section<br>
56 <b>2.</b> Log into scratchbox and become root by issuing the command:
57 fakeroot su<br>
58 <b>3.</b> Install each WhiteStork package in order mentioned above by using: 
59 <b><i>dpkg -i package_name</i></b><br>
60 <b>4.</b> The whitestorkgui package is distributed under commercial license, so you will have to agree for the license terms, otherwise the program will not run<br></ul></p>
61 <p>Our application allows for using various parsing engines, so that different dictionary formats could be used. We have included a XDXF format parsing engine to provide an example and to make it usable.<br></p>
62
63 <p><b>Installing new dictionaries</b>
64  
65 <ul>Dictionaries in WhiteStork are files containing the words database. For now we have only included a package containing a XDXF format parser. You are welcome to contribute new parsing engines and we hope you will find our API documentation useful in development process. In order to add new dictionaries you'll have to download files containing the words database and make sure you have the appropriate parsing engine installed. As far as the XDXF format is concerned, they can be found under this address: <a href="http://xdxf.revdanica.com/down/">http://xdxf.revdanica.com/down/</a>
66 Place the dictionary wherever you wish, however it has to be reachable by our application. In order to register new file in our dictionary, choose the Load Dictionary option from the application menu. To make it usable you'll have to optimize it, otherwise you won't be able to use it in your searches. If you would like to exclude a dictionary from searching, use the Select Dictionary option from the menu and check/uncheck a box next to your desired file.
67 In order to unregister dictionary from our application, use the Remove Dictionary option. This will not erase the file however, you will have to do it manually.</ul></p>
68 <p><b>Uninstalling the application</b><br>
69  
70 <ul>Uninstalling WhiteStork can be performed using the Application Manager. Enter the Show Installed Applications item and uninstall the following packages: whitestorkgui, whitestork and engine_xdxf.<ul><p>
71                                                 
72                                         </td>
73                                 </tr>
74                                 <tr><th class="footer">&nbsp;</th></tr>
75                                 </table>
76                         </td>
77                 </tr>
78                 <tr><td colspan="2" id="footer_border">&nbsp;</td></tr>
79                 <tr><td colspan="2" id="footer">&copy; 2006 <a href="#top">WhiteStork Multilingual Dictionary</a></td></tr>
80                 </table>
81         </td>
82         <td id="right_border">&nbsp;</td>
83 </tr>
84 </table>
85
86 </body>
87 </html>