Difference between revisions of "Kiwix 0.9 User Guide"

Jump to navigation Jump to search
Full-text search engine and Indexing process
(More options)
(Full-text search engine and Indexing process)
Line 29: Line 29:
:Kiwix also supports copy-pasting feature. In order to do that, select a part of the text using the mouse and then choose '''Edit > [[File:copy16.png]]Copy''' or just press '''Ctrl+C''' ('''⌘-C''' on Mac) from your keyboard. You can also do a right click on the text and choose "Copy" to copy the text or "Search for" to search the text in the ZIM file. The you'll be able to paste that text in any other application you want. If you want the select the whole text of a page, choose '''Edit > [[File:select-all16.png]]Select all''' or press '''Ctrl+A''' ('''⌘-A''' on Mac) from your keyboard, and also by right clicking in everywhere of the page and choosing "Select all".
:Kiwix also supports copy-pasting feature. In order to do that, select a part of the text using the mouse and then choose '''Edit > [[File:copy16.png]]Copy''' or just press '''Ctrl+C''' ('''⌘-C''' on Mac) from your keyboard. You can also do a right click on the text and choose "Copy" to copy the text or "Search for" to search the text in the ZIM file. The you'll be able to paste that text in any other application you want. If you want the select the whole text of a page, choose '''Edit > [[File:select-all16.png]]Select all''' or press '''Ctrl+A''' ('''⌘-A''' on Mac) from your keyboard, and also by right clicking in everywhere of the page and choosing "Select all".


;[[File:searchs24.png]]Search across all documents of the content packages.
*;Full-text search engine and Indexing process
 
:Kiwix includes a powerful search engine to help you easily access to the pages you are looking for and search a phrase through the content of the pages of a package. The full-text search engine is available only for the indexed ZIM files, it means if you have downloaded a [[Wikipedia in all languages|Portable pre-indexed ZIM]] file, you'll be able to use this ability. But for the Non-indexed ZIM files, you should index them first.
Kiwix includes a powerful search engine to help you easily access the documents you are looking for.
:The search engine is located on the right side of the toolbar. If you can select the search box and type a word inside that, it means your search engine is ready to use. Otherwise, Kiwix will ask you if you want to index the ZIM file or not. You'll need to confirm this process in order to use [[Features#Search_engine|full-text search engine feature]] or cancel it and use the program without this feature. This step is very time-consuming process and depending on your ZIM file size and also the speed of your computer, might last several hours or even several days for big packages like English Wikipedia. Note that there is a 20 to 100 percents difference in size between the indexed and non-indexed ZIM files and if you want to index a ZIM file, your computer will have to create the index files which their size is equal to the same difference of the indexed and non-indexed ZIM files, so be careful to do this process without turning your system down or closing the application. You can also see how many percents of the indexing process has been proceed or remained in the progressive green bar on right side of Status bar (in bottom of the program), so your status bar should be active and do this appear that from '''Display''' menu if you can't see it now. Note that you won't need to do this long process if you download the Pre-Indexed ZIM file.
 
:After being this process completed, the full-text search engine will be ready to use, you'll just need to type a text into the search field and then press '''Enter''' on your keyboard. A page includes a list of matching results will appear and you can access the one you want to view.
To use the search engine, you must first enable it by creating the indexes. This steps may have already been done for you.
:If you don't want to use the full-text search ability, you can just type a word in the search box and see a list of the page titles stated with that words. The popup-list has the ability of Autocomplete and predicts the word being typed and suggests you the nearest page titles and you can choose the one you want subsequently.
 
Check that the search engine is ready by clicking on the large search field located on the toolbar. If you can type text inside, your search engine is ready. If not, Kiwix will ask you whether to launch the index creation process or not. This step is very time consuming and depend on both the size of your content package and the speed of your computer.
 
Once ready, the search engine is very easy to use: type text into the search field and hit enter. A list of matching results will appear on the side-panel. Click on the documents' name to access them.
 
Alternatively, you can select document's title in the search field. The popup-list is auto-completed as-you-type. Those are suggestions based on the real names of existing documents. Using them is not a requirement.


;* More options
;* More options
:There are some more features available in Kiwix. You can change the language of the application to the one you want by going to '''Display > Language''' in the menu bar and choosing your desired language there, and also the skin of Kiwix by going to '''Display > Skin'''. By choosing '''Display > Inverted colors''' or pressing '''Ctrl+I''' ('''⌘-I''' on Mac), the colors of the page will be inverted, e.g. the black text will be white and the white background will be black, this may go along with a log in the program.
:There are some more features available in Kiwix. You can change the language of the application to the one you want by going to '''Display > Language''' in the menu bar and choosing your desired language there, and also the skin of Kiwix by going to '''Display > Skin'''. By choosing '''Display > Inverted colors''' or pressing '''Ctrl+I''' ('''⌘-I''' on Mac), the colors of the page will be inverted, e.g. the black text will be white and the white background will be black, this may go along with a log in the program.
:Like the sidebar of [http://en.wikipedia.org Wikipedia], there is an option named '''[[File:select-all16.png]]Random article''' in the '''Tools''' menu, which shows a random article of the ZIM content. Another option of this menu is '''[[File:purge-history16.png]]Purge history''' which clear the history of the pages you visited and so the Back/Forward buttons will be inactive since then.
:Like the sidebar of [http://en.wikipedia.org Wikipedia], there is an option named '''[[File:select-all16.png]]Random article''' in the '''Tools''' menu, which shows a random article of the ZIM content. Another option of this menu is '''[[File:purge-history16.png]]Purge history''' which clear the history of the pages you visited and so the Back/Forward buttons will be inactive since then.
Administrators, translate-proofr
1,214

edits

Navigation menu