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 faisant partie des autres outils mis à disposition par l'auteur de Kiwix. Kiwix est diffusé sous licence GPL v3 et zimwriterfs a une dépendance pour une bibliothèque diffusée sous licence Apache V2.

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.

Pré-requis

Le fichier README spécifie ces dépendances mais ne précise pas qu'il faut aussi installer les paquets de développement. Si vous ne le faites pas vous risquez d'observer les messages d'erreur de la sorte lors de la compilation :
zimwriterfs.cpp:21:19: erreur fatale: magic.h : Aucun fichier ou dossier de ce type

ou

 > configure: error: lzma header files not found

Pré-requis sur Ubuntu 12.04

Le package libzim n'est pas disponible dans les dépôts. Il faut

  1. récupérer les sources sur http://openzim.org/download (testé avec la version la plus récente du moment : zimlib-1.2.tar.gz 08-Jun-2014).
  2. les compiler et les installer avec la séquence de commandes suivantes
./configure  ; make; make install
Si une fois zimwriterfs installée, vous obtenez le message suivant à l'exécution zimwriterfs: error while loading shared libraries: libzim.so.0: cannot open shared object file: No such file or directory alors une solution possible est de copier les fichiers /usr/local/lib/libzim* dans /usr/lib
cp /usr/local/lib/libzim* /usr/lib

Pré-requis sur Ubuntu 14.04

Ne pas oublier le paquet développement sans quoi vous observerez le message d'erreur suivant à la compilation
zimwriterfs.cpp:23:35: fatal error: zim/writer/zimcreator.h: Aucun fichier ou dossier de ce type
 #include <zim/writer/zimcreator.h>

Installation

Récupérer une version du code source soit en récupérant manuellement un snapshot de kiwix-other ou bien en clonant le dépôt (30 Mib) :

git clone git://git.code.sf.net/p/kiwix/other kiwix-other

Se rendre dans le dossier kiwix-other/zimwriterfs/ puis lancer la configuration de zimwriterfs

./autogen.sh

Puis

./configure

Et la compilation

make

Et enfin l'installation

make install 

Utilisation

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=m/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

Avertissement

Le lecteur Kiwix vous permet de tester les ZIM que vous produisez. Mais attention, la version de Kiwix for linux 0.9-rc2 présente un bug connu : affichage d'un icone lien cassé à la place d'images attendues. Pour remédier à ce problème télécharger la version de Kiwix la plus récente en cours de développement.

Voir aussi


Contributeurs principaux : nicolah.

  • utilisateurs/nicolah/zimwriterfs.txt
  • Dernière modification: Le 28/04/2018, 11:32
  • (modification externe)