zimwriterfs

L'application zimwriterfs est un outil en ligne de commande destiné à produire une archive au format ouvert ZIM) à partir d'un répertoire local contenant un site web fonctionnant hors-ligne (avec images, code Javascript et feuilles de style CSS). Le fichier généré peut être lu à l'aide d'un lecteur ZIM tel que par exemple Kiwix.

zimwriterfs est un outil autonome développé par la fondation opemzim. Auparavant, il faisait partie des autres outils mis à disposition par l'auteur de Kiwix.

Parmi les contenus accessibles hors ligne à ce format, on compte Wikipédia dans toutes les langues, la collection des livres de la communauté Wikipedia mais aussi la documentation hors ligne de Ubuntu.

D'autres outils permettent la construction de fichiers ZIM mais ils sont intrinsèquement liés au wiki MediaWiki.

• Disposer des droits d'administration.
• Disposer d'une connexion à Internet configurée et activée.
• Avoir installé la GNU autotools suite automake et autoconf
• Avoir installé le paquet liblzma5 - librairie de compression au format XZ et celui de développement liblzma-dev (http://tukaani.org/xz/)
• Avoir installé le paquet libmagic1 - librairie de recherche des types MIME des fichiers et celui de développement libmagic-dev (http://www.darwinsys.com/file/)
• gcc - le compilateur C ou tout autre compilateur C;
• g++ - le compilateur C++, libtool pkg-config liblzma-dev libmagic-dev zlib1g-dev libgumbo-dev icu-devtools libicu-dev
• checkinstall (optionnel). Ce paquet permet de créer un paquet deb, valide uniquement sur le pc, permettant une désinstallation du logiciel directement par le gestionnaire de paquet. Voir Compilation sous Ubuntu
• Avoir installé le paquet library implementation of ZIM specifications (à partir d'Ubuntu 16.04 c'est le paquet libzim0v5), et celui de développement libzim-dev.

Il est également nécessaire d'installer la dernière version de xapian, pour cela :

• Ajouter le PPA ppa:xapian-backports/ppa¹⁾ dans vos sources de logiciels;
• recharger la liste des paquets;
• installer le paquet xapian-tools,libxapian-dev.

Pour récupérer une version du code source, il faut télécharger l'archive directement sur github. Puis, il faut la décompresser et se rendre dans le dossier openzim-master. Une fois dans le dossier, ouvrez-y un terminal et exécutez les commandes suivantes :

cd ../zimlib && ./autogen.sh && ./configure && make && cd ../zimwriterfs

Lancer la génération du Makefile:

./autogen.sh

Puis la configuration de zimwriterfs :

./configure CXXFLAGS=-I../zimlib/include LDFLAGS=-L../zimlib/src/.libs

Puis la compilation :

make

Et enfin l'installation :

sudo make checkinstall

Ou bien (déconseillé) :

sudo make install

Lancez l'application via le terminal (toutes versions d'Ubuntu) avec la commande suivante :

zimwriterfs 

Sans argument, vous obtiendrez la sortie suivante :

You have too few arguments!
zimwriterfs --welcome=index.html --favicon=favicon.png --language=fra --title=foobar --description=mydescription --creator=Wikipedia --publisher=Kiwix [--minChunkSize=1024] DIRECTORY ZIM
	DIRECTORY is the path of the directory containing the HTML pages you want to put in the ZIM file,
	ZIM       is the path of the ZIM file you want to obtain.

Il est nécessaire de spécifier tous les paramètres (y compris le favicon).

• Le DIRECTORY désigne un chemin vers un répertoire contenant votre un site web fonctionnant hors-ligne
• les paramètres welcome et favicon désignent des chemins relatifs à DIRECTORY

• (en) Site officiel du logiciel zimwriterfs
• (en) La spécification du format ZIM
• (en) Lecteurs ZIM (avec/sans GUI, en python, en java…)
• (en) Liste d'outils pour construire des fichiers ZIM
• ZImmer alternative à zimwriterfs.

Contributeurs principaux : nicolah, Darkjam.