4,922
edits
Difference between revisions of "Kiwix 0.9 User Guide/en"
Jump to navigation
Jump to search
Importing a new version from external source
(Importing a new version from external source) |
(Importing a new version from external source) |
||
| Line 17: | Line 17: | ||
: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. Click 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. Click 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. | ||
:Just like your web browser, you can return previous page by clicking on '''Back''' arrow icon [[File:Go-back24.png|link=]] and go to the next page by clicking on '''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 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 keyboard shortcuts '''Ctrl+W''' and ('''⌘-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 choose "Open link in new Tab" then. | :Just like your web browser, you can return previous page by clicking on '''Back''' arrow icon [[File:Go-back24.png|link=]] and go to the next page by clicking on '''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 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 keyboard shortcuts '''Ctrl+W''' and ('''⌘-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 choose "Open link in new Tab" then. | ||
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". | |||
;*Adjust the size of the text | ;*Adjust the size of the text | ||
:The size of the text is specified by the content package you are using. Because it might not be ideal for your eyes and comfort, you can either increase or decrease the text size of the pages at any time. To do so, use the '''Magnify''' icon [[File:zoom-in24.png|link=]] to increase and '''Reduce''' icon [[File:zoom-out24.png|link=]] to decrease the size of the text. Those commands are also available in '''Display > Zoom''' on the menu bar and one more option named [[File:zoom-10016.png|link=]] '''Original size''' is there which reset the text size of the page to its original size. You can also use the keyboard shortcuts '''Ctrl''' and '''+''' ('''⌘''' and '''+''' on Mac) to zoom in, '''Ctrl''' and '''-''' ('''⌘''' and '''-''' on Mac) to zoom out and '''Ctrl''' and '''0''' ('''⌘''' and '''0''' on Mac) to reset the zoom tool. | :The size of the text is specified by the content package you are using. Because it might not be ideal for your eyes and comfort, you can either increase or decrease the text size of the pages at any time. To do so, use the '''Magnify''' icon [[File:zoom-in24.png|link=]] to increase and '''Reduce''' icon [[File:zoom-out24.png|link=]] to decrease the size of the text. Those commands are also available in '''Display > Zoom''' on the menu bar and one more option named [[File:zoom-10016.png|link=]] '''Original size''' is there which reset the text size of the page to its original size. You can also use the keyboard shortcuts '''Ctrl''' and '''+''' ('''⌘''' and '''+''' on Mac) to zoom in, '''Ctrl''' and '''-''' ('''⌘''' and '''-''' on Mac) to zoom out and '''Ctrl''' and '''0''' ('''⌘''' and '''0''' on Mac) to reset the zoom tool. | ||
:In order to gain some extra space on a small display, you may wish to display Kiwix in full-screen mode, it will maximize the size of the Kiwix window and hide all other programs including your operating system. In order to do this, click on '''full-screen''' icon [[File:fullscreen24.png|link=]] or use the keyboard shortcuts '''F11''' (on Windows and Linux) and '''⌘-Shift-F''' (on Mac). | :In order to gain some extra space on a small display, you may wish to display Kiwix in full-screen mode, it will maximize the size of the Kiwix window and hide all other programs including your operating system. In order to do this, click on '''full-screen''' icon [[File:fullscreen24.png|link=]] or use the keyboard shortcuts '''F11''' (on Windows and Linux) and '''⌘-Shift-F''' (on Mac). | ||
In order to gain some extra space on a small display, you may wish to display Kiwix in full-screen mode. It will maximize the size of the Kiwix window and hide all other programs including your operating system. In order to do this, click on the '''full-screen''' icon [[File:fullscreen24.png|link=]] or use the keyboard shortcut '''F11''' ('''⌘-Shift-F''' on Mac). | |||
;*Printing and exporting documents | ;*Printing and exporting documents | ||
:You can print the Kiwix pages or even export them and share. There are three options available: | :You can print the Kiwix pages or even export them and share. There are three options available: | ||
| Line 27: | Line 32: | ||
:#To save the page as an HTML or text file, go to '''File > [[File:saveas16.png|link=]] Save page as''' menu item or just press '''Ctrl+S''' ('''⌘-S''' on Mac). Although it is not appropriate for sharing, the HTML format will keep the same formatting and links of the page. | :#To save the page as an HTML or text file, go to '''File > [[File:saveas16.png|link=]] Save page as''' menu item or just press '''Ctrl+S''' ('''⌘-S''' on Mac). Although it is not appropriate for sharing, the HTML format will keep the same formatting and links of the page. | ||
== Creating and using bookmarks == | |||
You can use Kiwix bookmarks to easily save the pages you would like to revisit. Bookmarks are organized in sets which is a list (or group) of bookmarks that has been put together. You can easily import/export a complete set of bookmarks, which is saved as a regular file on your computer, and you may wish to share a list of pages then, e.g. with your students. | |||
Clicking on the '''Bookmarks''' icon [[File:bookmarks24.png|link=]] in the toolbar will show you the Bookmarks panel on the left side of the application. To create a new set, click on the '''Create new Bookmark Set''' icon [[File:new24.png|link=]] and then choose a path on your computer and type a name. It will be saved as a .XML file and each time you add or delete a bookmark to the set, this file will be updated. You can share this file with someone or somewhere else to import or backup. If you have a Bookmark file and want to import it to your Kiwix, click on the '''Import Bookmark Set''' icon [[File:open24.png|link=]] in top of the panel and then select the .XML file from your computer. | |||
You can add the current page to your bookmark set by clicking on the '''Mark this page''' icon [[File:add24.png|link=]] or use the keyboard shortcut '''Ctrl+D''' ('''⌘-D''' on Mac). It will add to the Bookmark list and you can also write some notes for it in the bottom of the panel, '''Bookmark notes'''. Selecting each item of the list will navigate you to that page, and you may want to remove that item by clicking on the '''Unmark selected''' icon [[File:remove24.png|link=]]. You can switch between your opened sets (default one and those you imported) using the combo list of opened bookmark sets below the panel toolbar. Once you close Kiwix, all your sets will be closed and you will need to import them again the next time. | |||
;* Edit tools | ;* Edit tools | ||
| Line 36: | Line 43: | ||
: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|link=]]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. Then you will 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|link=]] 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|link=]]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. Then you will 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|link=]] 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|link=]]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. Then you will be able to paste that text in any other application you want. If you want to select the whole text of a page, choose '''Edit > [[File:select-all16.png|link=]] Select all''' or press '''Ctrl+A''' ('''⌘-A''' on Mac) from your keyboard. You can also right click anywhere in the page and choose "Select all". | |||
;*Full-text search engine and Indexing process | ;*Full-text search engine and Indexing process | ||
| Line 44: | Line 52: | ||
: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 word. 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. | :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 word. 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. | ||
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. | |||
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 containing that word. 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. | |||
;* More options | ;* More options | ||
| Line 49: | Line 62: | ||
: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 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|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 clear 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 '''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]]'''. | :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 '''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]]'''. | ||
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 '''[[Special:MyLanguage/Kiwix-serve|Kiwix-serve]]'''. | |||
</div> | </div> | ||
</div> | </div> | ||