4,304
edits
Difference between revisions of "Kiwix 0.9 User Guide"
Jump to navigation
Jump to search
localized links
(add wikitext headings) |
(localized links) |
||
| Line 13: | Line 13: | ||
<br> | <br> | ||
<translate><!--T:10--> | <translate><!--T:10--> | ||
'''[[Help|← Back to help page]]''' | '''[[Special:MyLanguage/Help|← Back to help page]]''' | ||
</translate> | </translate> | ||
</div> | </div> | ||
| Line 22: | Line 22: | ||
<translate><!--T:1--> | <translate><!--T:1--> | ||
== Navigation keys and buttons == | == Navigation keys and buttons == | ||
Browsing Kiwix content is similar to web browsers, so you can easily navigate from a page (which could be a document or an article) to another page. Clicking on the '''Home''' icon [[File:home24.png|link=]] will take you to your current ZIM file's homepage. For instance, if you run the English Wikipedia ZIM file, you will see the [[Wikipedia]] entry as its homepage. If you haven't installed any ZIM file yet, you will see the [[Help|Help page]] as the homepage and it means there is no content to display. In that case, you should follow the instructions of [[Wikipedia in all languages|this page]] in order to read the content. | Browsing Kiwix content is similar to web browsers, so you can easily navigate from a page (which could be a document or an article) to another page. Clicking on the '''Home''' icon [[File:home24.png|link=]] will take you to your current ZIM file's homepage. For instance, if you run the English Wikipedia ZIM file, you will see the [[Special:MyLanguage/Wikipedia|Wikipedia]] entry as its homepage. If you haven't installed any ZIM file yet, you will see the [[Special:MyLanguage/Help|Help page]] as the homepage and it means there is no content to display. In that case, you should follow the instructions of [[Special:MyLanguage/Wikipedia in all languages|this page]] in order to read the content. | ||
Just like your web browser, you can return to the previous page by clicking on the '''Back''' arrow icon [[File:Go-back24.png|link=]] and go to the next page by clicking on the '''Forward''' arrow icon [[File:go-forward24.png|link=]] in the toolbar. To open the ''New Tab'' page, click on the '''Open a new tab''' icon [[File:add24.png|link=]] next the last tab at the top of the window or press '''Ctrl+T''' ('''⌘-T''' on Mac). To close a tab, use the [[File:close12.png|link=]] in the right side of each tab you want to close or the keyboard shortcut '''Ctrl+W''' ('''⌘-W''' on Mac). You can open the links of a page in a new tab, by pressing '''Ctrl''' on your keyboard or right clicking on the link and then choosing "Open link in new Tab".</translate> | Just like your web browser, you can return to the previous page by clicking on the '''Back''' arrow icon [[File:Go-back24.png|link=]] and go to the next page by clicking on the '''Forward''' arrow icon [[File:go-forward24.png|link=]] in the toolbar. To open the ''New Tab'' page, click on the '''Open a new tab''' icon [[File:add24.png|link=]] next the last tab at the top of the window or press '''Ctrl+T''' ('''⌘-T''' on Mac). To close a tab, use the [[File:close12.png|link=]] in the right side of each tab you want to close or the keyboard shortcut '''Ctrl+W''' ('''⌘-W''' on Mac). You can open the links of a page in a new tab, by pressing '''Ctrl''' on your keyboard or right clicking on the link and then choosing "Open link in new Tab".</translate> | ||
| Line 56: | Line 56: | ||
== Full-text search engine and Indexing process == | == Full-text search engine and Indexing process == | ||
[[File:Search-engine.png|thumb|300px|Using search engine Autocompletion feature. You can see the page titles stared with the word "Wikipedia", and then access to the desired page by clicking on the corresponding item of the list. You can also see the pages which includes the word "Wikipedia" by choosing the last item of the list (''containing 'Wikipedia'...'')]] | [[File:Search-engine.png|thumb|300px|Using search engine Autocompletion feature. You can see the page titles stared with the word "Wikipedia", and then access to the desired page by clicking on the corresponding item of the list. You can also see the pages which includes the word "Wikipedia" by choosing the last item of the list (''containing 'Wikipedia'...'')]] | ||
Kiwix includes a powerful search engine to help you easily access 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. So if you have downloaded a [[Wikipedia in all languages|Portable pre-indexed ZIM]] file, you will be able to use this feature. But for the Non-indexed ZIM files, you should index them first. | Kiwix includes a powerful search engine to help you easily access 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. So if you have downloaded a [[Special:MyLanguage/Wikipedia in all languages|Portable pre-indexed ZIM]] file, you will be able to use this feature. But for the Non-indexed ZIM files, you should index them first. | ||
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 will need to confirm this process in order to use the [[Features#Search_engine|full-text search engine feature]] or cancel it and use the program without this feature. This step is very time-consuming. Depending on the size of your ZIM file and the speed of your computer, might last several hours or even several days for big packages like the 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 proceeded or remained in the progressive green bar on the Status bar (like [[File:Indexing-progress.png|link=]]), 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. | 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 will need to confirm this process in order to use the [[Special:MyLanguage/Features#Search_engine|full-text search engine feature]] or cancel it and use the program without this feature. This step is very time-consuming. Depending on the size of your ZIM file and the speed of your computer, might last several hours or even several days for big packages like the 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 proceeded or remained in the progressive green bar on the Status bar (like [[File:Indexing-progress.png|link=]]), 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 this process is completed, the full-text search engine will be ready to use. You will just need to type a text into the search field and then press '''Enter''' on your keyboard. A page including a list of matching results will appear and you can access the one you want to view. | After this process is completed, the full-text search engine will be ready to use. You will just need to type a text into the search field and then press '''Enter''' on your keyboard. A page including a list of matching results will appear and you can access the one you want to view. | ||
| Line 70: | Line 70: | ||
Like the sidebar of [http://en.wikipedia.org Wikipedia], there is an option named '''[[File:select-all16.png|link=]] 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|link=]] Purge history''' which clears 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|link=]] 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|link=]] Purge history''' which clears the history of the pages you visited and so the Back/Forward buttons will be inactive since then. | ||
If you have a local network and you want to share Kiwix with the clients of the network, you must go to '''Tools > Server''', click on the '''Start''' button after selecting the port and then click on '''Load'''. Afterward, you will have the same Kiwix with less features in your network (simply in your web browser). You can read supplemental information in '''[[Kiwix-serve]]'''.</translate> | If you have a local network and you want to share Kiwix with the clients of the network, you must go to '''Tools > Server''', click on the '''Start''' button after selecting the port and then click on '''Load'''. Afterward, you will have the same Kiwix with less features in your network (simply in your web browser). You can read supplemental information in '''[[Special:MyLanguage/Kiwix-serve|Kiwix-serve]]'''.</translate> | ||
</div> | </div> | ||
</div> | </div> | ||