Accueil du site > Outils de publication > FreepapeR > Le plugin SPIP FreepapeR v0.5.0

Le plugin SPIP FreepapeR v0.5.0

visualiser les fichiers PDF dans les pages WEB

lundi 7 juillet 2008, par Franck Ruzzin

Pagegangster, Motion Paper, scribd.com, myplick.com..... tous ces sites proposent la publication en ligne de vos documents PDF.
Il faut pour cela au préalable uploader ses documents sur les serveurs du prestataire choisi, un peu à la manière des YouTube ou Flickr.
FreepapeR aussi permet la visualisation en ligne de fichiers PDF, mais il s’installe sur son propre serveur et les documents que l’on affiche ne quittent jamais le domaine, ne sont jamais altérés, sont toujours disponibles...




I - Pourquoi FreepapeR


Pagegangster, Motion Paper, scribd.com, myplick.com..... tous ces sites proposent la publication en ligne de vos documents PDF. Il faut pour cela au préalable uploader ses documents sur les serveurs du prestataire choisi, un peu à la manière des YouTube ou Flickr.

Cela ne pose pas de problème dans la majorité des cas. Cependant, on ne souhaite parfois pas que ses documents deviennent publics, qu’ils soient analysés par des robots ou encore que de la publicité y soit inséré.

FreepapeR aussi permet la visualisation en ligne de fichiers PDF, mais il s’installe sur son propre serveur et les documents que l’on affiche ne quittent jamais le domaine, ne sont jamais altérés, sont toujours disponibles...

Le principe est le suivant :

- Le document à visualiser est déjà situé sur le serveur
- Il est converti grâce à la boite à outil (GPL) swftools .Ainsi, on obtient un nouveau fichier, qui est la version SWF du fichier PDF original
- On utilise un programme SWF pour naviguer dans le fichier généré

Remarque : Cette méthode de présentation d’information ne permet pas, à la différence de l’écriture textuelle le référencement par les moteurs de recherche, le document étant « caché » au monde par le lecteur SWF. Il y a toujours moyen de trouver des artifices tels qu’insérer dans la page du contenu textuel caché, mais cela est néanmoins à déconseiller.

Bien entendu, il faut idéalement pouvoir exécuter des routines de la boite à outils swftools sur le serveur, ce qui est sans doute le point le plus délicat. Mais nous verrons par la suite des méthodes alternatives permettant de contourner ce point, notamment dans le cas des hébergements mutualisés sans accès SSH.

II- Implantation du plugin


Extraire le contenu de l’archive freepaper-spip.0.5.0.zip, dans le dossier plugins de votre installation SPIP.

L’activer via l’administration des plugins. (Consulter la documentation officielle pour plus de détails.)

Dans ce plugin, on utilise l’utilitaire javascript d’installation d’objet Flash swfobject 2.0, disponible à l’adresse suivante : http://code.google.com/p/swfobject/

En conséquence, il conviendra d’intégrer ce fichier dans la partie « head » des pages qui doivent utiliser le plugin :

<script type="text/javascript" src="#CHEMIN{javascript/swfobject.js}"></script>
par exemple, si la librairie swfobject est dans le répertoire « /javascript » de votre installation SPIP.

III- La balise #FREEPAPER


Lorsque le plugin est activé, on dispose de la balise #FREEPAPER qui liste tous les documents « pdf » joints à l’article et intègre pour chacun d’eux un lecteur FreepapeR dans la page, avec les valeurs par défaut.

Les paramètres suivant permettent de modifier le comportement par défaut :

#FREEPAPER{largeur=nbPixels} largeur de la page FreepapeR. Défaut : 600
#FREEPAPER{hauteur=nbPixels} hauteur de la page FreepapeR. Défaut : 800
#FREEPAPER{trace="true" ou "false"} activation du mode verbeux. Défaut : false

Ainsi

#FREEPAPER{largeur=300}{hauteur=400}{trace=true}

implante un lecteur FreepapeR de largeur 300px, de hauteur 400px avec le mode trace activé (utile en phase de création des squelettes pour déceler les problèmes éventuels).


IV - Le modèle contentfreepaper


Lorsque le plugin est activé, il permet l’utilisation du modèle contentfreepaper dans le corps des articles.

La syntaxe complète est :

<contentfreepaperxxx            ou xxx est l'id du document PDF à visualiser
|hauteur=(nbPixels)             -> par défaut 600
|largeur=(nbPixels)             -> par défaut 800
|trace=(true ou false)          -> par défaut false
>

Remarque : Dans l’espace d’administration, les lecteurs FreepapeR implantés par modèle sont représentés par l’image « Get FLASH PLAYER ». Cela est normal. On visualise ainsi qu’il y a à cet endroit de l’article un objet implanté, mais voir son contenu n’a pas d’intérêt ici.

On obtient dans la page publique du site un lecteur FreepapeR avec le document à visualiser chargé :

 

Enfin presque !
Pour que tout se déroule comme précédemment décrit, il faut encore installer la boîte à outils SWFTOOLS qui va prendre en charge la conversion du fichier PDF en SWF. L’installation est décrite en 5, des solutions alternatives sont décrites en 6.


V - Installer la boîte à outils swftools


Se rendre sur le site http://www.swftools.org/download.html et récupérer l’archive :

swftools-yyyy-mm-dd-vvvv.rar pour un système windows
swftools-yyyy-mm-dd-vvvv.tar.gz pour un système linux

1. Windows
Extraire les fichiers de l’archive, puis placer l’exécutable pdf2swf.exe sur le serveur, à la racine du dossier du plugin FreepapeR.

2. Linux
Extraire les fichiers de l’archive, et les placer sur le serveur dans un dossier temporaire.
Se connecter par SSH au serveur (cela suppose d’avoir un accès SSH), se rendre dans le dossier temporaire ou l’on a extrait les fichiers, puis lancer les commandes :

./configure (ayant auparavant réglé le bit d’exécution de ce fichier à 1)

Lorsque le traitement est terminé, lancer

make

On peut s’arrêter là, puis copier le binaire pdf2swf depuis le dossier ’src’ pour le placer à la racine du dossier du plugin FreepapeR. Bien penser à s’accorder les droits de lecture et d’exécution sur ce fichier.

3. Puis dans les deux cas
Ouvrir le fichier php/pdf2swf.php et vérifier le contenu de la variable pdftoolsPath pour qu’elle indique le chemin vers l’exécutable pdf2swf, par exemple :
$this->pdftoolsPath='../';      //linux
ou
$this->pdftoolsPath='..\\';     //windows

Dans le dossier qui contient un PDF à visualiser, le système doit pouvoir créer un fichier avec l’extension pdf.swf : il faut donc avoir les droits en lecture et en écriture dans ce dossier.


VI - Je ne peux pas installer swftools sur mon serveur


Sans accès SSH, point de salut, on ne peut fabriquer le binaire pdf2swf.

Il y a des pistes alternatives :

- J’ai trouvé un binaire pour ma distribution Linux
Dans ce cas, il suffit de placer ce binaire à la racine du dossier du plugin FreepapeR, puis de régler la variable $this->pdftoolsPath, comme décrit en 5-3.

- Je télécharge le binaire en local, je converti les PDF en local, puis je place les fichiers sur le serveur qui héberge mon site SPIP.
On procède comme décrit en 5-1 puis 5-2, mais en installant pdf2swf en local.

Il faut ensuite convertir en local les fichiers PDF à visualiser. La ligne de commande pour produire le fichier swf est la suivante :

pdf2swf -t -o documentAVisualiser.pdf.swf documentAVisualiser.pdf

si le fichier PDF à convertir s’appelle documentAVisualiser.pdf par exemple.

Pour terminer, il faut joindre le fichier pdf à l’article requis, mais aussi placer sur le serveur le fichier converti pdf.swf (et dans cet ordre !).

Pour cela, il y a 2 possibilités :

- Soit on upload par ftp dans le dossier IMG/pdf le fichier converti *.pdf.swf correspondant au fichier pdf joint à l’article (donc de même préfixe).
- Soit on joint le document pdf.swf à l’article grâce à l’outil "Ajouter un document" de SPIP.

En effet, Lorsque le plugin SPIP FreepapeR s’initialise et cherche à restituer un fichier PDF joint à l’article :
s’il existe un fichier « pdf.swf » situé dans le dossier IMG/pdf et qui est plus récent que le fichier « pdf », alors le comportement habituel est d’afficher ce document « pdf.swf ».
Cependant, si le binaire pdf2swf n’est pas installé sur le serveur, alors le document « pdf.swf » est aussi recherché dans le dossier IMG/swf.


V- Erreur rencontrées lors de la conversion


EXEC RETURN VALUE : 0 -> tout s’est bien déroulé
EXEC RETURN VALUE : 1 -> le fichier pdf2swf n’a pas été trouvé
EXEC RETURN VALUE : 6 -> fichier PDF non lisible
EXEC RETURN VALUE : 11 -> erreur de segmentation (pdf2swf invalide)
EXEC RETURN VALUE : 126 -> pdf2swf a été trouvé mais n’est pas exécutable
EXEC RETURN VALUE : 127 -> le fichier pdf2swf n’a pas été trouvé

 

VI- pdf2swf pour les serveurs 1&1


Ce binaire fonctionne pour les hébergements du fournisseur d’accès 1&1
GZ - 1.2 Mo
pdf2swf pour les serveurs 1&1

 

 

Creative Commons License Le plugin SPIP FreepapeR est mis à disposition selon les termes de la licence Creative Commons Paternité-Partage des Conditions Initiales à l’Identique 2.0 France.

Documents joints

Répondre à cet article