Difference between revisions of "Kiwix 0.9 User Guide"

From Kiwix
Jump to navigation Jump to search
m (title bar)
m (Kelson moved page User guide to Kiwix 0.9 User Guide without leaving a redirect: Part of translatable page "User guide")
 
(32 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{translations}}
<div style="width:99%; float:center"; align=center>
<div style="width:99%; float:center"; align=center>
<div style="margin-bottom:8px; border:2px solid #dfdfdf; padding:1em; background-color:#bcd4e6; -moz-border-radius:15px; -webkit-border-radius:15px;">
<div style="margin-bottom:8px; border:2px solid #dfdfdf; padding:1em; background-color:#bcd4e6; -moz-border-radius:15px; -webkit-border-radius:15px;">
<big>'''User Guide'''<br>A brief instruction includes information on the application's tools and commands ... </big>
<big>
<br>'''[[Help|← Back to help page]]'''
<translate><!--T:8-->
'''User Guide'''
</translate>
<br>
<translate><!--T:9-->
A brief instruction includes information on the application's tools and commands ...  
</translate>
</big>
<br>
<translate><!--T:10-->
'''[[Special:MyLanguage/Help|← Back to help page]]'''
</translate>
</div>
</div>
</div>
</div>
<!-- ------------------------------------------------- -->
<!-- -------------------------------------------------- -->
;Going backward and forward.
<div style="width:99%; float:center"; align=left>
Browsing a Kiwix content, just like on the Internet means going from pages (documents or articles) to pages. You would do this be following links (clicking on them) or by requesting new pages using the search engine. This is called navigating.
<div style="margin-bottom:8px; border:2px solid #dfdfdf; padding:1em; background-color:#eedae3; -moz-border-radius:15px; -webkit-border-radius:15px;">
<translate>== Navigation keys and buttons == <!--T:1-->
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.


To ease your navigation, you can click the Back and Forward buttons located on the toolbar, represented by two arrows.
<!--T:11-->
Should you get lost and want to start a new navigation from the begining (the welcome page), you can use the Home button, close to the navigation ones. It is represented by a house.
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>


;Increasing and Decreasing the size of the text.
<translate>== Adjust the size of the text == <!--T:2-->
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 size of the text at any time. To do so, use the Magnify (to increase) and Reduce (to decrease) buttons to change the size of the text. Those commands are also available from the Display menu.
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 the '''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 level.


;Displaying Kiwix in full-screen.
<!--T:12-->
To gain some extra space on a small display or to remove distractions, you may want to display Kiwix in fullscreen. It will maximize the size of the Kiwix window and hide all other programs including your operating system. The saved space is then used to display more content at once.
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).</translate>


Activate and de-activate it using the Full screen button, next to the Reduce one.
<translate>== Printing and exporting documents == <!--T:3-->
You can print the Kiwix pages or even export and share them. There are three options available:</translate>
<translate><!--T:21-->
* To print a page you are viewing in Kiwix, click on the '''Print''' icon [[File:print24.png|link=]] in the toolbar or press '''Ctrl+P''' ('''⌘-P''' on Mac). This option is also available in '''File''' menu. You will 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.</translate>
<translate><!--T:22-->
* To export a page to PDF format, go to '''File > [[File:printas-pdf16.png|link=]] Print as PDF''' menu item or just press '''Ctrl+Shift+D''' ('''⌘-Shift-D''' on Mac). It will convert the page into a PDF file which can be used to print or read the document later. Note that the output has been prepared for printing and the internal links will be removed from the page.</translate>
<translate><!--T:23-->
* 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.</translate>


;Printing and exporting documents.
<translate>== Creating and using bookmarks == <!--T:4-->
Just like on the Web, you can print any Kiwix document (including this one) or export it and share. Three options are available:
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.
*Print a document using the Print button (representing a printer).
*Export a document in PDF, using the File ? Print as PDF menu item. It will create a file which can be used to print or read the document later. Note that it will be formatted for priting and will thus remove the links.
*Save the document as an HTML file. It's not ideal for sharing but will keep the same formatting and links.


;Bookmarking pages.
<!--T:13-->
You can mark some pages (documents) to access them directly afterwards.
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.


Bookmarks are organised in sets. A set is a list (or group) of bookmarks that live together. Because you can easily import or export (a set is saved as a regular file on your computer) a complete set of bookmarks (using the Import or Create buttons on the bookmarks side-bar), it is easy to share a list of documents ; with your students for example.
<!--T:14-->
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.</translate>


The bookmarking feature is reachable by clicking on the Bookmarks button. It will open a panel on the side of the screen. The panel contains, in order:
<translate>== Editing tools == <!--T:5-->
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|link=]] in the toolbar or choose '''Edit > Search in page''' from menu bar. You can also use the keyboard shortcut '''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 the '''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 are going to have a case-sensitive search.


*The action buttons
<!--T:15-->
**Create new set: Create an empty set in a new file on your computer. Each time you add or delete a bookmark to the set, the file is updated. Share this file for backup or for someone else to import.
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".</translate>
**Import set: Select a previously saved (or retrieved) Kiwix bookmark file to import a complete set, including notes.
**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.
<translate>== Full-text search engine and Indexing process == <!--T:6-->
[[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 [[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.


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.
<!--T:16-->
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.</translate>


You can only write comments on pages you have bookmarked.
<translate><!--T:24-->
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.</translate>


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.
<translate><!--T:25-->
Search inside pages.
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.


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.
<!--T:17-->
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.


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.
<!--T:18-->
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.</translate>


;Copy text from pages.
<translate>== More options == <!--T:7-->
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.
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. You can also change 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.


;Search across all documents of the content packages.
<!--T:19-->
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.


Kiwix includes a powerful search engine to help you easily access the documents you are looking for.
<!--T:20-->
 
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>
To use the search engine, you must first enable it by creating the indexes. This steps may have already been done for you.
</div>
 
</div>
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.

Latest revision as of 20:08, 6 February 2024

Other languages:
English • ‎español • ‎français • ‎italiano • ‎magyar • ‎русский • ‎فارسی • ‎中文(中国大陆)‎ • ‎日本語

User Guide
A brief instruction includes information on the application's tools and commands ...

← Back to help page

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 Home24.png 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 page as the homepage and it means there is no content to display. In that case, you should follow the instructions of 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 Go-back24.png and go to the next page by clicking on the Forward arrow icon Go-forward24.png in the toolbar. To open the New Tab page, click on the Open a new tab icon Add24.png next the last tab at the top of the window or press Ctrl+T (⌘-T on Mac). To close a tab, use the Close12.png 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

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 Zoom-in24.png to increase and the Reduce icon Zoom-out24.png to decrease the size of the text. Those commands are also available in Display > Zoom on the menu bar and one more option named Zoom-10016.png 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 level.

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 Fullscreen24.png or use the keyboard shortcut F11 (⌘-Shift-F on Mac).

Printing and exporting documents

You can print the Kiwix pages or even export and share them. There are three options available:

  • To print a page you are viewing in Kiwix, click on the Print icon Print24.png in the toolbar or press Ctrl+P (⌘-P on Mac). This option is also available in File menu. You will 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 export a page to PDF format, go to File > Printas-pdf16.png Print as PDF menu item or just press Ctrl+Shift+D (⌘-Shift-D on Mac). It will convert the page into a PDF file which can be used to print or read the document later. Note that the output has been prepared for printing and the internal links will be removed from the page.
  • To save the page as an HTML or text file, go to File > Saveas16.png 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 Bookmarks24.png 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 New24.png 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 Open24.png 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 Add24.png 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 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 the next time.

Editing 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 Find-article24.png in the toolbar or choose Edit > Search in page from menu bar. You can also use the keyboard shortcut 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 the 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 are going to have a case-sensitive search.

Kiwix also supports copy-pasting feature. In order to do that, select a part of the text using the mouse and then choose Edit > Copy16.pngCopy 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 > Select-all16.png 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

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 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 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 Indexing-progress.png), 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

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. You can also change 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 Wikipedia, there is an option named Select-all16.png Random article in the Tools menu, which shows a random article of the ZIM content. Another option of this menu is Purge-history16.png 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.