From: gadomska_anna Date: Mon, 12 Feb 2007 11:04:00 +0000 (+0000) Subject: website with userguide for WhiteStork X-Git-Url: http://vcs.maemo.org/git/?a=commitdiff_plain;h=a5dd72e4e915038508c89509eb1248cda00c13e3;p=mdictionary website with userguide for WhiteStork git-svn-id: file:///svnroot/mdictionary/www@73 5bde0345-f819-0410-ac75-e5045f9217cc --- diff --git a/userguide/images/01.jpg b/userguide/images/01.jpg new file mode 100755 index 0000000..9aa9c3b Binary files /dev/null and b/userguide/images/01.jpg differ diff --git a/userguide/images/about.png b/userguide/images/about.png new file mode 100755 index 0000000..0e92246 Binary files /dev/null and b/userguide/images/about.png differ diff --git a/userguide/images/add_bookmark.png b/userguide/images/add_bookmark.png new file mode 100755 index 0000000..f240639 Binary files /dev/null and b/userguide/images/add_bookmark.png differ diff --git a/userguide/images/background.png b/userguide/images/background.png new file mode 100755 index 0000000..3c33684 Binary files /dev/null and b/userguide/images/background.png differ diff --git a/userguide/images/close.png b/userguide/images/close.png new file mode 100755 index 0000000..d792758 Binary files /dev/null and b/userguide/images/close.png differ diff --git a/userguide/images/context_menu.png b/userguide/images/context_menu.png new file mode 100755 index 0000000..5e3262f Binary files /dev/null and b/userguide/images/context_menu.png differ diff --git a/userguide/images/hide_words_list.png b/userguide/images/hide_words_list.png new file mode 100755 index 0000000..a29c229 Binary files /dev/null and b/userguide/images/hide_words_list.png differ diff --git a/userguide/images/load_dictionary.png b/userguide/images/load_dictionary.png new file mode 100755 index 0000000..41ed2b5 Binary files /dev/null and b/userguide/images/load_dictionary.png differ diff --git a/userguide/images/menu_bookmarks.png b/userguide/images/menu_bookmarks.png new file mode 100755 index 0000000..335e3b8 Binary files /dev/null and b/userguide/images/menu_bookmarks.png differ diff --git a/userguide/images/menu_dictionaries.png b/userguide/images/menu_dictionaries.png new file mode 100755 index 0000000..04c7ce5 Binary files /dev/null and b/userguide/images/menu_dictionaries.png differ diff --git a/userguide/images/menu_edit.png b/userguide/images/menu_edit.png new file mode 100755 index 0000000..4a3182d Binary files /dev/null and b/userguide/images/menu_edit.png differ diff --git a/userguide/images/menu_view.png b/userguide/images/menu_view.png new file mode 100755 index 0000000..e3474ef Binary files /dev/null and b/userguide/images/menu_view.png differ diff --git a/userguide/images/remove_bookmark.png b/userguide/images/remove_bookmark.png new file mode 100755 index 0000000..6051d17 Binary files /dev/null and b/userguide/images/remove_bookmark.png differ diff --git a/userguide/images/remove_dictionaries.png b/userguide/images/remove_dictionaries.png new file mode 100755 index 0000000..5f9e35f Binary files /dev/null and b/userguide/images/remove_dictionaries.png differ diff --git a/userguide/images/select_dictionaries.png b/userguide/images/select_dictionaries.png new file mode 100755 index 0000000..1d130be Binary files /dev/null and b/userguide/images/select_dictionaries.png differ diff --git a/userguide/images/whitestork.png b/userguide/images/whitestork.png new file mode 100755 index 0000000..751eb6e Binary files /dev/null and b/userguide/images/whitestork.png differ diff --git a/userguide/index.html b/userguide/index.html new file mode 100644 index 0000000..530a7e6 --- /dev/null +++ b/userguide/index.html @@ -0,0 +1,225 @@ + + + + +WhiteStork Multilingual Dictionary User Guide + + + + + + + +
+
+
WhiteStork Multilingual Dictionary
+
+
- user guide -
+

+

Instalation
+
+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).
+In order to install our application make the following steps:
+1. Download the binary packages from WhiteStork website - download section
+2. Open the file manager and double click on each of the downloaded files in order they were mentioned above.
+3. 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.
+During an installation process you will be asked for pointing the location where WhiteStork should be placed in menu. The default location is Extra submenu. +
+

+ +

+

Running the application
+
+If the installation process is completed you can start using your WhiteStork!
+To run application simply click WhiteStork activator from your Task Navigator and enjoy the pleasure!
+
+

+ +

+

Working with dictionaries
+
+
    +

    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 XDXF and StarDict dictionaries. +

    +
    +

    The Dictionaries Submenu
    +

    +
  • Load dictionary
  • +

    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 here. After you have unpacked files, please create a folder with a proper name on your device and put there dictionary files. It is strongly recommended to put files into a folder with a name of the dictionary. Without that your WhiteStork cannot work properly.
    If you have finished the steps above, run WhiteStork and choose Load dicionary from Dictionaries submenu in application menu.

    +

    +
    +

    Dialog window for loading a new dictionary file
    +

    +
  • Select dicionaries
  • +

    +There is possibility to use more than one dictionary at the same time. To do this, you just have to choose Select dictionaries from Dictionaries submenu and tick the dictionaries, which you would like to search in.
    +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. +

    +

    +
    +

    Dialog window for selecting active dictionaries
    +

    +
  • Remove dictionaries
  • +

    +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.
    +To remove a loaded dictionary from your WhiteStork, please open Dictionaries submenu from Application Menu and choose Remove Dictionaries. The special dialog window will pop up and lead you through the removing process step by step. +

    +

    +
    +

    Dialog window for removing dictionaries
    +

    +
  • Optimize dictionaries
  • +

    +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 Optimize dictionaries from Dictionaries submenu you can check which dictionaries have not been optimized or simply optmize them. +

    +
+
+

+ +

+

Bookmarks
+
+
    +
  • Open/Close Bookmarks
  • +

    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.
    +When you choose Open bookmarks from Bookmarks 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. This query works only in bookmarks mode!. +

    +

    +
    +

    The Bookmarks submenu
    +

    +
  • Add Bookmark
  • +

    +If you want to leave bookmark mode choose Close bookmark from Boomarks menu.
    +To add a word to the bookmarks, select it from the words list and choose Add bookmark from Bookmarks submenu or from the context menu.
    +

    +

    +
    +

    Adding bookmark
    +

    +
  • Remove Bookmark
  • +

    +To remove a word from bookmarks, you have to switch into Bookmark mode (Open bookmark). Then select a word from words list which you would like to remove and choose Remove bookmark from Bookmarks submenu.
    +

    +

    +
    +

    Removing bookmark
    +

    +

    +

    If YOU HAVE INSTALLED APPLICATION, BUT BOOKMARKS MENU IS DIMMED or AN ERROR MESSAGE HAS BEEN DISPLAYED WHEN STARTING WHITESTORK, probably Bookmarks module has not been installed with WhiteStork. The reason could be lack of dependencies (libsqlite0). If you still want to use Bookmarks, please folow the steps:
    +

    1. Turn your device into RED PILL MODE. It allows you to install missing libraries.

    +

    2. Wait a couple of seconds, while list of packages is refreshing.

    +

    3. Choose Install new application

    +

    4. Click libs

    +

    5. Find libsqlite0 on a list and install a package

    +

    6. Switch an application back from RED PILL MODE.

    +

    7. Restart your WhiteStork.

    +Now Bookmarks should work well! +

    +
+
+

+ +

+

Editing?
+
+

+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!

+

+
+

The Edit submenu
+

+
    +
  • Copy please ...
  • +

    If you want to copy selected text from translation area simply choose Copy from Edit submenu in application menu or in context sensitive menu.

    +
  • Paste
  • +

    If you want to paste a text from the clipboard into a find toolbar textbox choose Paste from Edit submenu in application menu or in context sensitive menu.

    +
  • Could you select this text for me?
  • +

    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.
    +You can also use Select All option from Edit submenu in application on context senstitive menu. This option allows for selecting the whole translation.

    +
+
+

+ +

+

Changing the view
+
+

+WhiteStork provides couple of different views so that user can feel comfortable and choose the one that fits the best.

+

+
+

The View submenu
+

+
    +
  • Translation only!
  • +

    There is possibility to hide words list anytime user wants. To do this, click green arrow in a left corner or choose Hide words list from View submenu in application menu.

    +

    +
    +

    Words list is hidden
    +

    +
  • Magnifying ...
  • +

    Sometimes font in translation area is too small to read it. In that case you can use Zoom in option. You can call it from View submenu in application menu, from context sensitive menu or just simply use hardware keys. If you don't want to magnify text anymore, choose Zoom out

    +
  • Fullscreen
  • +

    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 Fullscreen option from View submenu or by using hardware keys.

    +
+

+
+

+ +

+

Searching ...
+
+
    +
  • History
  • +

    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.
    +To go to the previously found word you have to choose Find previous option from Search submenu. It is dimmed if there are no words in the history. If you are browsing history, and you decide to go forward - choose Find next from Search submenu. It is dimmed if there are no words available as well.
    +You can also choose buttons from a find toolbar, instead of using application menu. Green arrows placed between search and stop button are appropriately back and forward in the history.

    +
  • Search a word
  • +

    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 Search button places on a toolbar (next to the entry). You can also go to the application menu and choose Find from Search submenu. Finally, you can use harware key ("Go").

    +
  • Stop!
  • +

    If a search process takes too long or you made mistake in a pattern, you can stop searching process. Click Stop button on a toolbar or Stop option from Search submenu.

    +
+
+

+ +

+

Contex Sensitive Menu
+

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.

+

+
+ + +

+

About ...
+
+

You can click About ... in application menu to learn some details about WhiteStork.
+

+

If you want more informations, please visit WhiteStorks website or see WhiteStork project on garage.maemo.org.

+
+

+ +

+

Closing the application
+
+

+You don't want to use WhiteStork anymore? Choose Close 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.

+

+
+

Closing application
+

+
+

+ +

+

Uninstall?
+
+

+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.
+Uninstalling WhiteStork can be performed using the Application Manager. Enter the Show Installed Applications item and uninstall the following packages: whitestorkgui, whitestork and whitestorkplugins.

+
+

+ +
+
+ + \ No newline at end of file diff --git a/userguide/style.css b/userguide/style.css new file mode 100644 index 0000000..0e0e296 --- /dev/null +++ b/userguide/style.css @@ -0,0 +1,59 @@ +body { + background: #000000 url(images/background.png); + margin: 0; + padding: 0; + text-align: center; +} + +#content { + display: block; + width: 750px; + background: #FFFFFF; + border: none; + text-align: left; + margin: 20px; + padding: 20px; + border: 0px solid #FFFFFF; +} + +#whitestork_title { + display: block; + font-weight: bold; + font-size: 24px; + text-align: center; + text-decoration: underline; +} + +#userguide_title { + display: block; + font-weight: bold; + font-size: 18px; + text-align: center; +} + +li { + font-weight: bold; +} + +#subject { + display: block; + font-weight: bold; + font-size: 16px; + text-align: left; +} + +#decription { + display: block; + font-weight: normal; + font-size: 12px; + text-align: left; +} + +#image { + font-size: 10px; + font-weight: bold; +} + +#stork { + background: url(images/whitestork.png); +} \ No newline at end of file