vcs.maemo.org Git - mdictionary/blob - www/userguide.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 defer 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">How to..</a>
  66                         <a href="screen800.html">Screenshots</a>
  67                         <a href="userguide.html" class="current">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
  75                 <h1 class="centered">
  76                         mDictionary Multilingual Dictionary
  77                 </h1>
  78                 <center><img class="centered" src="images/mLogo.png"></img></center>
  79                 <p class="centered">
  80                         - user guide -
  81                 </p>
  82
  83
  84 <div class="faq_question">
  85         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
  86         Installation.
  87         <div class="faq_answer">
  88                 <p>
  89                 <b>mDictionary</b> Multilingual Dictionary has been built with three modules, dependant of each other: mDictionary (internal application management), mDictionaryGui (graphical user interface) and mDictionaryPlugins (parsing engines). Since mDictionary 1.0 has been released, they are placed in one package - mDictionary.
  90                 </p>
  91                 <p>
  92                 In order to install our application make the following steps:
  93                 </p>
  94                 <ul>
  95                         <li>
  96                                 Download the binary package from mDictionary website -
  97                                 <a href="https://garage.maemo.org/frs/?group_id=58">
  98                                 download section
  99                                 </a>
 100                         </li>
 101                         <li>
 102                                 Open the file manager and double click on downloaded file.
 103                         </li>
 104                         <li>
 105                                 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.
 106                         </li>
 107                 </ul><br />
 108                 <p>or if you are using OS2006 or OS2007 just simply click <a href="files/mdictionary.install">INSTALL</a> from mDictionary webpage.
 109                 If you are using OS2008 see <a href="howto.html">How to...</a> section of mDictionary webpage</p>
 110                 <p>
 111                 During an installation process you will be asked for pointing the location where mDictionary should be placed in an application menu. The default location is <i>Extra</i> submenu.
 112                 </p>
 113         </div>
 114 </div>
 115
 116
 117 <div class="faq_question">
 118         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 119         Running Application.
 120         <div class="faq_answer">
 121                 <p>If the installation process is completed you can start using your mDictionary!</p>
 122                 <p>To run application simply click mDictionary activator from your Task Navigator and enjoy the pleasure!</p>
 123                 <p>If you install DesktopWidget in maemo system you can use widget in desktop. Click tool button with logo of mDictionary to start application.</p>
 124         </div>
 125 </div>
 126
 127 <div class="faq_question">
 128         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 129         Work with many different dictionaries.
 130         <div class="faq_answer">
 131                 <p>
 132                         <strong> New version </strong>
 133                 </p>
 134                         mDictionary gives user a possibility to explore a different kinds of dictionary files. You can use a couple of them at the same time or load them into the mDictionary application and keep them in case they are useful. So far there are two engines implemented, which allow for use of <b>XDXF</b> and <b>StarDict</b> dictionaries.
 135                 </p>
 136
 137                 <p>
 138                 <ul>
 139                         <div class="image">
 140                                 <img src="images/dict.png"></img>
 141                         </div>
 142
 143                         <li>
 144                                 Select and unselect dictionary
 145                         </li>
 146                         <p>
 147                                 To select a dictionary from which you want to use click "dictionarys" in the top menu. You'll see a list of current dictionaries, and by the checkbox for each name you can                                     select or unselect dictionary.
 148                         </p>
 149                         <li>
 150                                 Add dicionaries
 151                         </li>
 152                         <p>
 153                                 To add new dictionary click "dictionarys" in the top menu. Click "add", select the type (eg xdxf), select the location of the dictionary and then save the settings.
 154                                 The new dictionary will appear in the list.
 155                         <p/>
 156                         <li>
 157                                 Remove dictionary
 158                         </li>
 159                         <p>
 160                                 To remove dictionary click "dictionarys" in the top menu. Click on name of dictionary you want remove, then click "delete" button. Accept change and save settings.
 161                                 A dictionary should disappear from the list
 162                         <p/>
 163                         <li>
 164                                 Dictionary settings
 165                         </li>
 166                         <p>
 167                                 Different dictionaries have to choose your own settings, for example: xdxf has the ability to optimize and avoid accents in words
 168                                 To change settings click "dictionarys" in the top menu. Click on name of dictionary you want change settings,then click "settings" button.
 169                         <p/>
 170                 <p>
 171                         <strong> Old version </strong>
 172                 </p>
 173                 <p>
 174                 mDictionary gives user a possibility to explore a different kinds of dictionary files. You can use a couple of them at the same time or load them into the mDictionary application and keep them in case they are useful. So far there are two engines implemented, which allow for use of <b>XDXF</b> and <b>StarDict</b> dictionaries.
 175                 </p>
 176                 <div class="image">
 177                         <img src="images/_800_menu_dictionaries.png"></img>
 178                         The Dictionaries Submenu<br><br>
 179                 </div>
 180
 181                 <ul>
 182                         <li>
 183                                 Load dictionary
 184                         </li>
 185                         <p>If you want to load a new dictionary file to your mDictionary you have to download and unpack proper files first. If you don't have any files with dictionaries you can find some <a href="http://xdxf.revdanica.com/down/">here</a>. After you have unpacked files, please create a folder with a proper name on your device and put there dictionary files. <u>It is strongly recommended to put files into a folder with a name of the dictionary. Without that your mDictionary cannot work properly.</u><br> If you have finished the steps above, run mDictionary and choose <i>Load dicionary</i> from <i>Dictionaries</i> submenu in application menu.</p>
 186                         <p>Developers laid on compatibility mDictionary with various file types. mDictionary can load a dictionary from .xdxf files, .idx, .dict.dz or .ifo (StarDict files) or even .tar.bz2.</p>
 187                         <div class="image">
 188                                 <img src="images/_800_load_dictionary.png"></img>
 189                                 Dialog window for loading a new dictionary file<br><br>
 190                         </div>
 191
 192                         <li>
 193                                 Select dicionaries
 194                         </li>
 195                         <p>
 196                                 There is possibility to use more than one dictionary at the same time. To do this, you just have to choose <i>Select dictionaries</i> from <i>Dictionaries</i> submenu and tick the dictionaries, which you would like to search in.
 197                         </p>
 198                         <p>
 199                                 Anytime, you can select Bookmarks as an active dictionary as well. Than you will be able to search, not only in XDXF or StarDict dictionaries, but also in your own, Bookmark database.
 200                         </p>
 201                         <div class="image">
 202                                 <img src="images/_800_select_dictionaries.png"></img>
 203                                 Dialog window for selecting active dictionaries<br><br>
 204                         </div>
 205                         <li>
 206                                 Remove dictionaries
 207                         </li>
 208                         <p>
 209                                 If you decide that you don't need one of the dictionaries anymore, you can delete it from the application. It is a very easy process, but it does not mean, that a dictionary file will be erased from your device.
 210                         </p>
 211                         <p>
 212                                 To remove a loaded dictionary from your mDictionary, please open <i>Dictionaries</i> submenu from an Application Menu and choose <i>Remove Dictionaries</i>. The special dialog window will pop up and lead you through the removing process step by step.
 213                         </p>
 214                         <div class="image">
 215                                 <img src="images/_800_remove_dictionaries.png"></img>
 216                                 Dialog window for removing dictionaries<br><br>
 217                         </div>
 218
 219
 220
 221                         <li>
 222                                 Optimize dictionaries
 223                         </li>
 224                         <p>
 225                                 If you load a new XDXF dictionary file, it is a good idea to optimize it. It means, that a special cache file will be created in order to make searching much faster. After loading a dictionary file you will be asked whether to optimize a new dictionary or not. If you decide not to optimize it, there is always a possibility to do this later. By choosing <i>Optimize dictionaries</i> from <i>Dictionaries</i> submenu you can check which dictionaries have not been optimized or simply optmize them.<br />
 226                                 There is no possibility to optimize StarDict dictionaries due to a special mechanism, which is build in StarDict dictionaries (enabling this option for StarDict dictionaries does not change anything).
 227                         </p>
 228                 </ul>
 229         </div>
 230 </div>
 231
 232 <div class="faq_question">
 233         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 234         User Bookmarks.
 235         <div class="faq_answer">
 236
 237         <p>
 238                 <strong> New version </strong>
 239         </p>
 240                 <div class="image">
 241                         <img src="images/bookmark.png"></img>
 242                 </div>
 243                 <li>
 244                         Add Bookmark
 245                 </li>
 246                         <p>To add word to bookmark you have to click on the star next to name of word in the search list.</p>
 247                 <li>
 248                         Show Bookmark
 249                 </li>
 250                 <p>To show all word in bookmark click to "bookmark" in the top menu, and select "show all". </p>
 251                 <li>
 252                         Remove all Bookmark
 253                 </li>
 254                 <p>To remove all words from bookmark click "remove all" in the same pleace where was "show all".</p>
 255                 <li>
 256                         Remove one Bookmark
 257                 </li>
 258                 <p>     If you want remove only one word from bookmark you can show all, and unselect star in the list of words</p>
 259         <p>
 260                 <strong> Old version </strong>
 261         </p>
 262
 263         <ul>
 264                 <li>Open/Close Bookmarks</li>
 265                 <p>Bookmarks have been provided to make user feel more comfortable with the application. This module works very similar to the bookmarks which can be seen in any Web Browser application. Bookmarks are treated in the same way as other dictionaries. You can browse them anytime, search in, add or remove words.</p>
 266                 <p>When you choose <i>Open bookmarks</i> from <i>Bookmarks</i> submenu, application will switch into a bookmarks mode. Than you can browse bookmarks. If you perform a search, you will only see the words which have been found. If you want to reload list of all words from bookmarks, simply type * (asterisk) into the find toolbar textbox and start a search. You can use wildcards as well.</p>
 267
 268                         <div class="image">
 269                                 <img src="images/_800_menu_bookmarks.png"></img>
 270                                 The Bookmarks submenu<br><br>
 271                         </div>
 272
 273                 <p>If you want to leave bookmark mode choose <i>Close bookmark</i> from <i>Boomarks</i> menu.<br></p>
 274                 <li>
 275                         Add Bookmark
 276                 </li>
 277                 <p>To add a word to the bookmarks, select it from the words list and choose <i>Add bookmark</i> from <i>Bookmarks</i> submenu or from the context sensitive menu.</p>
 278                         <div class="image">
 279                                 <img src="images/_800_add_bookmark.png"></img>
 280                                 Adding bookmark<br><br>
 281                         </div>
 282
 283                 <li>
 284                         Remove Bookmark
 285                 </li>
 286                 <p>To remove a word from bookmarks, you have to switch into Bookmark mode (<i>Open bookmark</i>). Then select a word from words list which you would like to remove and choose <i>Remove bookmark</i> from <i>Bookmarks submenu</i>.</p>
 287                         <div class="image">
 288                                 <img src="images/_800_remove_bookmark.png"></img>
 289                                 Removing bookmark<br><br>
 290                         </div>
 291                 <p>Bookmarks have been implemented using Berkley DB. In case of any problems with Bookmarks (i.e. Bookmark's menu is dimmed, or note about error is displayed) please double check berkley db package presence on your device.</p>
 292         </ul>
 293         </div>
 294 </div>
 295
 296
 297 <div class="faq_question">
 298         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 299         Exchange Data With Other Applications.
 300         <div class="faq_answer">
 301
 302
 303                 <p>
 304                         mDictionary gives user a wide range of possibilities to use <b>clipboard</b>. You can not only copy translation to the clipboard and use it in another application but also paste a text from the clipboard into a find toolbar textbox so that searching is easier than ever!
 305                 </p>
 306
 307                 <p>
 308                         <strong> New version </strong>
 309                 </p>
 310                 <p>
 311                         In new version operations such as copying,selecting all, searching can be used by click on the pictures in the bottom left corner of the translation
 312                 </p>
 313                 <div class="image">
 314                         <img src="images/select.png"></img>
 315                         <br/>
 316                 </div>
 317
 318                 <p>
 319                         <strong> Old version </strong>
 320                 </p>
 321
 322                 <div class="image">
 323                         <img src="images/_800_menu_edit.png"></img>
 324                         The Edit submenu<br><br>
 325                 </div>
 326                 <ul>
 327                         <li>
 328                                 Copy please ...
 329                         </li>
 330                         <p>If you want to copy selected text from translation area simply choose <i>Copy</i> from <i>Edit submenu</i> in application menu or in context sensitive menu.</p>
 331
 332                         <li>
 333                                 Paste
 334                         </li>
 335                         <p>If you want to paste a text from the clipboard into a find toolbar textbox choose <i>Paste</i> from <i>Edit</i> submenu in application menu or in context sensitive menu.</p>
 336
 337                         <li>
 338                                 Could you select this text for me?
 339                         </li>
 340                         <p>It is very easy to select text in the translation area. Please, double tap on a word which you want to select (one word will be selected) or use double tap and drag to select any text.</p>
 341                         <p>You can also use <i>Select All</i> option from <i>Edit</i> submenu in application on context senstitive menu. This option allows for selecting the whole translation.</p>
 342                 </ul>
 343
 344         </div>
 345 </div>
 346
 347
 348 <div class="faq_question">
 349         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 350         Searching ...
 351         <div class="faq_answer">
 352                 <ul>
 353                         <li>
 354                                 History
 355                         </li>
 356                         <p>mDictionary provides a search history. It means than anytime you select a word on a words list and call for translation of the word, it is added to the history. Than, you can browse it. History stores your previous search results. It is a very useful feature, similar to the browser.</p>
 357                         <p>To go to history you can choose buttons from a find toolbar. Green arrows placed between <i>search</i> and <i>stop</i> button are appropriately <i>back</i> and <i>forward</i> in the history. </p>
 358
 359                         <li>
 360                                 Search a word
 361                         </li>
 362                         <p>To start searching process you have to write word in find toolbar, and entry or click a <i>Search button</i></p>
 363
 364                         <li>
 365                                 Stop!
 366                         </li>
 367                         <p>If a search process takes too long or you made mistake in a pattern, you can stop searching process. Click <i>Stop button</i> on a toolbar</p>
 368                 </ul>
 369         </div>
 370 </div>
 371
 372
 373 <div class="faq_question">
 374         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 375         About ...
 376         <div class="faq_answer">
 377                 <p>You can click <i>About ...</i> in application menu to learn some details about mDictionary.</p>
 378                 <p>If you want more informations, please visit <a href="http://mdictionary.garage.maemo.org/">mDictionary's website</a> or see <a href="https://garage.maemo.org/projects/mdictionary/">mDictionary project</a> on <a href="https://garage.maemo.org/">garage.maemo.org</a>.</p>
 379         </div>
 380 </div>
 381
 382
 383 <div class="faq_question">
 384         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 385                 Uninstallation
 386         <div class="faq_answer">
 387
 388                 <p>If you are sure, you are not going to use mDictionary in the future and you want to remove mDictionary from your device forever, you can unistall an application.</p>
 389                 <p>Uninstalling mDictionary can be performed using the Application Manager. Enter the Show Installed Applications item and uninstall the mDictionary package.</p>
 390
 391         </div>
 392 </div>
 393
 394
 395         <div id="footer">
 396                         <p>Copyright &copy; 2006 - 2008 ComArch S.A.</p>
 397                         <br>
 398                         <a href="http://www.comarch.com"><img src="images/comarch.png"
 399                              alt="ComArch Information Technology"
 400                              width="150px"
 401                              height="36px"
 402                                  border="0"
 403                                  >
 404                         </a>
 405                 </div>
 406         </div>
 407 </div>
 408 <br>
 409 </body>
 410 </html>