First steps with Okawix:
When you launch Okawix for the first time, you will notice: at the top of the Okawix window, the toolbar; under the toolbar, the search bar; and under the search bar, on the left, the corpus management frame and, on the right, a main frame. This latter enables you to select the languages of the contents (also called archives, or Corpus) that you would like to download, so as to be able to read them offline. You can choose so many languages as you wish.
For instance, select English, and then click Select languages.
A list of all archives available in this language appears. In addition you are also offered the possibility to ask for the creation of an archive of your own website: just enter your email address and your website URL, and click Request.
Click the Download button of the archive that you would like to browse offline. Okawix offers you to save this archive on a local drive, in the directory of your choice.
You can choose to download the archive with or without the pictures (in order to keep as small as possible the time and the amount of local storage space necessary to the archive download).
Click Install. The selected archive is then saved, and its main page appears in the main frame (without the pictures if you chose not to download them). In the left frame, the name of the archive is added to the list of the archives that are stored locally.
The articles of this archive can now be read offline.
The back and forward buttons: the back and forward buttons allow you to go back to the previous resource and forward again, just like in any browser.
The Home button: displays in the main frame the main page of the archive that you are consulting, and on the left the corpus management frame.
The Show search results button: displays in the left collapsible frame the results of your last search.
The Show history button: displays in the left collapsible frame past searches that you've done, also known as your search history, when using the Okawix search box. A click on an item of your search history displays in this same left frame the results of the search on which you have clicked.
The Print this page button: starts your operating system print utility.
The More content button: displays on the left the corpus management frame, and in the main frame, on the right, the language selection form (if the languages have already been chosen during the current Okawix session, the archive selection page appears instead, with the archives available for your selected languages).
The Help button: displays this user guide (inside the user guide window, you will also find the About button. A click on it will open the About box, with Okawix credits in it).
How to search within a corpus (Search field and Go searching button): Okawix makes it possible to search within the active corpus for the articles relevant to a query of your choice. This functionality is brought by the Wikiwix semantic search engine (developed, as well as Okawix, by the Linterweb company).
Search is simple: just type your query in the search field. As you type it, the autocomplete feature provides you with suggestions of queries relevant to what you have typed in so far and to the currently active corpus (the autocomplete functionality is activated only after you've typed in the search field at least four letters; note that the simple fact that a word does not appear in the suggestion list does not imply that the word has no occurrences in the corpus or that no articles of the corpus will match your query).
Once your query is typed, do one of the following to complete the search:
- click one of the suggested terms.
- select one of the suggested terms with the Up and Down cursor keys, and hit Enter.
- type a word in the Search field and hit Enter.
- type a word in the Search field and click on the Go searching button.
The first twenty-five search results are displayed in the left collapsible frame, sorted by relevance to your query. The names of the articles found by the search engine are written on coloured rectangular bars with lengths proportional to the relevance of the articles to your query.
Note 1: the fact that an article appears amongst the results relevant to a query does not imply that the article contains all the words of this query; the relevance of an article is evaluated by the Wikiwix search engine with the help of complex algorithms whose details are unfortunately beyond the scope of this documentation.
Note 2: Wikiwix is designed to best deal with the questions posed in natural (also called ordinary) language. That is, instead of typing in the search field just keywords, which you expect will produce the best search results, that is, instead of adapting your query to the search engine, as you would do with most search engines, you can with Wikiwix ask your question just as you would do if you spoke to a human person. For instance, let's assume that you would like to know how high the Eiffel tower is. With Wikiwix, you can pose your question this way: "How high is the Eiffel tower?". Wikiwix will then attempt to "understand" the meaning of your query and to send you back the search results most relevant to this question. We must however make it clear that Wikiwix does not yet reach the degree of intelligence of a true human being as for the understanding of questions; improvements will be brought as new versions of Okawix and Wikiwix are released.
The Find a word in this page button: allows the user to find the occurrences of a given character string within the page that is currently displayed in the main frame. When you click on that button, a small Find dialog box pops up. Type in the text field any character string whose occurrences, if any, you would like to find.
Select the Match case check box if you would like the search to be case sensitive, uncheck it otherwise (if this option is checked and you search for instance for the occurrences of the word "states", then the occurrences of the word "States" will not be found, because it does not match the exact case that you typed in, as "States" starts with a upper case, contrary to "states").
Select the Wrap check box if you want the search to continue at the top of the page once its end has been reached (deselect otherwise).
You can also set the search direction: top-down if Down is selected, bottom-up if Up is selected.
Then click Find Next to start the search. If any, the first occurrence of the character string is highlighted in blue. Click again to find the second occurrence, if any, then again to find the third occurrence, ... If no, or no more, occurrences are to be found in the page, you'll see the message "The text you entered was not found" (unless the Wrap check box is selected).
Click Cancel to close the small Find dialog box.
The language selection page: this page enables you to select the languages of the contents (also called archives, or Corpus) that you would like to be downloaded, so as to be able to read them offline. If the languages had not yet been selected within the current Okawix session, you access this page by clicking the More content button of the toolbar. If the languages had already been selected, the archive selection page is displayed instead of the the language selection page; you can then change the selected languages by clicking on edit (after the words "Chosen languages").
You can select several languages. The languages are sorted by the number of articles of the Wikipedia in the corresponding language.
Then, click Select languages; the archive selection page shows up.
The archive selection page: This page allows you first to select the archives that you would like to be downloaded, so as to be able to browse them offline, and offers you in addition to create archives of your own website . You reach this page by clicking the More content button of the toolbar. If the languages had not yet been selected within the current Okawix session, the language selection page is displayed instead of the the archive selection page; in this case you will have first to select the languages of the contents (also called archives, or Corpus) that you would like to be downloaded and then click Select languages, in order to eventually get to the archive selection page.
The archive selection page shows you which archives are available for the languages that you have previously selected, and how big these archives are.
To download an archive, just click on the corresponding Download button. The installation page of this archive is then displayed, and the name of the archive is added to the install list of the archives waiting for installation for the current Okawix session, in the corpus management frame (the left collapsible frame).
Finally, if you would like to have an archive of your own website to be created, just enter your email address and your website URL, and click Request.
The installation page of a given archive: enables to download and install a previously selected archive. To access this page, do one of the following:
- click, in the corpus management frame (the left collapsible frame), on the name of an archive of your choice, in the install list, in case this list is not empty.
- if the archive that you want to install does not appear in the install list of the archives waiting for installation for the current Okawix session, in the corpus management frame (the left collapsible frame), then click, in the archive selection page, on the Download button corresponding to the archive of your choice.
The page shows you the name of the archive to be installed, and the directory in which the archive will be saved (if you would like to choose another directory, type the path of this directory in the corresponding text field, or click the Browse button and select the appropriate directory).
If the option Install images is selected, the images contained in the articles will be downloaded and installed as well (which will increase the downloading time as well as the required amount of local storage space necessary to the archive saving).
The total size of what you are installing (the archive only, or the archive with its images) is also displayed under the Browse button.
Clicking Cancel will remove the name of the archive from the install list of the archives waiting for installation for the current Okawix session, in the corpus management frame (the left collapsible frame).
If you click on Install, Okawix installs the archive, whose name is moved from the install list of the archives waiting for installation for the current Okawix session, to the local list of the already installed archives, in the corpus management frame (the left collapsible frame). If this archive had been previously installed, you'll see a message telling you that "the corpus is already installed" and asking you if "you want to update it".
The corpus management frame: enables you to manage the corpus (also called archives, or contents), e.g. to install or suppress them, to add the images, ...
You can access this frame by clicking, in the toolbar, on Home, or on More contents. The frame is collapsible and always appears left of the interface.
The frame contains, top-down:
- the local list of the previously installed archives (if any). Clicking on an archive of this list displays the main page of this archive.
- the install list of the archives waiting for installation for the current Okawix session (if any). Clicking on an archive of this list displays the installation page of this archive in the main frame, right of the interface.
- possibly, an http button. Clicking on this button displays, on the right of the interface, the language selection page (if the languages have already been selected for the current Okawix session, the selection page of the archives available for the previously selected languages is directly displayed).
Right at the bottom of this frame, you will notice two buttons:
- Add images: if an archive of the lists local or install is selected, clicking on Add images displays the installation page in the main frame, right of the interface, and offers you to proceed to the installation of the images of the articles for this archive
- Remove: if an archive of the lists local or install is selected, clicking on Remove removes the archive of this list. If the archive was in the local list (and therefore was installed locally), the corresponding files are deleted.
documentation translation made by