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                 </div>
  58                 <div id="topBarLinks">
  59                         <a href="index.html">Home</a>
  60                         <a href="download.html">Download</a>
  61                         <a href="howto.html">How to..</a>
  62                         <a href="screen800.html">Screenshots</a>
  63                         <a href="userguide.html" class="current">User Guide</a>
  64                         <a href="faq.html">FAQ</a>
  65                         <a href="devhowto.html">Development</a>
  66                         <a href="contact.html">Contact</a>
  67                 </div>
  68
  69         </div>
  70         <div id="contentContainer">
  71
  72                 <h1 class="centered">
  73                         mDictionary Multilingual Dictionary
  74                 </h1>
  75                 <center><img class="centered" src="images/mLogo.png"></img></center>
  76                 <p class="centered">
  77                         - user guide -
  78                 </p>
  79
  80
  81 <div class="faq_question">
  82         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
  83         Installation.
  84         <div class="faq_answer">
  85                 <p>
  86                 <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.
  87                 </p>
  88                 <p>
  89                 In order to install our application make the following steps:
  90                 </p>
  91                 <ul>
  92                         <li>
  93                                 Download the binary package from mDictionary website -
  94                                 <a href="https://garage.maemo.org/frs/?group_id=58">
  95                                 download section
  96                                 </a>
  97                         </li>
  98                         <li>
  99                                 Open the file manager and double click on downloaded file.
 100                         </li>
 101                         <li>
 102                                 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.
 103                         </li>
 104                 </ul><br />
 105                 <p>or if you are using OS2006 or OS2007 just simply click <a href="files/mdictionary.install">INSTALL</a> from mDictionary webpage.
 106                 If you are using OS2008 see <a href="howto.html">How to...</a> section of mDictionary webpage</p>
 107                 <p>
 108                 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.
 109                 </p>
 110         </div>
 111 </div>
 112
 113
 114 <div class="faq_question">
 115         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 116         Running Application.
 117         <div class="faq_answer">
 118                 <p>If the installation process is completed you can start using your mDictionary!</p>
 119                 <p>To run application simply click mDictionary activator from your Task Navigator and enjoy the pleasure!</p>
 120         </div>
 121 </div>
 122
 123 <div class="faq_question">
 124         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 125         Work with many different dictionaries.
 126         <div class="faq_answer">
 127                 <p>
 128                 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.
 129                 </p>
 130                 <div class="image">
 131                         <img src="images/_800_menu_dictionaries.png"></img>
 132                         The Dictionaries Submenu<br><br>
 133                 </div>
 134
 135                 <ul>
 136                         <li>
 137                                 Load dictionary
 138                         </li>
 139                         <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>
 140                         <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>
 141                         <div class="image">
 142                                 <img src="images/_800_load_dictionary.png"></img>
 143                                 Dialog window for loading a new dictionary file<br><br>
 144                         </div>
 145
 146                         <li>
 147                                 Select dicionaries
 148                         </li>
 149                         <p>
 150                                 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.
 151                         </p>
 152                         <p>
 153                                 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.
 154                         </p>
 155                         <div class="image">
 156                                 <img src="images/_800_select_dictionaries.png"></img>
 157                                 Dialog window for selecting active dictionaries<br><br>
 158                         </div>
 159                         <li>
 160                                 Remove dictionaries
 161                         </li>
 162                         <p>
 163                                 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.
 164                         </p>
 165                         <p>
 166                                 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.
 167                         </p>
 168                         <div class="image">
 169                                 <img src="images/_800_remove_dictionaries.png"></img>
 170                                 Dialog window for removing dictionaries<br><br>
 171                         </div>
 172
 173
 174
 175                         <li>
 176                                 Optimize dictionaries
 177                         </li>
 178                         <p>
 179                                 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 />
 180                                 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).
 181                         </p>
 182                 </ul>
 183         </div>
 184 </div>
 185
 186 <div class="faq_question">
 187         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 188         User Bookmarks.
 189         <div class="faq_answer">
 190         <ul>
 191                 <li>Open/Close Bookmarks</li>
 192                 <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>
 193                 <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>
 194
 195                         <div class="image">
 196                                 <img src="images/_800_menu_bookmarks.png"></img>
 197                                 The Bookmarks submenu<br><br>
 198                         </div>
 199
 200                 <p>If you want to leave bookmark mode choose <i>Close bookmark</i> from <i>Boomarks</i> menu.<br></p>
 201                 <li>
 202                         Add Bookmark
 203                 </li>
 204                 <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>
 205                         <div class="image">
 206                                 <img src="images/_800_add_bookmark.png"></img>
 207                                 Adding bookmark<br><br>
 208                         </div>
 209
 210                 <li>
 211                         Remove Bookmark
 212                 </li>
 213                 <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>
 214                         <div class="image">
 215                                 <img src="images/_800_remove_bookmark.png"></img>
 216                                 Removing bookmark<br><br>
 217                         </div>
 218                 <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>
 219         </ul>
 220         </div>
 221 </div>
 222
 223
 224 <div class="faq_question">
 225         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 226         Exchange Data With Other Applications.
 227         <div class="faq_answer">
 228                 <p>
 229                         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!
 230                 </p>
 231                 <div class="image">
 232                         <img src="images/_800_menu_edit.png"></img>
 233                         The Edit submenu<br><br>
 234                 </div>
 235                 <ul>
 236                         <li>
 237                                 Copy please ...
 238                         </li>
 239                         <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>
 240
 241                         <li>
 242                                 Paste
 243                         </li>
 244                         <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>
 245
 246                         <li>
 247                                 Could you select this text for me?
 248                         </li>
 249                         <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>
 250                         <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>
 251                 </ul>
 252         </div>
 253 </div>
 254
 255
 256 <div class="faq_question">
 257         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 258         Change view of the application.
 259         <div class="faq_answer">
 260                 <p>
 261                         mDictionary provides couple of different views so that user can feel comfortable and choose the one that fits the best.
 262                 </p>
 263                 <div class="image">
 264                         <img src="images/_800_menu_view.png"></img>
 265                         The View submenu<br><br>
 266                 </div>
 267                 <ul>
 268                         <li>
 269                                 Translation only!
 270                         </li>
 271                         <p>There is possibility to hide words list anytime user wants. To do this, click green arrow in a left corner or choose <i>Hide words</i> list from <i>View</i> submenu in application menu.</p>
 272                         <div class="image">
 273                                 <img src="images/_800_hide_words_list.png"></img>
 274                                 Words list is hidden<br><br>
 275                         </div>
 276
 277
 278                         <li>
 279                                 Magnifying ...
 280                         </li>
 281                         <p>Sometimes font in translation area is too small to read it. In that case you can use <i>Zoom in</i> option. You can call it from <i>View</i> submenu in application menu, from context sensitive menu or just simply use hardware keys. If you don't want to magnify text anymore, choose <i>Zoom out</i></p>
 282
 283                         <li>
 284                                 Fullscreen mode
 285                         </li>
 286                         <p>mDictionary can work in two modes: normal and fullscreen. By default, mDictionary runs in normal mode. Anytime you can switch it into fullscreen mode by choosing <i>Fullscreen</i> option from <i>View</i> submenu or by using hardware keys.</p>
 287                 </ul>
 288
 289         </div>
 290 </div>
 291
 292 <div class="faq_question">
 293         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 294         Searching ...
 295         <div class="faq_answer">
 296                 <ul>
 297                         <li>
 298                                 History
 299                         </li>
 300                         <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>
 301                         <p>To go to the previously found word you have to choose <i>Find previous</i> option from <i>Search</i> submenu. It is dimmed if there are no words in the history. If you are browsing history, and you decide to go forward - choose <i>Find next</i> from <i>Search</i> submenu. It is dimmed if there are no words available as well.</p>
 302
 303                         <p>You can also choose buttons from a find toolbar, instead of using application menu. 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>
 304
 305                         <li>
 306                                 Search a word
 307                         </li>
 308                         <p>To start searching process you have to call search function. There are two possibilities to do this. After you type a pattern into a find toolbar entry, click a <i>Search button</i> places on a toolbar (next to the entry). You can also go to the application menu and choose <i>Find</i> from <i>Search</i> submenu. Finally, you can use harware key ("Go").</p>
 309
 310                         <li>
 311                                 Stop!
 312                         </li>
 313                         <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 or <i>Stop</i> option from <i>Search</i> submenu.</p>
 314
 315                 </ul>
 316         </div>
 317 </div>
 318
 319
 320 <div class="faq_question">
 321         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 322         Context Sensitive Menu
 323         <div class="faq_answer">
 324                 <p>If you want to use context sensitive menu, please tap and hold your stylus in the translation area. If you are running mDictionary under Scratchbox, you can use left or right mouse click and hold.</p>
 325                 <div class="image">
 326                         <img src="images/_800_context_menu.png"></img>
 327                         Context Sensitive Menu
 328                 </div>
 329         </div>
 330 </div>
 331
 332 <div class="faq_question">
 333         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 334         About ...
 335         <div class="faq_answer">
 336                 <p>You can click <i>About ...</i> in application menu to learn some details about mDictionary.</p>
 337                 <div class="image">
 338                         <img src="images/_800_about.png"></img>
 339                         About Dialog
 340                 </div>
 341                 <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>
 342         </div>
 343 </div>
 344
 345
 346 <div class="faq_question">
 347         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 348                 Closing the application
 349         <div class="faq_answer">
 350                 <p>You don't want to use mDictionary anymore? Choose <i>Close</i> from application menu or just simple click on a cross in the right corner. It will close an application and remember your current preferences for mDictionary.</p>
 351                 <div class="image">
 352                         <img src="images/_800_close.png"></img>
 353                         Closing application
 354                 </div>
 355         </div>
 356 </div>
 357
 358 <div class="faq_question">
 359         <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
 360                 Uninstallation
 361         <div class="faq_answer">
 362
 363                 <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>
 364                 <p>Uninstalling mDictionary can be performed using the Application Manager. Enter the Show Installed Applications item and uninstall the mDictionary package.</p>
 365
 366         </div>
 367 </div>
 368
 369
 370         <div id="footer">
 371                         <p>Copyright &copy; 2006 - 2008 ComArch S.A.</p>
 372                         <br>
 373                         <a href="http://www.comarch.com"><img src="images/comarch.png"
 374                              alt="ComArch Information Technology"
 375                              width="150px"
 376                              height="36px"
 377                                  border="0"
 378                                  >
 379                         </a>
 380                 </div>
 381         </div>
 382 </div>
 383 <br>
 384 </body>
 385 </html>