Accueil du site > Outils de publication > FreepapeR > Le lecteur FreepapeR v0.7.0

Le lecteur FreepapeR v0.7.0

Visualiser les fichiers PDF dans les pages WEB

samedi 29 novembre 2008, par Franck Ruzzin

FreepapeR permet la visualisation en ligne de fichiers PDF. Il s’installe sur un serveur web et nécessite uniquement l’utilisation de php.



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.

Pour faire fonctionner cet outil, il faut un serveur WEB et php 4 ou 5. 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 lecteur FreepapeR


Extraire le contenu de l’archive freepaper.0.7.0.zip, dans le dossier de votre choix. Si vous souhaitez une structure de fichier différente de celle proposée, il faudra penser à éditer les deux variables situées en début du fichier freepaper.js :

var m_freepaper_swfUrl="swf/freepaper.0.7.0.swf"; //chemin et nom vers le fichier swf "freepaper.swf"
var m_freepaper_phpURL="php/freepaper.php";        //URL du script PHP freepaper.php

On utilise la boîte à outils javascript swfobject 2.0.

Note : la documentation sur l’usage de swfobject ainsi que le téléchargement de l’archive se fait à l’adresse suivante : http://code.google.com/p/swfobject/


1) Importer dans la partie <head> de la page les fichiers javascript swfobject.js et freepaper.js.


<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr" lang="fr">
<head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <title>Utilisation de FreepapeR</title>
        <script type="text/javascript" src="javascript/swfobject.js"></script>
        <script type="text/javascript" src="javascript/freepaper.js"></script>
</head>


2) Ajouter le code indiquant le point d’insertion du lecteur FreepapeR dans la page :


<div id="freepaper1">
        <a href="http://www.adobe.com/go/getflashplayer">
                <img src="http://www.adobe.com/images/shared/download_buttons/get_flash_player.gif" alt="Get Adobe Flash player" />
        </a>
</div>

Si le plugin Flash est manquant ou si la version est trop ancienne, alors cette partie du code sera utilisée pour le lien vers le plugin adéquat. L’élément important est id, dans notre exemple "freepaper1" qui permettra d’indiquer à la boite à outils swfobject où implanter, si possible, le lecteur FreepapeR. Ainsi, le conteneur <div> d’id freepaper1 devrait être remplacé par un objet SWF.

3) Créer le lecteur FreepapeR, avec ses options


<script type="text/javascript">
        //Options pour l'insertion d'un lecteur FreepapeR
        var flashvars = {
                pdfURL : "documents/gazetteCDM_2_200810.pdf"      //obligatoire
        };
        var params = {
                width:600,      //optionnel
                height:800      //optionnel
        };
        var attributes = {
                altContentId:"freepaper1",      //optionnel
                trace:true      //optionnel
        };
        //Insertion d'un lecteur FreepapeR
        freepaper.embedDoc(flashvars,params,attributes);
</script>

- pdfURL : obligatoire - chemin du document PDF à afficher
- width : optionnel - la largeur de l’écran FreepapeR (valeur par défaut, 600)
- height : optionnel - la hauteur de l’écran FreepapeR (valeur par défaut, 800)
- altContentId : optionnel - id du noeud dont on remplace le contenu par le lecteur FreepapeR (valeur par défaut, "freepaper1")
- trace : optionnel – si true, affiche des infos sur l’avancée du traitement

Si on souhaite ne pas définir une valeur, il suffit de ne pas écrire la paire correspondante. Si on ne souhaite définir aucune valeur pour un objet il faut tout de même créer un objet vide, par exemple :
params={}
attributes={}

ATTENTION : dans la description des attributs d’un objet (flashvars, params ou attributes), il est indispensable de séparer deux valeurs par le caractère virgule ",", sauf pour le dernier qui ne doit EN AUCUN CAS être suivi de virgule (cela provoque une erreur avec IE et Opéra) !

Lorsque la page décrite ci-dessus est affichée dans un navigateur , on obtient le 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 III, des solutions alternatives sont décrites en IV.

 

III- 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, dans le dossier de son choix.
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 dans le dossier de son choix. Bien penser à s’accorder les droits de lecture et d’exécution. On peut aussi si on a les droits root poursuivre l’installation dans le système avec make install.

3.Puis dans les deux cas
ouvrir le fichier pdf2swf.php et régler le contenu de la variable pdftoolsPath pour qu’elle indique le chemin vers l’exécutable pdf2swf, par exemple :

$this->pdftoolsPath='/kunden/homepages/16/d211615240/htdocs/bin/free/';//Linux
ou
$this->pdftoolsPath='D:\\www\\publications\\freepaperdemo\\';//Windows
ou encore
$this->pdftoolsPath='../';//Linux
ou bien encore
$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.

 

IV- Je ne peux pas installer swftools sur mon serveur


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

Il y a des pistes alternatives

- J’ai trouvé un binaire pour ma distribution Linux

Dans ce cas, il suffit de placer ce binaire dans un dossier de son serveur, puis de régler la variable $this->pdftoolsPath, comme décrit en 3-3.

- Je télécharge le binaire en local, je converti les PDF en local, puis je place les fichiers sur le serveur

On procède comme décrit en 3-1 puis 3-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 uploader chaque fichier pdf, puis chaque fichier pdf.swf (dans le même dossier que le pdf), et dans cet ordre.

- Lorsque Freepaper s’initialise et cherche à restituer le fichier PDF passé en paramètre : s’il existe un fichier « pdf.swf » situé dans le même dossier et qui est plus récent que le fichier « pdf », alors le comportement est d’afficher le document « pdf.swf », sans pratiquer de recalcul, c’est à dire sans faire appel au binaire pdf2swf.

 

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- Fenêtre d’information

Lorsque l’on clique sur le logo « Freepaper » située en haut et à gauche de la barre de commande, on fait apparaître une fenêtre d’informations sur le document affiché :

Cette fenêtre disparaît dès que l’utilisateur clique sur l’image « Back to FreepapeR ».

VII- Surcharge par un fichier de configuration


S’il existe dans le même dossier que la page HTML qui implante le lecteur FreepapeR un fichier nommé « freepaper.xml », alors ce fichier de configuration est lu et les valeurs qu’il définit viennent surcharger les valeurs par défaut de comportement et d’affichage.
Il est aussi possible de spécifier un fichier de configuration situé dans un autre dossier et/ou ayant un nom différent. Il suffit pour cela de passer l’information (variable xmlDataPath) au script d’’implantation de l’objet SWF :

 var flashvars = {
        xmlDataPath : "<chemin vers le fichier de conf>/maConfig.xml",
};


par exemple,
<script type="text/javascript">
 //Options pour l'insertion d'un lecteur FreepapeR
 var flashvars = {
                xmlDataPath : "xml/freepaperData.xml",      //optionnel
                 pdfURL : "documents/gazetteCDM_2_200810.pdf"   //obligatoire
        };
        var params = {
                width:600,      //optionnel
                height:800      //optionnel
        };
        var attributes = {
                altContentId:"freepaper1",      //optionnel
                trace:true            //optionnel
        };
        //Insertion d'un lecteur FreepapeR
        freepaper.embedDoc(flashvars,params,attributes);
</script>

indique au système d’aller chercher le fichier de configuration « freepaperData.xml » dans le dossier « xml ».

Le fichier de configuration xml est constitué comme suit :

<?xml version="1.0" encoding="UTF-8"?>
<freepaper backgroundColor="0xd2f7c9" borderColor="0x5c954b" borderWidth="4" initialDisplay="H" >
        <commandBar leftImg="images/commandBar/left.png" rightImg="images/commandBar/right.png" currentImg="images/commandBar/current.png" horizAxis="38" />
        <buttons>
                <fitToPage upImg="images/buttons/fit_up_btn.png" downImg="images/buttons/fit_down_btn.png" overImg="images/buttons/fit_over_btn.png" />
                <nextPage upImg="images/buttons/next_up_btn.png" downImg="images/buttons/next_down_btn.png" overImg="images/buttons/next_over_btn.png" />
                <prevPage upImg="images/buttons/prev_up_btn.png" downImg="images/buttons/prev_down_btn.png" overImg="images/buttons/prev_over_btn.png" />
                <zoomPlus upImg="images/buttons/zoomplus_up_btn.png" downImg="images/buttons/zoomplus_down_btn.png" overImg="images/buttons/zoomplus_over_btn.png" />
                <zoomMinus upImg="images/buttons/zoomminus_up_btn.png" downImg="images/buttons/zoomminus_down_btn.png" overImg="images/buttons/zoomminus_over_btn.png" />
        </buttons>
</freepaper>

Pour ne pas modifier la valeur par défaut d’un des attributs, il suffit de l’omettre ou de régler sa valeur à "".
ASTUCE !

Pour surcharger les images qui définissent un bouton, il faut au moins définir l’attribut upImg. En effet, il est utilisé pour définir la zone de clic du bouton. De plus, seules ses zones opaques sont considérées comme actives. Toutes les images du bouton dont l’attribut n’est pas défini dans le fichier XML seront dessinées avec l’image définie pour l’attribut upImg. Si upImg n’est pas défini, alors les images du bouton par défaut seront utilisées. Pour « cacher » un bouton, il suffit de définir uniquement l’attribut upImg et de lui donner une valeur d’image inexistante, par exemple " " (caractère espace).


VIII- L’exemple contenu dans l’archive

Avec les éléments fournis dans le fichier freepaper.0.7.0.zip, on obtient l’interface suivante :


Au démarrage, le document est affiché pour occuper toute la hauteur, la couleur du fond est d2f7c9, la couleur du contour est 5c954b, l’épaisseur du contour est de 4 pixels.


IX- Les nouveautés de la version 0.7.0

- Ouverture du document selon un des 4 modes suivants :

- ajusté à la page, ajusté à la hauteur du lecteur, ajusté à la largeur du lecteur, valeur de zoom (%)

- Ajout d’une fenêtre d’informations sur le document
- Lors d’un changement de page, le haut de la page est re-positionné juste sous la barre de commande
- Personnalisation possible par fichier XML :
- de la couleur du fond du lecteur
- de la couleur du contour du lecteur
- de l’épaisseur du contour du lecteur
- des 3 images qui composent la barre de commande
- de la position de l’axe d’alignement vertical des éléments de la barre de commande
- des 5 boutons (3 images possibles pour chaque) de la barre de commande
- du mode d’ouverture document


X- 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

 

Documents joints

1 Message

  • Le lecteur FreepapeR v0.7.0 Le 9 décembre 2008 à 02:38 , par Franck

    Notes à propos de la version FreepapeR V 0.7.0 du 07 décembre 2008.



    Dans l’entête du fichier "javascript/freepaper-min.js", il est possible de modifier les valeurs des variables suivantes :



    - m_freepaper_swfUrl="swf/freepaper.0.7.0.swf" ; (URL du fichier swf "freepaper.x.x.x.swf")
    - m_freepaper_phpURL="php/freepaper.php" ; (URL du script PHP freepaper.php)
    - m_freepaper_ExtractFromDOM=false ;(Boolean : Si vrai, alors le noeud FreepapeR est isolé du DOM pour être affiché en pleine page, puis les noeuds de la page sont restaurés dans leurs configurations initiales pour l’affichage en mode normal)
    - m_freepaper_OpenInNewWindow=false ; (Boolean : Si vrai, le lecteur Freepaper est ouvert dans une nouvelle fenêtre lors de la visualisation pleine page)


    On indique dans la documentation le rôle des variables "m_freepaper_swfUrl" et "m_freepaper_phpURL", on ne reviendra donc pas dessus.



    Les 2 variables restantes ("m_freepaper_ExtractFromDOM" et "m_freepaper_OpenInNewWindow") ont une incidence sur le comportement du lecteur lorsque l’on choisi de visualiser un document en mode plein écran.




    - METHODE 1 : "m_freepaper_ExtractFromDOM=false" et "m_freepaper_OpenInNewWindow=false"



    C’est le comportement par défaut, le plus élégant et le plus rapide : pour le passage en mode plein écran, les éléments constituant la page HTML sont retravaillés. Pour cela, on intervient sur les styles (marges, dimensions,...).

    Tout se passe coté client, il n’y a pas rechargement d’actif externes. Si de multiples lecteurs FreepapeR sont présents dans la page HTML, chacun d’eux conserve son zoom, sa page affichée,..., lorsque qu’un des document est affiché en plein écran puis minimisé.



    Cependant, dans certains cas (par exemple si le lecteur FreepapeR est imbriqué dans une cascade de

    ) et pour certains navigateurs (si ce n’est pour dire tous sauf Firefox), ce calcul résulte en un affichage "au bon emplacement, mais invisible". En effet, le lecteur FreepapeR est positionné au bon endroit (donc plein écran) mais les
    englobant laissent eux une fenêtre de vision située en dehors de l’écran. On a donc comme résultat un écran vide.




    - METHODE 2 : "m_freepaper_ExtractFromDOM=true" et "m_freepaper_OpenInNewWindow=false"



    Avec cette méthode, le noeud DOM correspondant au lecteur à afficher en mode plein écran est cloné, la page entièrement vidée de son contenu, puis le noeud précédemment cloné est inséré seul dans la page et maximisé.
    Lorsque l’on revient en mode d’affichage normal, la page est reconstruite dans son état initial.

    On intervient ici sur le DOM en supprimant, clonant, insérant des nœuds.

    Cette manière de procéder permet de totalement s’affranchir des problèmes rencontrés par la méthode 1, mais a un inconvénient : à chaque fois qu’un nœud FreepapeR est inséré (au passage en mode plein écran mais aussi au retour en affichage normal), le document à afficher est rechargé et donc on perd tous les réglages qui avaient été choisis avant/après le changement de dimension (zoom, n° page, ...). En ce qui concerne la bande passante, il n’y a pas d’accroissement de trafic les documents étant rechargés depuis le cache. Si de multiples lecteurs sont présents dans la page, lors du retour en affichage normal tous les réglages de tous les lecteurs sont perdus car tous se rechargent.



    Rem : c’est le comportement par défaut attribué au navigateur Opera (pour qui le cas 1 n’existe donc jamais).




    - METHODE 3 : "m_freepaper_ExtractFromDOM=" et "m_freepaper_OpenInNewWindow=true"

    Cette méthode est une alternative à la méthode 2. Le lecteur choisi pour le plein écran est affiché dans une nouvelle fenêtre. On peut ainsi visualiser simultanément plusieurs documents de la page. Il n’y a pas de manipulation de la page originale et en conséquence aucune information n’est perdue lors du retour en affichage normal sur les lecteurs présents dans la page.

    Le seul inconvénient de cette méthode est qu’elle ouvre le document dans une nouvelle fenêtre, ce que l’on peut ne pas souhaiter.



    Lors de l’utilisation de la méthode 3 avec un fichier de configuration XML (personnalisation de l’interface) il faut bien s’assurer d’indiquer dans le fichier XML des chemins absolus (et non relatifs) pour les images. Dans le cas contraire, les images ne seraient pas retrouvées lors de l’affichage plein écran.


    Les tests ont été effectués avec :

    Firefox 2, Firefox 3, IE6, IE7, Safari 3.1.1, Opéra 9.27, Google chrome 0.4.154.29 (sous windows)

    Firefox 2, Firefox 3 (sous ubuntu)

    Répondre à ce message

Répondre à cet article