* changing web page into mDictionary one (basic version)
[mdictionary] / userguide.html
diff --git a/userguide.html b/userguide.html
new file mode 100644 (file)
index 0000000..396965b
--- /dev/null
@@ -0,0 +1,372 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+       <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+       <meta http-equiv="content-language" content="EN" />
+       <meta name="description" content="Home page for mDictionary project - 
+                   mobile multilingual dictionary for maemo.org platform 
+                   (previously known as a 'WhiteStork')" />
+       <meta name="keywords" content="mdictionary whitestork maemo n770
+                   n800 n810 dictionary xdxf stardict mobile linux comarch" />
+       <meta name="language" content="English" />
+       <meta name="owner" content="ComArch S.A." />
+       <meta name="copyright" content="ComArch, 2006-2007. All rights Reserved."/>
+
+       <link rel="shortcut icon" href="images/favicon.png" type="image/x-icon"></link>
+       <link rel="stylesheet" href="styles/main.css" type="text/css"></link>
+       <!--[if IE 6]>
+               <link rel="stylesheet"
+                     type="text/css"
+                     href="styles/main_ie.css" />
+
+               <script defer src="scripts/pngfix.js" type="text/javascript"></script>
+       <![endif]-->
+       <script language="JavaScript" src="scripts/javascripts.js" ></script>
+
+       <title>
+               mDictionary - multilingual dictionary for Maemo
+       </title>
+</head>
+<body>
+<div id="webContainer">
+       <div id="topBar">
+               <img src="images/mLogo_ie24.png" style="float:left;"></img>
+               <a href="files/mdictionary.install"
+                  class="install">
+                       install
+               </a>
+               <div style="display:block;height:100px;">
+                       <p class="title">
+                               mDictionary
+                       </p>
+                       <p class="description">
+                               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)
+                       </p>
+               </div>
+               <div id="topBarLinks">
+                       <a href="index.html">Home</a>
+                       <a href="download.html">Download</a>
+                       <a href="howto.html">How to..</a>
+                       <a href="screen800.html">Screenshots</a>
+                       <a href="userguide.html" class="current">User Guide</a>
+                       <a href="faq.html">FAQ</a>
+                       <a href="devhowto.html">Development</a>
+                       <a href="contact.html">Contact</a>
+               </div>
+
+       </div>
+       <div id="contentContainer">
+
+               <h1 class="centered">
+                       mDictionary Multilingual Dictionary
+               </h1>
+               <center><img class="centered" src="images/mLogo.png"></img></center>
+               <p class="centered">
+                       - user guide -
+               </p>
+
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       Installation.
+       <div class="faq_answer">
+               <p>
+               <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. 
+               </p>
+               <p>
+               In order to install our application make the following steps:
+               </p>
+               <ul>
+                       <li>
+                               Download the binary package from mDictionary website - 
+                               <a href="https://garage.maemo.org/frs/?group_id=58">
+                               download section
+                               </a>
+                       </li>
+                       <li>
+                               Open the file manager and double click on downloaded file.
+                       </li>
+                       <li>
+                               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.
+                       </li>
+               </ul><br />
+               <p>or just simply click <a href="files/mdictionary.install">INSTALL</a> from mDictionary webpage.</p>
+               <p>
+               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.
+               </p>
+       </div>
+</div>
+
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       Running Application.
+       <div class="faq_answer">
+               <p>If the installation process is completed you can start using your mDictionary!</p>
+               <p>To run application simply click mDictionary activator from your Task Navigator and enjoy the pleasure!</p>
+       </div>
+</div>
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       Work with many different dictionaries.
+       <div class="faq_answer">
+               <p>
+               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.
+               </p>
+               <div class="image">
+                       <img src="images/_800_menu_dictionaries.png"></img>
+                       The Dictionaries Submenu<br><br>
+               </div>
+
+               <ul>
+                       <li>
+                               Load dictionary
+                       </li>
+                       <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>
+                       <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>
+                       <div class="image">
+                               <img src="images/_800_load_dictionary.png"></img>
+                               Dialog window for loading a new dictionary file<br><br>
+                       </div>
+                       
+                       <li>
+                               Select dicionaries
+                       </li>
+                       <p>
+                               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.
+                       </p>
+                       <p>
+                               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.
+                       </p>
+                       <div class="image">
+                               <img src="images/_800_select_dictionaries.png"></img>
+                               Dialog window for selecting active dictionaries<br><br>
+                       </div>
+                       <li>
+                               Remove dictionaries
+                       </li>
+                       <p>
+                               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.
+                       </p>
+                       <p>
+                               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.
+                       </p>
+                       <div class="image">
+                               <img src="images/_800_remove_dictionaries.png"></img>
+                               Dialog window for removing dictionaries<br><br>
+                       </div>
+
+
+
+                       <li>
+                               Optimize dictionaries
+                       </li>
+                       <p>
+                               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 />
+                               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).
+                       </p>
+               </ul>
+       </div>
+</div>
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       User Bookmarks.
+       <div class="faq_answer">
+       <ul>
+               <li>Open/Close Bookmarks</li>
+               <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>
+               <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>
+
+                       <div class="image">
+                               <img src="images/_800_menu_bookmarks.png"></img>
+                               The Bookmarks submenu<br><br>
+                       </div>
+
+               <p>If you want to leave bookmark mode choose <i>Close bookmark</i> from <i>Boomarks</i> menu.<br></p>
+               <li>
+                       Add Bookmark
+               </li>
+               <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>
+                       <div class="image">
+                               <img src="images/_800_add_bookmark.png"></img>
+                               Adding bookmark<br><br>
+                       </div>
+
+               <li>
+                       Remove Bookmark
+               </li>
+               <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>
+                       <div class="image">
+                               <img src="images/_800_remove_bookmark.png"></img>
+                               Removing bookmark<br><br>
+                       </div>
+               <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>
+       </ul>
+       </div>
+</div>
+
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       Exchange Data With Other Applications.
+       <div class="faq_answer">
+               <p>
+                       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!
+               </p>
+               <div class="image">
+                       <img src="images/_800_menu_edit.png"></img>
+                       The Edit submenu<br><br>
+               </div>
+               <ul>
+                       <li>
+                               Copy please ...
+                       </li>
+                       <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>
+
+                       <li>
+                               Paste
+                       </li>
+                       <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>
+
+                       <li>
+                               Could you select this text for me?
+                       </li>
+                       <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>
+                       <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>
+               </ul>
+       </div>
+</div>
+
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       Change view of the application.
+       <div class="faq_answer">
+               <p>
+                       mDictionary provides couple of different views so that user can feel comfortable and choose the one that fits the best.
+               </p>
+               <div class="image">
+                       <img src="images/_800_menu_view.png"></img>
+                       The View submenu<br><br>
+               </div>
+               <ul>
+                       <li>
+                               Translation only!
+                       </li>
+                       <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>
+                       <div class="image">
+                               <img src="images/_800_hide_words_list.png"></img>
+                               Words list is hidden<br><br>
+                       </div>
+
+
+                       <li>
+                               Magnifying ... 
+                       </li>
+                       <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>
+
+                       <li>
+                               Fullscreen mode
+                       </li>
+                       <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>
+               </ul>
+
+       </div>
+</div>
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       Searching ...
+       <div class="faq_answer">
+               <ul>
+                       <li>
+                               History
+                       </li>
+                       <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>
+                       <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>
+
+                       <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>
+
+                       <li>
+                               Search a word
+                       </li>
+                       <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>
+
+                       <li>
+                               Stop!
+                       </li>
+                       <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>
+
+               </ul>
+       </div>
+</div>
+
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       Context Sensitive Menu
+       <div class="faq_answer">
+               <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>
+               <div class="image">
+                       <img src="images/_800_context_menu.png"></img>
+                       Context Sensitive Menu
+               </div>
+       </div>
+</div>
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+       About ...
+       <div class="faq_answer">
+               <p>You can click <i>About ...</i> in application menu to learn some details about mDictionary.</p>
+               <div class="image">
+                       <img src="images/_800_about.png"></img>
+                       About Dialog
+               </div>
+               <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>
+       </div>
+</div>
+
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+               Closing the application
+       <div class="faq_answer">
+               <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>
+               <div class="image">
+                       <img src="images/_800_close.png"></img>
+                       Closing application
+               </div>
+       </div>
+</div>
+
+<div class="faq_question">
+       <div class="faq_switcher" onClick="javascript:faq_switcher(this);"></div>
+               Uninstallation
+       <div class="faq_answer">
+
+               <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>
+               <p>Uninstalling mDictionary can be performed using the Application Manager. Enter the Show Installed Applications item and uninstall the mDictionary package.</p>
+
+       </div>
+</div>
+
+
+       <div id="footer">
+                       <p>Copyright &copy; 2006 - 2007 ComArch S.A.</p>
+                       <br>
+                       <a href="http://www.comarch.com"><img src="images/comarch.png"
+                            alt="ComArch Information Technology"
+                            width="150px"
+                            height="36px"
+                                border="0"
+                                >
+                       </a>
+               </div>
+       </div>
+</div>
+<br>
+</body>
+</html>