Merge branch 'master' of ssh://drop.maemo.org/git/mdictionary
[mdictionary] / www / howto.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3 <head>
4         <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
5         <meta http-equiv="content-language" content="EN" />
6         <meta name="description" content="Home page for mDictionary project -
7                     mobile multilingual dictionary for maemo.org platform
8                     (previously known as a 'WhiteStork')" />
9         <meta name="keywords" content="mdictionary whitestork maemo n770
10                     n800 n810 dictionary xdxf stardict mobile linux comarch" />
11         <meta name="language" content="English" />
12         <meta name="owner" content="ComArch S.A." />
13         <meta name="copyright" content="ComArch, 2006-2007. All rights Reserved."/>
14
15         <link rel="shortcut icon" href="images/favicon.png" type="image/x-icon"></link>
16         <link rel="stylesheet" href="styles/main.css" type="text/css"></link>
17         <!--[if IE 6]>
18                 <link rel="stylesheet"
19                       type="text/css"
20                       href="styles/main_ie.css" />
21
22                 <script src="scripts/pngfix.js" type="text/javascript"></script>
23         <![endif]-->
24         <script language="JavaScript" src="scripts/javascripts.js" ></script>
25
26         <title>
27                 mDictionary - multilingual dictionary for Maemo
28         </title>
29 </head>
30 <body>
31 <div id="webContainer">
32         <div id="topBar">
33                 <img src="images/mLogo_ie24.png" style="float:left;"></img>
34 <!--    <div class="installs">
35                 INSTALL:
36                 <a href="files/mdictionary.install"
37                    class="install" style="margin-top:4px;"
38                    title="Click to install mDictionary on OS2006"><span>OS2006</span>
39                 </a>
40                 <a href="files/mdictionary.install"
41                    class="install" style="clear:both; margin-top:4px;"
42                    title="Click to install mDictionary on OS2007"><span style="letter-spacing:0px;">OS2007</span>
43                 </a>
44                 <a href="files/mdictionary2008.install"
45                    class="install" style="clear:both; margin-top:4px;"
46                    title="Click to install mDictionary on OS2008"><span style="letter-spacing:0px;">OS2008</span>
47                 </a>
48                 <span style="clear:both;text-align:center;display:block;font-size:9px;"><a href="howto.html" style="font-size:9px;text-decoration:none;">(read How To... first)</a></span>
49         </div>
50 -->             <div style="display:block;height:100px;">
51                         <p class="title">
52                                 mDictionary
53                         </p>
54                         <p class="description">
55                                 multilingual dictionary for <a href="http://www.maemo.org" target="_blank"><img align="top" border="0" src="images/maemo_logo.png" ></a>(N770, N800 &amp; N810)
56                         </p>
57                         <p class="description">
58                                 &nbsp; and <a href="http://www.meego.com" target="_blank"><img align="top" border="0" src="images/Meego.png" width="80" height="20" ></a> (N900 & netbook )
59                         </p>
60                 </div>
61                 <div id="topBarLinks">
62                         <a href="index.html" >Home</a>
63                         <a href="download.html">Download</a>
64                         <a href="qmlelements.html">QML Elements</a>
65                         <a href="howto.html" class="current">How to..</a>
66                         <a href="screen800.html">Screenshots</a>
67                         <a href="userguide.html">User Guide</a>
68                         <a href="faq.html">FAQ</a>
69                         <a href="devhowto.html">Development</a>
70                         <a href="contact.html">Contact</a>
71                 </div>
72         </div>
73         <div id="contentContainer">
74                 <h1>
75                         mDictionary Multilingual Dictionary Installation.
76                 </h1>
77                 <p>
78                         <strong>new mDictionary</strong> consists of three modules:
79                         <br /><br />
80                                 mdictionary - core application<br />
81                                 homescreen-widget - widget for desktop<br />
82                                 mdictionaryplugins - engines (for example: "mdictionary-stardict-plugin")<br />
83                         <br />
84                         All of them are located in different packages. Program needs to work only installation "mDictionary" package. Other packages only extends the functionality.
85                 </p>
86                 <p>
87                         <strong>old mDictionary</strong> consists of three modules:
88                         <br /><br />
89                                 mdictionary - core application<br />
90                                 mdictionarygui - the graphical user interface<br />
91                                 mdictionaryplugins - engines<br />
92                         <br />
93                         All of them are placed in one binary package - mDictionary.
94                 </p>
95
96                 <h1>
97                         MeeGo and Maemo instalation     
98                 </h1>
99                 <p>
100                         <li>Download the binary package from <a href="download.html" target="_blank">download </a>section </li>
101                         <li>Open the file manager and double click on downloaded file. </li>
102                         <li>Ignore all these warnings.</li>
103                 <p>
104
105                 <h1>
106                         Nokia N770 &amp; N800 &amp; N810 installation
107                 </h1>
108                 <h2 style="color:#953;text-align:center;">
109                         mDictionary installation steps for OS2008
110                 </h2>
111                 <p> 
112                 Mdictionary requires libbz2 library to be able to work. To install libbz library repository with libbz package should be added to application catalogue and „Red pill mode” should be activated.
113                 To add the repository with libbz2 package you can click on <a href="files/chinook.install">INSTALL</a> or perform following steps to add repository manually:
114                 <ol style="margin-left: 25px; margin-top: -5px margin-bottom: 5px;">
115                 <li>Go to Main Menu -> Setting -> Applications manager</li>
116                 <li>Go to Tools -> Application catalogue...</li>
117                 <li>Click New and enter:
118                                 <br />Catalogue name: Maemo Chinook
119                                 <br />Web address: http://repository.maemo.org
120                                 <br />Distribution: chinook
121                                 <br />Components: free non-free
122                                 <br />Be sure that this repository was not added before !
123                 </li>
124                 </ol>
125                 
126                 <br />To activate „Red pill mode” follow this steps:
127                 <ol style="margin-left: 25px; margin-top: 10px; margin-bottom: -5px;">
128                 <li>Go to Main Menu -> Setting -> Applications manager</li>
129                 <li>Go to Tools -> Application catalogue...</li>
130                 <li>Click New and enter matrix into Web address (remember to remove http:// entry)</li>
131                 <li>Click on Cancel. Question about pill should be displayed. Click on Red. To deactivate „Red pill mode” repeat above steps but in last step Click on Blue.</li>
132                 </ol>
133                 <br />Now click on Browse installable applications go to Tools->Search and enter libbz2 into Search word field and click OK. Click and install  libbz2-1.0 package.
134                 <br />After successful installation of libz2 package you should be able to install mdctionary without any problems by clicking on <a href="files/mdictionary2008.install">INSTALL</a>.<br />
135                 </p>
136                 
137                 <h2 style="color:#953;text-align:center;">
138                         mDictionary installation steps for OS2007 and OS2006
139                 </h2>
140                 <p>
141                         In order to install our application click <a href="files/mdictionary.install">INSTALL</a> or make the following steps:<br />
142                 <ol style="margin-left: 25px;">
143                 <li>Download the binary package from our download section</li>
144                 <li>Open the file manager and double click on downloaded file.</li>
145                 <li>A window will pop up notifying you that the package hasn't been verified by Nokia. In order to install the dictionary you will have to ignore these warnings.</li>
146                 </ol>
147                 </p>
148
149                 <h1>
150                         Scratchbox installation
151                 </h1>
152                         - Download the binary package from our download section
153                 <br /> - Log into scratchbox and become root by issuing the command: <span class="code">fakeroot su</span>
154                 <br /> - Install mDictionary package mentioned above by using: <span class="code">dpkg -i package_name</span>.<br />
155                 <br />
156
157                 <p>
158                         Our application allows for using various parsing engines, so that different dictionary formats could be used. We have included a XDXF and StarDict format parsing engine to provide an example and to make it usable.
159                 </p>
160
161                 <h1>
162                         Installing new dictionaries
163                 </h1>
164
165                 <p>
166                         Dictionaries in mDictionary are files containing the words database. For now we have only included a package containing a XDXF and StarDict 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 and StarDict formats are concerned, they can be found under this address:
167                         <a href="http://xdxf.revdanica.com/down">http://xdxf.revdanica.com/down </a>
168                 </p>
169                 <p>
170                         Place the dictionary file wherever you wish, however it has to be reachable by the application. In order to register new file in our dictionary, choose the Load Dictionary option from the application menu. To make <u>XDXF</u> dictionaries to work faster, you can optimize them (a special dialog will lead you through this procces). <u>StarDict dictionaries do not require optimalization</u> (there is no difference if you enable optimizing or not). 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.
171                 </p>
172                 <p>
173                         In order to unregister dictionary from mDictionary, use the Remove Dictionary option. This will not erase the file however, you will have to do it manually if you want to remove it from your device.
174                 </p>
175                 <h1>
176                         Uninstalling the application
177                 </h1>
178
179                 <p>
180                         Uninstalling mDictionary can be performed using the Application Manager. Enter the Show Installed Applications item and uninstall  mdictionary package.
181                 </p>
182         </div>
183         <div id="footer">
184                         <p>Copyright &copy; 2006 - 2008 ComArch S.A.</p>
185                         <br>
186                         <a href="http://www.comarch.com"><img src="images/comarch.png"
187                              alt="ComArch Information Technology"
188                              width="150px"
189                              height="36px"
190                                  border="0"
191                                  >
192                         </a>
193                 </div>
194         </div>
195 </div>
196 <br>
197 </body>
198 </html>