Tell us your story
Tell us your story
How has offline Wikipedia affected you? The Wikimedia Foundation (the non-profit that supports Wikipedia) is looking for personal, diverse and inspiring stories about how offline Wikipedia affects the world. If you have a personal story that you would like to share, please contact: stories@kiwix.org. Thank you!

Difference between revisions of "FAQ"

From Kiwix
Jump to: navigation, search
(New entry)
(Remove documentation about splitting ZIM files)
 
(48 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 
{{translations}}
 
{{translations}}
 
<translate><!--T:15-->
 
<translate><!--T:15-->
This is the Kiwix '''Frequently Asked Questions''' (or '''FAQ''') page. If you don't find an answer to your question, please consider to read the [[Special:MyLanguage/Help|Help page]] or visit our [http://forum.kiwix.org Forum].</translate>
+
This is the Kiwix '''Frequently Asked Questions''' (or '''FAQ''') page. If you don't find an answer to your question, please consider reading the [[Special:MyLanguage/Help|Help page]] or visit our [http://forum.kiwix.org Forum].</translate>
 +
 
 +
{{FAQ_entry|question=<translate><!--T:3-->
 +
Where can I find new content?</translate>|answer=<translate><!--T:4-->
 +
Kiwix uses the [http://openzim.org ZIM format]. We release [[{{ll|Wikipedia in all languages}}|our own ZIM files]] which are available for download in the Kiwix library (in the software). You can also use the [https://en.wikipedia.org/wiki/Special:Book Book creator] on Wikipedia to generate your own ZIM files.</translate>}}
 +
 
 +
{{FAQ_entry|question=<translate><!--T:25-->
 +
My ZIM file is too big, what should I do?</translate>|answer=<translate><!--T:26-->
 +
USB flash drives and memory cards are often formatted using the FAT32 filesystem which can't store files bigger than 4GB. Better use exFat, or any modern filesystem, and then you will be able to store big ZIM files.</translate>}}
  
 
{{FAQ_entry|question=<translate><!--T:1-->
 
{{FAQ_entry|question=<translate><!--T:1-->
 
Why is Kiwix not available for PPC Macs?</translate>|answer=<translate><!--T:2-->
 
Why is Kiwix not available for PPC Macs?</translate>|answer=<translate><!--T:2-->
 
We do not have a PPC architectured Mac and this architecture is outdated.</translate>}}
 
We do not have a PPC architectured Mac and this architecture is outdated.</translate>}}
 
{{FAQ_entry|question=<translate><!--T:3-->
 
Where can I find new content?</translate>|answer=<translate><!--T:4-->
 
Kiwix uses the [http://openzim.org ZIM format]. We release our own ZIM files which are available for download in the Kiwix library (in the software). You can also use the [https://en.wikipedia.org/wiki/Special:Book Book creator] on Wikipedia to generate your own ZIM files.</translate>}}
 
  
 
{{FAQ_entry|question=<translate><!--T:5-->
 
{{FAQ_entry|question=<translate><!--T:5-->
Line 17: Line 21:
 
{{FAQ_entry|question=<translate><!--T:7-->
 
{{FAQ_entry|question=<translate><!--T:7-->
 
How can I build a ZIM file by myself?</translate>|answer=<translate><!--T:8-->
 
How can I build a ZIM file by myself?</translate>|answer=<translate><!--T:8-->
To export articles from Wikipedia, please go to [http://en.wikipedia.org/w/index.php?title=Special:Book this page]. For any other use case, this is unfortunately still too complicated. Please read [https://openzim.org/Build_your_ZIM_file this page] if you want to have some information.</translate>}}
+
To export articles from Wikipedia and other Wikimedia projects, please go to their [http://en.wikipedia.org/w/index.php?title=Special:Book Special:Book]. For any other use case, this is unfortunately still too complicated (in short: Parsoid needs to be [<tvar|1>https://www.mediawiki.org/wiki/Parsoid/Setup</> installed], then [https://sourceforge.net/p/kiwix/other/ci/master/tree/mwoffliner/mwoffliner.js mwoffliner] + zimwriterfs). Please read [http://openzim.org/Build_your_ZIM_file this page] if you want to have some information.</translate>}}
  
 
{{FAQ_entry|question=<translate><!--T:9-->
 
{{FAQ_entry|question=<translate><!--T:9-->
Line 24: Line 28:
  
 
{{FAQ_entry|question=<translate><!--T:11-->
 
{{FAQ_entry|question=<translate><!--T:11-->
How to install a pre-indexed ZIM file on Mac OSX?</translate>|answer=<translate><!--T:12-->
+
How to install a pre-indexed ZIM file on Mac OS X?</translate>|answer=<translate><!--T:12-->
 
Move or copy the "data" directory in "/Applications/Kiwix.app/Contents/". You will probably need to go to the Kiwix "library" to load the ZIM content.</translate>}}
 
Move or copy the "data" directory in "/Applications/Kiwix.app/Contents/". You will probably need to go to the Kiwix "library" to load the ZIM content.</translate>}}
  
 
{{FAQ_entry|question=<translate><!--T:13-->
 
{{FAQ_entry|question=<translate><!--T:13-->
Is there a user forum where kiwix users can exchange experiences and help each other?</translate>|answer=<translate><!--T:14-->
+
Is there a user forum where Kiwix users can exchange experiences and help each other?</translate>|answer=<translate><!--T:14-->
 
Yes, it is located at [http://forum.kiwix.org https://forum.kiwix.org]</translate>}}
 
Yes, it is located at [http://forum.kiwix.org https://forum.kiwix.org]</translate>}}
  
 
{{FAQ_entry|question=<translate><!--T:16-->
 
{{FAQ_entry|question=<translate><!--T:16-->
I have downloaded a ZIP file (pre-indexed ZIM file) but I can't unpack it, the file seems to be corrupted. What should I do?</translate>|answer=<translate><!--T:17-->
+
I have downloaded a ZIP file (pre-indexed ZIM file) but I can't unzip it, the file seems to be corrupted. What should I do?</translate>|answer=<translate><!--T:17-->
Use an unpacking software which supports the ZIP64 format (ZIP format for big files), like for example [http://www.7-zip.org/ 7-zip]. If this still fails, then your file was corrupted during the transfer, please restart the download using Bittorrent, then it will work.</translate>}}
+
Use an unpacking software which supports the ZIP64 format (ZIP format for big files), like for example [http://www.7-zip.org/ 7-zip]. If this still fails, then your file was corrupted during the transfer, please restart the download using BitTorrent, then it will work.</translate>}}
 +
 
 +
{{FAQ_entry|question=<translate><!--T:42-->
 +
How do I check the integrity of my ZIM file?</translate>|answer=<translate><!--T:43-->
 +
You can retrieve the checksums for each file we serve online using this pattern: <source>kiwix-filename.zim.mirrorlist</source>Example: <source>https://download.kiwix.org/zim/wikipedia/wikipedia_en_all_novid_2018-06.zim.mirrorlist</source></translate>}}
  
 
{{FAQ_entry|question=<translate><!--T:21-->
 
{{FAQ_entry|question=<translate><!--T:21-->
I can't copy Kiwix on my USB flash drive because the index file is too big.</translate>|answer=<translate><!--T:22-->
+
I can't copy Kiwix on my USB flash drive because the index files (*.idx directory) are too big.</translate>|answer=<translate><!--T:22-->
USB flash drives are often formated using the FAT32 filesystem which can't store files bigger than 4GB. We recommend to use NTFS which can deal with big files and is broadly supported.</translate>}}
+
USB flash drives are often formatted using the FAT32 filesystem which can't store files bigger than 4GB. We recommend to use [http://en.wikipedia.org/wiki/ExFAT exFAT] or [http://en.wikipedia.org/wiki/NTFS NTFS] which can deal with big files and are broadly supported.</translate>}}
 +
 
 +
{{FAQ_entry|question=<translate><!--T:23-->
 +
How can I launch Kiwix with a specific article?</translate>|answer=<translate><!--T:24-->
 +
You need to launch Kiwix from the command line using the -articleByUrl option. For example:</translate><source lang="bash">kiwix.exe -articleByUrl "zim://A/foo.html" bar.zim</source>}}
 +
 
 +
{{FAQ_entry|question=<translate><!--T:31-->
 +
I have a downloaded a .torrent file, but the download does not progress in my BitTorrent client.</translate>|answer=<translate><!--T:32-->
 +
There are a few reasons why the download with BitTorrent might failed, most of them are related to the usage of [https://en.wikipedia.org/wiki/BitTorrent#Web_seeding web seeds]:</translate>
 +
* <translate><!--T:33-->
 +
Your computer is behind a proxy, you need to configure your BitTorrent correctly to use it</translate>.
 +
* <translate><!--T:34-->
 +
Your computer is part of a local network with custom network rules forbidding the BitTorrent usage, you should complain to your network system administrator.</translate>
 +
* <translate><!--T:35-->
 +
Your BitTorrent client does not support web seeds (correctly), please try with a better one (for example, [http://deluge-torrent.org/ Deluge]).</translate>}}
  
{{FAQ_entry|question=<translate>How can I launch Kiwix with a specific article?</translate>|answer=<translate>You need to launch Kiwix from the command line using the -articleByUrl option. For example:</translate><source lang="bash">kiwix.exe -articleByUrl "zim://A/foo.html" bar.zim</source>}}
+
{{FAQ_entry|question=<translate><!--T:36-->
 +
Where are located, on my computer, the content files I have downloaded?</translate>|answer=<translate>
 +
<!--T:37-->
 +
If you have used the Kiwix library, the content are stored:</translate>
 +
<translate><!--T:38-->
 +
* On OS X:</translate> <source lang="bash">/Users/<LOGIN>/Library/Application Support/Kiwix/Profiles/<PROFILE>/data/</source>
 +
<translate><!--T:39-->
 +
* On GNU/Linux:</translate> <source lang="bash">/home/<LOGIN>/.www.kiwix.org/kiwix/<PROFILE>/data/</source>
 +
<translate><!--T:40-->
 +
* On Windows:</translate> <source lang="bash">C:Documents and Settings<LOGIN>Application Datawww.kiwix.orgKiwixProfiles<PROFILE>data</source>}}
  
 
== <translate><!--T:18-->
 
== <translate><!--T:18-->

Latest revision as of 08:26, 19 March 2020

Other languages:
العربية • ‎azərbaycanca • ‎বাংলা • ‎català • ‎Deutsch • ‎English • ‎español • ‎فارسی • ‎français • ‎galego • ‎magyar • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎lietuvių • ‎Bahasa Melayu • ‎Nederlands • ‎polski • ‎português • ‎русский • ‎Türkçe • ‎中文 • ‎中文(简体)‎

This is the Kiwix Frequently Asked Questions (or FAQ) page. If you don't find an answer to your question, please consider reading the Help page or visit our Forum.

Where can I find new content?
Kiwix uses the ZIM format. We release our own ZIM files which are available for download in the Kiwix library (in the software). You can also use the Book creator on Wikipedia to generate your own ZIM files.
My ZIM file is too big, what should I do?
USB flash drives and memory cards are often formatted using the FAT32 filesystem which can't store files bigger than 4GB. Better use exFat, or any modern filesystem, and then you will be able to store big ZIM files.
Why is Kiwix not available for PPC Macs?
We do not have a PPC architectured Mac and this architecture is outdated.
Is it possible to update a ZIM file?
It is not possible to update a ZIM file itself, but you may download a new ZIM file with updated versions of the contents.
How can I build a ZIM file by myself?
To export articles from Wikipedia and other Wikimedia projects, please go to their Special:Book. For any other use case, this is unfortunately still too complicated (in short: Parsoid needs to be installed, then mwoffliner + zimwriterfs). Please read this page if you want to have some information.
How may I optimize the search engine index?
Launch the script "./kiwix-compact" (only available on GNU/Linux) and this should reduce disk use by almost 50%
How to install a pre-indexed ZIM file on Mac OS X?
Move or copy the "data" directory in "/Applications/Kiwix.app/Contents/". You will probably need to go to the Kiwix "library" to load the ZIM content.
Is there a user forum where Kiwix users can exchange experiences and help each other?
Yes, it is located at https://forum.kiwix.org
I have downloaded a ZIP file (pre-indexed ZIM file) but I can't unzip it, the file seems to be corrupted. What should I do?
Use an unpacking software which supports the ZIP64 format (ZIP format for big files), like for example 7-zip. If this still fails, then your file was corrupted during the transfer, please restart the download using BitTorrent, then it will work.
How do I check the integrity of my ZIM file?
You can retrieve the checksums for each file we serve online using this pattern:
kiwix-filename.zim.mirrorlist
Example:
https://download.kiwix.org/zim/wikipedia/wikipedia_en_all_novid_2018-06.zim.mirrorlist
I can't copy Kiwix on my USB flash drive because the index files (*.idx directory) are too big.
USB flash drives are often formatted using the FAT32 filesystem which can't store files bigger than 4GB. We recommend to use exFAT or NTFS which can deal with big files and are broadly supported.
How can I launch Kiwix with a specific article?
You need to launch Kiwix from the command line using the -articleByUrl option. For example:
kiwix.exe -articleByUrl "zim://A/foo.html" bar.zim
I have a downloaded a .torrent file, but the download does not progress in my BitTorrent client.
There are a few reasons why the download with BitTorrent might failed, most of them are related to the usage of web seeds:
  • Your computer is behind a proxy, you need to configure your BitTorrent correctly to use it.
  • Your computer is part of a local network with custom network rules forbidding the BitTorrent usage, you should complain to your network system administrator.
  • Your BitTorrent client does not support web seeds (correctly), please try with a better one (for example, Deluge).
Where are located, on my computer, the content files I have downloaded?
If you have used the Kiwix library, the content are stored:
  • On OS X:
    /Users/<LOGIN>/Library/Application Support/Kiwix/Profiles/<PROFILE>/data/
    
  • On GNU/Linux:
    /home/<LOGIN>/.www.kiwix.org/kiwix/<PROFILE>/data/
    
  • On Windows:
    C:Documents and Settings<LOGIN>Application Datawww.kiwix.orgKiwixProfiles<PROFILE>data
    

See also