Difference between revisions of "Build your ZIM file"
Jump to navigation
Jump to search
m (Fixed typos and added clarification) |
|||
| Line 1: | Line 1: | ||
[[Image:Schema ZIM File Creation.png|500px|right]] | [[Image:Schema ZIM File Creation.png|500px|right]] | ||
There is currently only one binary to build a ZIM file, the [[ZIMwriter]]. This binary uses a pre-filled Postgres Database with a [http://svn.openzim.org/viewvc.cgi/trunk/zimwriter/db/zim-postgresql.sql?view=markup | There is currently only one binary to build a ZIM file, the [[ZIMwriter]]. This binary uses a pre-filled Postgres Database with a [http://svn.openzim.org/viewvc.cgi/trunk/zimwriter/db/zim-postgresql.sql?view=markup predefined scheme]. For example : | ||
<source lang="bash"> | <source lang="bash"> | ||
| Line 9: | Line 9: | ||
We want to provide in the future a binary able to work with other input (for example: Wikimedia Foundation XML dumps, or HTML directory). | We want to provide in the future a binary able to work with other input (for example: Wikimedia Foundation XML dumps, or HTML directory). | ||
One tool is currently able to create/fill this database: | |||
== buildZimFileFromDirectory.pl == | == buildZimFileFromDirectory.pl == | ||
| Line 16: | Line 16: | ||
You need: | You need: | ||
# Checkout the dumping tools : svn co http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/ | # Checkout the dumping tools : svn co http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/ | ||
# Install all necessary | # Install all necessary Perl modules | ||
# run the script like following: ./ | # run the script like following: ./buildZimFileFromDirectory.pl --htmlPath=./html [--indexerPath=./zimindexer] [--zimFilePath=articles.zim] | ||
== [[Wiki2html]] == | == [[Wiki2html]] == | ||
. | (can be used to prepare static HTML files from a running Mediawiki instance.) | ||
== See also == | == See also == | ||
* [[Publish your ZIM File]] | * [[Publish your ZIM File]] | ||
Revision as of 22:58, 23 September 2009
There is currently only one binary to build a ZIM file, the ZIMwriter. This binary uses a pre-filled Postgres Database with a predefined scheme. For example :
zimwriter -s 1024
--db "postgresql:dbname=mydb" my_zim_file
We want to provide in the future a binary able to work with other input (for example: Wikimedia Foundation XML dumps, or HTML directory).
One tool is currently able to create/fill this database:
buildZimFileFromDirectory.pl
This script is part of the Kiwix tools and allows to build a ZIM file from a HTML directory containing all necessary ressources.
You need:
- Checkout the dumping tools : svn co http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/
- Install all necessary Perl modules
- run the script like following: ./buildZimFileFromDirectory.pl --htmlPath=./html [--indexerPath=./zimindexer] [--zimFilePath=articles.zim]
Wiki2html
(can be used to prepare static HTML files from a running Mediawiki instance.)