Difference between revisions of "Kiwix 0.9 User Guide"

Jump to navigation Jump to search
Edit tools
(Bookmarks (to be continued))
(Edit tools)
Line 8: Line 8:
;*Navigation keys and buttons
;*Navigation keys and buttons
:Browsing Kiwix content is in a similar way on the Internet and you can go from a page (which could be a document or an article) to another page. By click on '''Home''' icon [[File:home24.png]] you'll take to the homepage's of your current ZIM file, e.g. if you've run the English Wikipedia ZIM file, you'll see the [[Wikipedia]] entry as its homepage. If you haven't installed any ZIM file yet, you'll see the [[Help|Help page]] as the homepage and it means there is no content to display. In that case you should follow the instruction of [[Wikipedia in all languages|this page]] in order to read the content.
:Browsing Kiwix content is in a similar way on the Internet and you can go from a page (which could be a document or an article) to another page. By click on '''Home''' icon [[File:home24.png]] you'll take to the homepage's of your current ZIM file, e.g. if you've run the English Wikipedia ZIM file, you'll see the [[Wikipedia]] entry as its homepage. If you haven't installed any ZIM file yet, you'll see the [[Help|Help page]] as the homepage and it means there is no content to display. In that case you should follow the instruction of [[Wikipedia in all languages|this page]] in order to read the content.
:Just like your web-browser, you can go to previous page you have visited by clicking on '''Back''' arrow icon [[File:Go-back24.png]] and to forward page by clicking on '''Forward''' arrow icon [[File:go-forward24.png]] in the toolbar. You can also use the ''New Tab'' page by clicking on '''Open a new tab''' icon [[File:add24.png]] inside the last tab you have opened (under the toolbar), or just use the keyboard shortcuts '''Ctrl+T''' and ('''⌘-T''' on Mac). To close a tab, use the [[File:close12.png]] in the right side of each tab you want to close or keyboard shortcuts '''Ctrl+W''' and ('''⌘-W''' on Mac).
:Just like your web-browser, you can go to previous page you have visited by clicking on '''Back''' arrow icon [[File:Go-back24.png]] and to forward page by clicking on '''Forward''' arrow icon [[File:go-forward24.png]] in the toolbar. You can also use the ''New Tab'' page by clicking on '''Open a new tab''' icon [[File:add24.png]] inside the last tab you have opened (under the toolbar), or just use the keyboard shortcuts '''Ctrl+T''' and ('''⌘-T''' on Mac). To close a tab, use the [[File:close12.png]] 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.


;*Adjust the size of the text
;*Adjust the size of the text
Line 14: Line 14:
: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]] 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]] or use the keyboard shortcuts '''F11''' (on Windows and Linux) and '''⌘-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:
:#To print a page you're viewing in Kiwix, click on '''Print''' icon [[File:print24.png]] in the toolbar or press '''Ctrl+P''' ('''⌘-P''' on Mac). This option is also available in '''File''' menu. You'll be able to preview the page and adjust basic printer and page settings, before printing. Make sure the computer connected to the printer is also turned on.
:#To print a page you're viewing in Kiwix, click on '''Print''' icon [[File:print24.png]] in the toolbar or press '''Ctrl+P''' ('''⌘-P''' on Mac). This option is also available in '''File''' menu. You'll be able to preview the page and adjust basic printer and page settings, before printing. Make sure the computer connected to the printer is also turned on.
Line 22: Line 22:
;*Create Bookmarks and use them
;*Create Bookmarks and use them
:You can use Kiwix bookmarks to easily save the pages you would like to revisit. Bookmarks are organised 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.
:You can use Kiwix bookmarks to easily save the pages you would like to revisit. Bookmarks are organised 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.
:By clicking on '''Bookmarks''' icon [[File:bookmarks24.png]] in the toolbar you'll see 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]] and then choose a path on your computer and type a name. It will 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 '''Import Bookmark Set''' icon [[File:open24.png]] in top of th panel and then select the .XML file from your computer.
:You can add the current page to your bookmark set by clicking on '''Mark this page''' icon [[File:add24.png]] or use the the keyboard shortcuts '''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'''. By selecting each item of the list, you will be navigated to that page, and you may want to remove that item by clicking on '''Unmark selected''' icon [[File:remove24.png]]. 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 at the next time.


:By clicking on '''Bookmarks''' icon [[File:bookmarks24.png]] in the toolbar you'll see 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]] and then choose a path on your computer and type a name. It will 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.
;* Edit tools
 
:Use the find bar to locate a specific word or phrase on a webpage. To do so, click on the '''Find in text''' icon [[File:find-article24.png]] in the toolbar or choose '''Edit > Search in page''' from menu bar. You can also use the keyboard shortcuts '''Ctrl+F''' ('''⌘-F''' on Mac) to quickly open the find bar. Kiwix automatically finds the page as you type, highlighting possible matches in green or see where all the matches are located on a page (in pink) by tapping on '''Highlight all''' button in the find bar. Switch between the search results using '''Next''' and '''Previous''' in the find bar and also choose '''Match case''' if you're going to have a case-sensitive search.
:If you have a Bookmark file and you to import it to your Kiwix, click on '''Import Bookmark Set''' icon [[File:open24.png]] in the toolbar panel and then select the .XML file from your computer.
: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".
 
**Reset Bookmark Set: Deletes all the bookmarks from the current ; should it be the Default Set or another. Use with care as it's not reversible.
**Mark this page: Add the current page (document) to the current bookmark set.
**Unmark selected: Removes the selected (on the bookmark list) bookmark from the current set.
*List of opened bookmark sets. Switch from here between your opened (default one and those you imported) sets. Once you close Kiwix, all your sets are closed ; you will need to re-import them next time.
*List of bookmarks in the current set. Each time you mark a document, it is added to that list. Just click on an item to be sent to the corresponding document.
*Notes text input field for the selected bookmark.
 
;Saving personnal notes on bookmarks.
 
You can comment or write notes on each page (document) you bookmark. Notes are included in the bookmark set file ; this way, your comments are shared with your bookmarks.
 
You can only write comments on pages you have bookmarked.
 
To add a note, mark the current page and click on the Notes text box on the bookmark side-panel. The text is saved as you type.
Search inside pages.
 
You can find specific words inside a document by searching for them. To do so, access the Find in page Dialog by going to the Edit ? Search in Page menu item.
 
The dialog allows you to type a word, select some straightforward options and hit Find next to find that exact (minus case) sentence in the current page (document). It's a basic text matching search, not a search engine.
 
;Copy text from pages.
As most applications, Kiwix supports copy-pasting. Select a piece of text using the mouse then click Edit ? Copy and you'll be able to paste that text in any other application ; or on the search engine.


;[[File:searchs24.png]]Search across all documents of the content packages.
;[[File:searchs24.png]]Search across all documents of the content packages.
Administrators, translate-proofr
1,214

edits

Navigation menu