Difference between revisions of "Tools/fr"

Jump to navigation Jump to search
6,837 bytes added ,  10 years ago
no edit summary
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Translations}}
{{Translations}}
''This tools are deprecated. Although they may work under certain conditions, we don't provide support for them.''


Les '''Kiwix tools''' sont un ensemble de scripts (le plus souvent en Perl) ayant pour vocation d'aider à la création de contenus exploitables par le logiciel Kiwix.
Les '''Kiwix tools''' sont un ensemble de scripts (le plus souvent en Perl) ayant pour vocation d'aider à la création de contenus exploitables par le logiciel Kiwix.
Line 88: Line 90:
== Générer un fichier ZIM de A à Z ==
== Générer un fichier ZIM de A à Z ==


Il existe de multiple manières d'utiliser ces outils et il est impossible de les lister tous. Cependant semble utile de présenter toutes les étapes nécessaires à la création d'un fichier ZIM.
Il existe de multiple manières d'utiliser ces outils et il est impossible de les lister tous. Cependant semble utile de présenter toutes les étapes nécessaires à la création d'un fichier ZIM. La outils présentés ici ne sont pas parfait, si vous expérimentez des difficultés durant une partie du processus, n'hésitez pas à prendre contact avec les développeurs à l'adresse email suivante : kiwix-developer _arobase_ lists.sourceforge.net (remplacer _arobase_ par @)


=== Étape 1 : choisir sa source ===
=== Étape 1 : choisir sa source ===


Si vous avez déjà vos fichiers HTML statiques (et le reste) alors tout ce qui suit ne sert à rien et il faut vous rendre directement à l'étape  
Si vous avez déjà vos fichiers HTML statiques (et le reste) alors tout ce qui suit ne sert à rien et il faut vous rendre directement à l'[[#Étape 6 : optimiser les fichier HTML et médias associés|étape 6]].
 
Sinon, il vous faut choisir un site web en ligne dont vous souhaitez copier les contenus. Lorsque ce choix sera fait, vérifier bien que ce site fonctionne avec Mediawiki car sinon les Kiwix tools ne pourront vous aider que pour une partie seulement du processus : à partir de l'[[#Étape 6 : optimiser les fichier HTML et médias associés|étape 6]].


=== Étape 2 : créer une instance "miroir" d'un site en ligne ===
=== Étape 2 : créer une instance "miroir" d'un site en ligne ===
Vous pouvez installer Mediawiki "normalement" à partir d'une archive ou à partir de SVN. Cependant la plupart du temps on cherche à avoir quelque chose le plus proche possible de la version qui est en ligne et que l'on souhaite reproduire. Il faut donc ici avoir une version précise de Mediawiki avec quelques extension particulières. Pour faire cela il existe le script mirrorMediawikiCode.pl. C'est une solution bien imparfaite, sachant que il n'est pas possible facilement de connaitre exactement les détails d'une installation de Mediawiki ; mais pour Wikipedia par exemple, ce script vous aidera facilement à avoir une version du code de Mediawiki et des extension proche de la version originale.
Une fois que votre code Mediawiki est présent, vous pouvez l'installer : ce qui signifie en gros le configure de manière basique et créer la base de donnée MySQL associée. installMediawiki.pl est le script adéquat pour faire cela en une seule ligne de commande.
Il est cependant impossible de savoir exactement comment un Mediawiki est configurer... Vous pouvez néanmoins vous inspirer de la configuration utiliser par le projet qui se trouve [http://kiwix.svn.sourceforge.net/viewvc/kiwix/tools/data/conf/default.php?revision=1618&view=markup ici].


=== Étape 3 : copier les contenus de l'original au miroir ===
=== Étape 3 : copier les contenus de l'original au miroir ===
Copier des contenus d'un Mediawiki à un autre est la partie la plus délicate. C'est délicat, car il n'est pas toujours nécessaire de copier tous les contenus et que une page de Mediawiki pour s'afficher correctement peut dépendre de nombreux autres pages : une page peut avoir de nombreuses dépendances.
Pour faire simple, il existe deux types de dépendances : les médias (le plus souvent des images, mais cela peut aussi être des vidéos ou encore tout autre type de fichier) et d'autres pages de texte (le plus souvent des modèles - ou template en anglais). Avant de commencer à copier des contenus il faut vous demander si vous souhaitez copier seulement quelques articles ou l'ensemble des articles.
Si vous souhaitez copier l'ensemble des articles et que le Mediawiki que vous souhaitez reproduire est un de la [http://wikimediafoundation.org Wikimedia Foundation] (comme Wikipedia par exemple), alors le plus simple est de travailler avec les [http://download.wikimedia.org/backup-index.html dumps XML et SQL] fournis... Ce n'est pas simple mais c'est la méthode normale (voir [http://www.mediawiki.org/wiki/Importing_a_Wikipedia_database_dump_into_MediaWiki cette aide]). Un script perl sera écrit bientôt pour faciliter cette tâche (suivre [http://www.mediawiki.org/wiki/Importing_a_Wikipedia_database_dump_into_MediaWiki ceci]). Dans tous les cas il vous restera à copier les images par la suite (enfin si vous le souhaitez).
Si vous ne souhaitez reproduire qu'une sélection des articles, alors mirrorMediawikiCode.pl est le script qu'il vous faut. mirrorMediawikiCode.pl permet de reproduire une liste d'articles avec toutes les dépendances nécessaire au bon affichage des articles.


=== Étape 4 : préparer les contenus à votre façon ===
=== Étape 4 : préparer les contenus à votre façon ===
Créer un mirroir de Mediawiki est reproduire les contenus de l'instance originale de Mediawiki dans ce même mirroir est une méthode sophistiqué et complexe pour finalement avoir un contenu statique... Elle se doit donc d'offrir des avantages. Le plus grand avantage est que cela permet de faire toute sorte de manipulation pour modifier les contenus.
Il est par ce moyen aisé de supprimer certains modèles/templates qui pourraient être dans le cas d'une version statique inutiles voir gênant. C'est le cas de nombreux modèles méta. Pour cela il vous suffit d'établir une liste est d'utiliser le script modifyMediawikiEntry.pl (par exmple avec l'action empty pour vider certains modèles).
Avec ce même script il vous est aussi possible de supprimer toutes les images qui ne sont pas libres... Vous pourrez obtenir la liste à partir de la catégorie adéquate avec le script listCategoryEntries.pl.
Il peut être aussi souhaitable de rajouter les images manquantes. Pour avoir la liste, le script listDependences.pl peut vous être d'une grande aide... ensuite le traditionnel mirrorMediawikiPages.pl fera l'affaire avec les options adéquates.
Il pourra aussi vous être utilise d'avoir exactement les même interwikis que sur l'originale pour éviter de "poluer" votre articles avec des références à des interwikis inexistant. Pour cela le script mirrorMediawikiInterwikis.pl vous aidera.
Ceci ne reste que des exemples, d'autre modifications plus ou moins automatiques sont naturellement envisageables.


=== Étape 5 : créer une version statique du mirroir ===
=== Étape 5 : créer une version statique du mirroir ===
La création d'une version statique du contenu d'un mediawiki se base toujours sur l'extension dumpHtml. C"est une extension standard de Mediawiki et qui est automatiquement installée si vous utilisée le script mirrorMediawikiCode.pl.
Pour que dumpHtml qui est imparfait et mal maintenu fonctionne comme nous le souhaitons de nombreuse modifications ont été apportées... mais tous cela doit être fait automatiquement normalement si vous utilisez mirrorMediawikiCode.pl..
Pour avoir une version statique il faut utiliser le script dumpHtml.pl et créer la version statique dans le répertoire "html" du répertoire root de mediawiki.


=== Étape 6 : optimiser les fichier HTML et médias associés ===
=== Étape 6 : optimiser les fichier HTML et médias associés ===
Nous recommandons d'optimiser les contenus avant la création d'un ZIM, cela peut permettre de gagner au moins 10% en taille. Pour cela il existe le script optimizeContents.pl qui permet de réduire la taille de nombreuses images sans perdre en qualité. Pour cela il faut installer auparavant [https://sourceforge.net/projects/littleutils/ littleutils].


=== Étape 7 : créer un fichier ZIM ===
=== Étape 7 : créer un fichier ZIM ===
Créer un ZIM se fait simplement en utilisant buildZimFileFromDirectory.pl. Il faut pour que cela fonctionne que [http://www.openzim.org/Zimwriter zimwriter] soit installé ainsi que PostreSQL. buildZimFileFromDirectory.pl est un script qui permet de fabriquer un fichier ZIM avec tous les contenus HTML, CSS, PNG, ... présents dans un répertoire.


=== Étape 8 : créer un index de recherche du fichier ZIM ===
=== Étape 8 : créer un index de recherche du fichier ZIM ===
Pour créer un index de recherche, utiliser le binaire kiwix-index. Kiwix peut lui aussi simplement créer un index à partir de n'importe quel fichier ZIM.

Navigation menu