Merge branch 'qml' of ssh://drop.maemo.org/git/mdictionary into qml
[mdictionary] / www / userguide / index.html
diff --git a/www/userguide/index.html b/www/userguide/index.html
new file mode 100644 (file)
index 0000000..1698247
--- /dev/null
@@ -0,0 +1,228 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-type" content="text/html; charset=iso-8859-2">
+<title>WhiteStork Multilingual Dictionary User Guide</title>
+<link rel="Stylesheet" type="text/css" href="style.css">
+</head>
+<body>
+<table height="100%" width="100%">
+<tr>
+<td align=center valign=middle>
+<div id="content">
+<div id="whitestork_title">WhiteStork Multilingual Dictionary</div>
+<center><img src="images/whitestork.png"></center>
+<div id="userguide_title">- user guide -</div>
+<p>
+<div id="subject">Instalation</div>
+<div id="decription">
+WhiteStork Multilingual Dictionary has been built with three modules, denpendant of each other: WhiteStork (internal application management), WhiteStorkGui (graphical user interface) and WhiteStorkPlugins (parsing engines). <br>
+In order to install our application make the following steps:<br>
+<b>1</b>. Download the binary packages from WhiteStork website - <a href="https://garage.maemo.org/frs/?group_id=58">download section</a><br>
+<b>2</b>. Open the file manager and double click on each of the downloaded files in order they were mentioned above.<br>
+<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>
+During an installation process you will be asked for pointing the location where WhiteStork should be placed in menu. The default location is <i>Extra</i> submenu.
+</div>
+</p>
+
+<p>
+<div id="subject">Running the application</div>
+<div id="decription">
+If the installation process is completed you can start using your WhiteStork!<br>
+To run application simply click WhiteStork activator from your Task Navigator and enjoy the pleasure!<br>
+</div>
+</p>
+
+<p>
+<div id="subject">Working with dictionaries</div>
+<div id="decription">
+<ul>
+<p>WhiteStork 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 WhiteStork 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.
+<center><p>
+<img src="images/_800_menu_dictionaries.png"><br>
+<div id="image">The Dictionaries Submenu</div>
+</p></center>
+<li>Load dictionary</li>
+<p>If you want to load a new dictionary file to your WhiteStork 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 WhiteStork cannot work properly.</u><br> If you have finished the steps above, run WhiteStork and choose <i>Load dicionary</i> from <i>Dictionaries</i> submenu in application menu.</p>
+<center><p>
+<img src="images/_800_load_dictionary.png"><br>
+<div id="image">Dialog window for loading a new dictionary file</div>
+</p></center>
+       <p>
+               
+       </p>
+<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.<br>
+<i>Anytime, you can select Bookmarks as an active dictionary as well. You are able to search, not only in XDXF or StarDict dictionaries, but also in your own, Bookmark database.</i>
+</p>
+<center><p>
+<img src="images/_800_select_dictionaries.png"><br>
+<div id="image">Dialog window for selecting active dictionaries</div>
+</p></center>
+<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 removed from your device.<br>
+To remove a loaded dictionary from your WhiteStork, please open <i>Dictionaries</i> submenu from 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>
+<center><p>
+<img src="images/_800_remove_dictionaries.png"><br>
+<div id="image">Dialog window for removing dictionaries</div>
+</p></center>
+<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.
+</p>
+</ul>
+</div>
+</p>
+
+<p>
+<div id="subject">Bookmarks</div>
+<div id="decription">
+<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. Bookmarks are treated in the same way as other dictionaries. You can browse them anytime, search in, add or remove words.<br>
+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.
+</p>
+<center><p>
+<img src="images/_800_menu_bookmarks.png"><br>
+<div id="image">The Bookmarks submenu</div>
+</p></center>
+<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 menu.<br>
+</p>
+<center><p>
+<img src="images/_800_add_bookmark.png"><br>
+<div id="image">Adding bookmark</div>
+</p></center>
+<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>.<br>
+</p>
+<center><p>
+<img src="images/_800_remove_bookmark.png"><br>
+<div id="image">Removing bookmark</div>
+</p></center>
+</p>
+<p>If <b>YOU HAVE INSTALLED APPLICATION, BUT BOOKMARKS MENU IS DIMMED</b> or <b>AN ERROR MESSAGE HAS BEEN DISPLAYED WHEN STARTING WHITESTORK</b>, probably Bookmarks module has not been installed with WhiteStork. The reason could be lack of dependencies (libsqlite0 or libsqlite3). If you still want to use Bookmarks, please folow the steps:<br>
+<p>1. Turn your device into <a href="http://maemo.org/maemowiki/ApplicationManagerRedPillMode">RED PILL MODE</a>. It allows you to install missing libraries.</p>
+<p>2. Wait a couple of seconds, while list of packages is refreshing.</p>
+<p>3. Choose <i>Install new application</i></p>
+<p>4. Click <i>libs</i></p>
+<p>5. Find <b>libsqlite0 (N770)</b> or <b>libsqlite3 (N800)</b> on a list and install a package</p>
+<p>6. Switch an application back from RED PILL MODE.</p>
+<p>7. Restart your WhiteStork.</p>
+Now Bookmarks should work well!
+</p>
+</ul>
+</div>
+</p>
+
+<p>
+<div id="subject">Exchange Data With Other Applications</div>
+<div id="decription">
+<p>
+WhiteStork gives user a wide range of possibilities to use clipboard. 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>
+<center><p>
+<img src="images/_800_menu_edit.png"><br>
+<div id="image">The Edit submenu</div>
+</p></center>
+<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.<br>
+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>
+</p>
+
+<p>
+<div id="subject">Changing the view</div>
+<div id="decription">
+<p>
+WhiteStork provides couple of different views so that user can feel comfortable and choose the one that fits the best.</p>
+<center><p>
+<img src="images/_800_menu_view.png"><br>
+<div id="image">The View submenu</div>
+</p></center>
+<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>
+<center><p>
+<img src="images/_800_hide_words_list.png"><br>
+<div id="image">Words list is hidden</div>
+</p></center>
+<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</li>
+<p>WhiteStork can work in two modes: normal and fullscreen. By default, WhiteStork 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>
+</p>
+</div>
+</p>
+
+<p>
+<div id="subject">Searching ...</div>
+<div id="decription">
+<ul>
+<li>History</li>
+<p>WhiteStork 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.<br>
+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.<br>
+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>
+</p>
+
+<p>
+<div id="subject">Contex Sensitive Menu</div>
+<div id="decription"><p>If you want to use context sensitive menu, please tap and hold your stylus in the translation area. If you are running WhiteStork under Scratchbox, you can use left or right mouse click and hold.</p></div>
+</p>
+<center><img src="images/_800_context_menu.png"></center>
+
+
+<p>
+<div id="subject">About ...</div>
+<div id="decription">
+<p>You can click <i>About ...</i> in application menu to learn some details about WhiteStork.<br>
+<center><img src="images/_800_about.png"></center></p>
+<p>If you want more informations, please visit <a href="http://mdictionary.garage.maemo.org/">WhiteStorks website</a> or see <a href="https://garage.maemo.org/projects/mdictionary/">WhiteStork project</a> on <a href="https://garage.maemo.org/">garage.maemo.org</a>.</p>
+</div>
+</p>
+
+<p>
+<div id="subject">Closing the application</div>
+<div id="decription">
+<p>
+You don't want to use WhiteStork 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 WhiteStork.</p>
+<center><p>
+<img src="images/_800_close.png"><br>
+<div id="image">Closing application</div>
+</p></center>
+</div>
+</p>
+
+<p>
+<div id="subject">Uninstall?</div>
+<div id="decription">
+<p>
+If you are sure, you are not going to use WhiteStork in the future and you want to remove WhiteStork from your device forever, you can unistall an application.<br>
+Uninstalling WhiteStork can be performed using the Application Manager. Enter the Show Installed Applications item and uninstall the following packages: whitestorkgui, whitestork and whitestorkplugins.</p>
+</div>
+</p>
+
+</div>
+</td>
+</tr>
+</table>
+</body>
+</html>
\ No newline at end of file