spiPDF : générer des contenus sur mesure en PDF

Le plugin spiPDF génère des fichiers au format PDF d’article ou de tout autre élément SPIP, simplement à partir d’un squelette construit au format HTML 4 et facile à modifier.

Avertissement de sécurité

Ce plugin a fait l’objet d’une faille de sécurité en mars 2017, il est important d’avoir son site SPIP et le plugin à jour pour continuer à utiliser ce plugin en toute sécurité

Présentation

Le plugin génère des fichiers PDF à partir d’un squelette écrit au format HTML 4.
Il vous permet donc de créer un PDF réellement sur mesure sans d’autre compétence que de connaître le HTML 4 et CSS.

Que ce soit un squelette pour vos articles, vos rubriques, votre plan de site ou d’autres éléments plus spécifiques, spiPDF génère le contenu en PDF.

Plusieurs librairies, plusieurs possibilités

Le plugin [1] se base - au choix de l’utilisateur - sur plusieurs classes de génération de PDF à partir de HTML :

Par défaut, le plugin utilise mPDF. Vous verrez plus bas dans cet article comment utilisez un autre librairie à la place.

Chacune des classes à ses avantages et ses inconvénients. On notera par exemple que mPDF gére le positionnement flottant (“float”) des éléments ce qui est indéniablement un plus pour de la génération d’article contenant des images.

N’hésitez pas à donner votre avis et vos expériences sur les différentes librairies dans les commentaires de l’article.

Pré-requis

Le plugin requiert :

  • PHP 5
  • d’installer manuellement dans le répertoire /lib/ une librairie (voir chapitre précédent)

Téléchargement et installation du plugin

  • A télécharger sur la zone via SVN
  • Ou téléchargement du ZIP généré automatiquement toutes les heures.

Son installation reste des plus classique (téléchargement, installation dans le répertoire plugins/ et activation via l’interface privée).

Ancienne version 0.1.0

Vous pouvez, si vous rencontrez des soucis avec la version 0.2.0, essayer la version 0.1.0 qui n’utilise que HTML2PDF.

Téléchargement et installation des librairies requises

Attention ! Depuis la version 0.2.0, le plugin n’intègre plus les librairies externes.

Vous devez les télécharger sur leurs sites respectifs et les décompresser dans un répertoire lib/ à la racine de votre site ou dans un répertoire lib/ dans le répertoire du plugin :

Les dossiers doivent se nommer exactement respectivement mpdf, html2pdf ou dompdf (sans majuscules).

Rendu obtenu avec les différentes librairies

Après un test simple de chacune des librairies, voici les résultats que j’ai obtenu :

  • mPDF version 6.0 du 01/03/2015 : bon rendu général
  • HTML2PDF version 4.03 du 27/05/2011 : rendu du texte correct, problème avec certains positionnements d’images
  • domPDF version 0.6.0 beta2 de 02/2011 : problème d’encodage des caractères

Utilisation

Une étape supplémentaire suffit pour commencer à utiliser le plugin.

Ajoutez un lien hypertexte vers le squelette du plugin, typiquement dans votre squelette article.html. Voici à quoi doit ressembler ce lien pour un article :

[<a href="[(#URL_PAGE{spipdf}
	|parametre_url{spipdf,spipdf_article}
	|parametre_url{id_article,#ID_ARTICLE}
	|parametre_url{nom_fichier,article_#ID_ARTICLE})]">
télécharger l'article au format PDF</a>]

Mise en page personnalisée

C’est tout l’intérêt du plugin : permettre une mise en page personnalisée sans connaître le PHP.

Pour obtenir un PDF sur mesure, vous pouvez :

  • soit modifier le squelette qui se trouve dans le répertoire du plugin : spipdf_article.html
  • soir créer votre propre squelette et modifier la balise #URL_PAGE pour qu’elle appelle bien votre squelette à la place de spipdf_article (remplacer spipdf_article par le nom de votre squelette)

Par exemple, vous avez dans votre répertoire squelette, un squelette plan_site_pdf.html que vous souhaitez utiliser pour générer une sortie PDF de votre plan de site.

Il vous suffira d’appeler ce squelette/PDF de la façon suivante :

[<a href="[(#URL_PAGE{spipdf}
	|parametre_url{spipdf,plan_site_pdf}
	|parametre_url{nom_fichier,plan_site_pdf})]">
télécharger le plan de site au format PDF</a>]

Ce qui donnera l’URL : http://monsite.tld/spip.php?page=spipdf&spipdf=plan_site_pdf.html

Liens vers des articles SPIP dans le PDF

Si vous utilisez des liens internes du type [->art2] dans vos articles,
il est nécessaire d’utiliser le filtre url_abs sur les balises
DESCRIPTIF, CHAPO, TEXTE, PS et NOTES pour que les liens dans votre PDF pointent bien sur votre site.

Nom de fichier personnalisé

Par défaut, les fichiers PDF se nommeront document.pdf.

Si vous souhaitez préciser un nom particulier pour votre fichier, vous devrez préciser, comme dans les exemples ci-dessus, le paramètre nom_fichier dans la balise #URL_PAGE.

Choix de la librairie de génération

Pour sélectionner l’une ou l’autre des librairies supportées, vous devez changer la valeur de l’attribut lib_pdf dans la balise du squelette spipdf_article.html ou de votre squelette personnalisé/

Les valeurs possibles sont mpdf / html2pdf / dompdf

Vous pouvez utiliser une librairie différente par type de squelette.

Format, orientation des pages et autres subtilités

Chaque librairies autorisent la mise en page directement depuis le squelette HTML mais pas de la même façon.

Pour plus de simplicité, le format (A4, A5, Letter...) est cependant gérés par le plugin depuis cette balise page pour toutes les librairies.

Pour le reste (marge, bordure, header, footer...) chaque outils à son propre fonctionnement mais tout ceci sans toucher au code du plugin.

mPDF

La librairie utilise le sélecteur CSS @page. Ceci est également explicité dans la documentation (en anglais) de la bibliothèque.

HTML2PDF

La librairie utilise les paramètres précisés via la balise (voir le squelette spipdf_article.html pour l’exemple)

Vous trouverez plus d’informations sur le wiki de la librairie et plus particulièrement sur la section concernant la fameuse balise page.

dompdf

Le support étant expérimental, je n’ai pas plus d’informations pour l’instant à fournir. A voir sur le site de cette librairie.

Contraintes et bugs connus

Certaines balises HTML peuvent ne pas être gérées par le plugin

C’est notamment le cas de balises qui ne sont pas gérées par la librairie que vous avez choisi d’utiliser. Dans ce cas, vous devriez obtenir une erreur à la génération du PDF ou un affichage dégradé. Dans cette situation, 2 solutions :

  • le HTML qui pose problème est dans votre squelette ? et bien... trouvez autre chose en attendant mieux (mais signalez-le quand même dans les commentaires)
  • le HTML est généré par SPIP ? Signalez-le dans les commentaires pour une mise à jour du plugin

Certaines balises CSS ne sont pas gérées par le plugin

Bien entendu, dans ce cas, l’affichage au format PDF sera différent de l’affichage au format HTML. On notera par exemple que le positionnement float est géré en partie par mPDF et pas du tout par HTML2PDF.

Vous devrez palier à certaines contraintes de positionnement en utilisant des tableaux imbriqués (snif !)

Encore une fois, toutes ces contraintes sont explicitées sur les site et les forums des librairies respectives.

Changer l’encodage utilisé pour la génération de PDF

Le plugin génère les PDF en UTF-8. Certaines personnes ont rencontré des problèmes de génération des contenus dans cet encodage.

Pour changer ce comportement, et utiliser ISO-8859-15, vous devez changer la constante suivante dans votre fichier d’options :

define('SPIPDF_CHARSET', 'ISO-8859-15');

Aide au développement

Pour pré-visualiser la page au lieu de générer le PDF, vous pouvez ajouter le paramètre debug_spipdf à l’URL
Par exemple : spip.php?page=spipdf&spipdf=spipdf_article&id_article=1249&nom_fichier=article-1249&debug_spipdf

Notes

[1Depuis la version 0.2.0

Discussion

85 discussions

  • Bonjour

    Comment inclure des polices de caractères personnalisées dans le .pdf ?

    Répondre à ce message

  • 4

    Pour info : le Bloc « Compatibilité » de cette page ne mentionne que les versions 2.0 et 2.1 de SPIP. Or ce plugin semble être compatible avec SPIP 3.x.

    Quid ?

    Répondre à ce message

  • Compatibilité SPIP 3.2 + PHP 7.0.27 + librairie mpdf :
    Sur un SPIP 3.2 en PHP 7.0, après pas mal de tâtonnements avec la lib mpdf, il semblerait que seule la version 6.1.0 du 26/04/2016 fonctionne sans erreur...
    Pour la récupérer :
    -  soit faire générer le zip avec le bouton vert « clone or download » de la page de github de cette version : https://github.com/mpdf/mpdf/tree/6.1
    -  soit, si vous avez la possibilité d’utiliser git sur la machine qui vous héberge, clonez le repo complet puis activez la version 6.1, ce qui donne en ligne de commande :

    cd lib/
    git clone https://github.com/mpdf/mpdf.git mpdf
    cd mpdf
    git  checkout 6.1

    (pour vérification de la version active, un

    git branch -a

    devrait vous permettre de constater que c’est bien la branche 6.1 qui est active)

    Note importante : le sous-dossier mpdf/ttfontdata doit être accessible en écriture pour apache

    Répondre à ce message

  • 1

    Merci pour ce super plugin.
    Un petit truc pour les utilisateurs :
    Si vous voulez utiliser spiPDF avec Dompdf > 0.6.2, il faut remplacer la ligne 358 de spipdf_fonctions.php

    require_once $dir_librairie_pdf . 'dompdf_config.inc.php';

    par

    require_once $dir_librairie_pdf.'lib/html5lib/Parser.php';
    require_once $dir_librairie_pdf.'lib/php-font-lib/src/FontLib/Autoloader.php';
    require_once $dir_librairie_pdf.'lib/php-svg-lib/src/autoload.php';
    require_once $dir_librairie_pdf.'src/Autoloader.php';
    Dompdf\Autoloader::register();
    use Dompdf\Dompdf;

    En effet à partir de la version 0.7.0, le fichier dompdf_config.inc.php n’est plus utilisé.

    La dernière version de Dompdf peut se trouver là :
    https://github.com/dompdf/dompdf/re...

    • On repends et on recommence, et en plus cette fois ça marche :
      ligne 358 par

      require_once $dir_librairie_pdf.'autoload.inc.php';

      et ligne 360 par

      $dompdf = new Dompdf\Dompdf();

      On peut en passant changer les fonctions obsolètes (lignes 361 et 362) :

      • load_html ⇒ loadHtml
      • set_paper ⇒ setPaper

    Répondre à ce message

  • 6
    AbsurdePhoton

    Hello,

    j’ai trouvé un autre bug sur la version 1.03. Plus loin dans les commentaires, quelqu’un se plaignait d’avoir des problèmes sur les images centrées imgxx|center, et j’ai eu le même problème, qui semblait un peu aléatoire mais seules les images centrées étaient touchées, pas les docxx|center.

    Je l’ai résolu comme ceci :
    * dans le fichier « spipdf_fonctions.php », dans la fonction « spipdf_nettoyer_html »
    * inverser les deux premières instructions suivant les commentaires : « supprimer les spans autour des images et récupérer le placement » et « supprimer les spans autour des images »

    Je pense que mettre le nettoyage des images centrées (donc sans placement « left » ou « right ») permet de ne plus couper à tort du code HTML dans certains cas...

    • merci, c’est corrigé dans la version 1.0.4 (je vous fais confiance, et n’ai pas vérifier moi même le résultat) https://zone.spip.org/trac/spip-zone/changeset/101517

    • AbsurdePhoton

      Moi j’ai bien vérifié, je n’ai plus de bug, ça marche nickel sur mon site www.absurdephoton.fr (utiliser le lien PDF qui n’apparaît que dans les articles).
      Petite précision j’utilise la version mpdf v6.0 sans aucun autre problème, mais pas la 6.1 si quelqu’un a un retour d’expérience ?
      Par contre la version 7 change radicalement... le plugin spiPDF n’est donc valable que jusqu’à la version 6.x.

    • hello, étrange, si tu supprimes les spans d’emblée, comment récupérer le placement float après ? tes float fonctionnent ?

    • AbsurdePhoton

      Les float n’ont jamais vraiment fonctionné avec mpdf.

    • bonjour, c’est un problème de remplacement des tags html, le float fonctionne en dehors du texte, [(#LOGO_ARTICLE|image_reduire{250}|right)] qui donne <img src="..." alt="" class="spip_documents_right" onmouseover="" onmouseout="" width="250" height="157"> fonctionne bien.

    • AbsurdePhoton

      Effectivement ça fonctionne pour les squelettes, mais beaucoup moins bien à l’intérieur des articles...

    Répondre à ce message

  • Bonjour,

    Est-il possible d’utiliser spiPDF pour générer un PDF à partir des réponses à un formulaire formidable et de le joindre au mail envoyé à celui qui à répondu au formulaire ?

    Merci d’avance,

    Cordialement,

    Hervé

    Répondre à ce message

  • Bonjour, d’après mes tests en 3.2 + spipr-dist et mpdf, le float n’est pas transmise au style des images du texte, merci

    Répondre à ce message

  • 1

    Bonjour,
    Savez-vous si le plugin est compatible avec PHP7 ?

    Merci à vous :)

    Répondre à ce message

  • 6

    Bjr,

    Le plugin actuellement installé est signalé comme incompatible ou à vérifier pour SPIP 3.2.0 ;

    Une MàJ est-elle prévue ?

    • Salut, pour ce plugin, comme pour les autres :
      -  les mainteneur·euse·s de plugins le font bénévolement, ils n’ont pas toujour le temps de faire des tests
      -  tu peux donc leur faciliter la vie en testant les plugins sur un spip 3.2 local : il suffit simplement de modifier le paquet.xml / plugin.xml pour changer les bornes de compatibilités (lire https://contrib.spip.net/Verifier-s...
      -  si après test en local tu vois que le plugin est compatible, tu le signale (sur le forum du plugin, ou sur la spip-zone) et on marque le plugin comme compatible pour que les autres ne se posent plus la question
      - sinon effectivement il faudra attendre qu’une personne se penche sur le plugin pour le mettre à jour (cela peut être toi ! )

    • Effectivement, passer la balise à

      <necessite id="SPIP" version="[2.0.0;3.2.99]" />

      permet de rendre ce plugin compatible SPIP 3.2.0.

    • attention : cela permet d’activer le plugin. Ensuite il faut s’assurer qu’il est effectivement compatible, c’est à dire que les fonctonnalités fonctionnent. Est-ce bien le cas ?

    • Oui, oui,

      J’ai vérifié, bien sûr ;

    • Ok, parce que en fait

      <necessite id="SPIP" version="[2.0.0;3.2.99]" />

      ne rend pas le plugin compatible, mais seulement activable.

      je commite l’information,

    Répondre à ce message

  • 1
    Jérôme

    Bonjour,

    j’ai une question à laquelle je ne trouve pas de réponse. En local, j’ai mis en place mon site avec des urls propres (titre de l’article). Je souhaiterais que lors de l’exportation en pdf, le nom du fichier créé soit le titre de l’article. Cependant, je n’obtient que « articleXXX.pdf ». La solution est sûrement assez simple, mais je ne l’ai pas trouvée.

    Merci pour toute piste de réflexion !

    • Jérôme

      Mea culpa, le problème venait du squelette Escal que j’utilise et qui intègre directement les lignes de code faisant le lien avec le squelette du pdf. C’est donc les fichiers d’Escal qu’il fallait que je modifie, et non ceux de spipdf...

    Répondre à ce message

Ajouter un commentaire

Qui êtes-vous ?
  • [Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom

Dernière modification de cette page le 20 octobre 2018