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

Publié le : 16 février 2011 – Dernière modification le 14 novembre 2023 – par Yves Tannier – 267 commentaires

1
2
3
4
5
75 votes

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

A partir de la version v2.0.2 (compatible SPIP 4)
il est nécessaire d’avoir PHP 8.0 ou plus (pour la compatibilité avec les librairies embarquées)

Pour les versions v1.2.0 et précédentes, 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 des librairies requises

A partir de la version v2.0.2 (compatible SPIP 4)
Il n’est plus nécessaire d’intégrer les librairies d’une facon externe, elles sont intégrées dans le répertoire vendor du plugin

Dans les anciennes versions
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 abs_url 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

[1] Depuis la version 0.2.0

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

96 discussions

  • 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

  • 1
    kent1

    Pour info je viens de publier coup sur coup deux versions :

    La première en lien avec ce commit : https://zone.spip.org/trac/spip-zone/changeset/105870/_plugins_/spipdf

    Elle permet d’utiliser le plugin un peu plus facilement de manière programmatique en ajoutant un paramètre $file à la fonction spipdf_html2pdf.

    La seconde ici : https://zone.spip.org/trac/spip-zone/changeset/105871/_plugins_/spipdf
    Elle change un chouilla les preg_match pour permettre la balise <pagebreak> ce mpdf.

    Si vous voyez des bugs, dites le moi

    Répondre à ce message

  • Yohooo

    Hello,

    Juste une petite remarque, la librairie utilisée est passée en version 7.0.
    https://github.com/mpdf/mpdf/blob/development/CHANGELOG.md

    Pour ma part, j’ai été contraint de la mettre à jour pour afficher convenablement une mise en page.
    ( les typos et des certaines fonctionnalités ne s’affichaient pas ).

    Serait-il possible de monter la version de la librairie MPF associé au plugin ?

    Répondre à ce message

  • 1
    ygornet

    salut

    à la suite du défaut constaté dans spipdf v1.0.4
    on a modifié le fichier ./spipdf.html en ajoutant un filtre :
    v1.0.4 : filename=#ENV{nom_fichier,document}.pdf
    v1.0.5 : filename=[(#ENV{nom_fichier,document}|translitteration)].pdf

    très bien

    sauf que les crochets-parenthèses ouvrant et fermant, placés au milieu d’une expression plus complexe et qui sont nécessaires dès lors qu’on ajoute le filtre
    ne permettent plus de passer la variable nom-fichier à la librairie html2pdf utilisée dans le cas qui m’occupe
    la variable « filename » est vide comme si les crochets-parenthèses ouvrant et fermant bloquait le calcul de #ENV{nom_fichier}

    conséquence les fichiers pdf qui sortent de là portent tous le même nom par défaut « document.pdf »
    et ce « document » n’est pas celui de l’expression alternative #ENV{nom_fichier,document}
    si on écrit #ENV{nom_fichier,toto} on n’a jamais un document toto.pdf

    lorsqu’on enlève les crochets-parenthèses ouvrant et fermant (et donc le filtre)
    le nom de fichier est bien transmis à filename et donc à la librairie
    et l’on obtient le nom de fichier prescrit dans l’appel de la fonction

    par ailleurs le passage de v3.1.3 à v3.1.4 a également une conséquence négative pour ce malheureux plugin
    en effet dans le fichier ./spippdf_fonctions.php, ligne 358,
    l’expressions $flux['args']['contexte']['lang'] est vide
    conséquence on a une exception dans le fichier ./lib./html2pdf/_class/locale.class.php, ligne 47
    lorsque l’on vérifie que le code de langue est bien constitué de caractère et/ou de nombre

    voili voilou des petites nouvelles du front
    bien à vous, Yanic

    • ygornet

      c’est réparé dans spipdf v1.0.6

      1) en mettant des crochets-parenthèses dans l’expression enveloppante :
      [(#HTTP_HEADER{Content-Disposition: #ENV{print, attachment}; filename=[(#ENV{nom_fichier,document}|translitteration)].pdf})]

      2) en vérifiant si $flux['args']['contexte']['lang'] a une valeur
      et sinon, en mettant par défaut 'fr'

    Répondre à ce message

  • Jérôme

    Bonjour, petit retour d’expérience sur spipdf.

    J’ai rencontré de nombreux problèmes avec spipdf pour l’affichage des images. J’ai enfin trouvé la réponse à ce souci : le problème venait de mon hébergement chez Free (je ne sais pas pourquoi). Après une installation en local, tout fonctionnait parfaitement. La solution a donc été d’investir dans un hébergement chez OVH...

    A noter que pour moi spipdf ne gère pas les images au format bmp. Mais c’est vraiment un moindre mal. Bravo pour ce plugin.

    Répondre à ce message

  • 1
    AbsurdePhoton

    Génial ce plugin, (presque) aucune difficulté à le mettre en place sur mon site.

    Mais il y a une chose qui cloche : en pré-production les fichiers PDF affichent toutes les images sans aucun problème, celles incluses dans les articles comme les autres.

    Par contre, en hébergement chez OVH les fichiers PDF affichent des petites croix (donc image non trouvée). Ce qui est très étrange c’est qu’en mode debug de spiPDF les images apparaissent bien !

    Mon environnement :

    • SPIP 3.1.3
    • SpiPDF 1.03 avec mPDF 5.7 (ça marche pareil en v6.0)
    • Seule différence entre prod et pré-prod : SSL activé chez OVH (càd tout le site est en HTTPS) et bien sûr l’adresse de base du site


    Vous pouvez tester sur mon site AbsurdePhoton www.absurdephoton.fr : allez sur un article et cliquez sur l’imprimante PDF dans le cadre « Thèmes » à droite - j’ai pour l’instant mis dans le lien le paramètre debug, de cette manière mes visiteurs obtiennent une page web simplifiée qu’ils peuvent imprimer -> il suffit d’enlever le paramètre debug dans la barre d’adresse pour obtenir la version PDF sans images.

    J’ai l’impression que ça vient des adresses en HTTPS, j’ai regardé vite fait le script mpdf.php et j’ai trouvé la partie où le HTTPS est géré, mais je ne m’y connais pas assez en PHP pour arriver à comprendre comment ça marche :(

    • AbsurdePhoton

      J’ai compris pourquoi ça ne marchait pas !

      Chez OVH en hébergement mutualisé, les adresses en http(s) ne sont pas résolues avec le nom de domaine mais avec le nom du serveur. mpdf utilise des fonctions curl en mode client web pour les images, qui ont besoin d’une résolution de nom DNS qui pointe effectivement vers le serveur. La solution est de pouvoir modifier le fichier hosts du serveur, ce qui n’est pas possible en mutualisé :(
      Source : http://stackoverflow.com/questions/23514062/mpdf-not-rendering-images-mpdf-error-image-error-could-not-find-image-file (réponse n°5)

      Pour palier ceci, j’ai été obligé de modifier le script mpdf.php, à l’endroit où il fait les remplacements d’adresses, pour faire pointer les liens au bon endroit (juste les paramètres src des images, pas les href).

      Maintenant ça fonctionne parfaitement :)

    Répondre à ce message

  • Jérôme

    Bonjour,

    Je me permet de renvoyer un message concernant les problèmes que je rencontre avec spipdf. J’utilise la version 1.0.3, avec SPIP 3.1 et le squelette Escal V3. En résumé, après de très nombreux essais :

    -  avec la librairie mpdf (versions 5.2, 5.6 ou 6.0), rien ne s’affiche sauf une page blanche.

    -  avec la librairie dompdf, le pdf est généré correctement MAIS aucune image ne s’affiche, que ce soit des images hébergées sur mon site ou des images externes (test avec les formats jpg, bmp, gif et png). Le pdf indique simplement « Image not found or type unknow ». Or, j’ai vraiment besoin de pouvoir afficher des images dans mes pdf...

    Auriez vous quelques pistes pour m’aider à résoudre mon problème. Merci beaucoup !

    Répondre à ce message

  • Bouquet

    Bonjour

    J’ai installé le plugin sur deux sites différents et exactement de la même façon et avec les mêmes paramétrages.
    Dans l’un tout fonctionne parfaitement et dans l’autre seul le contenu de l’article s’affiche sans le chemin ni le titre de l’article.

    Code : PDF

    Qu’ai-je bien pu oublier ?

    Jean-Louis

    Répondre à ce message

  • 1
    Jérôme

    Bonjour,
    J’ai eu quelques petits problèmes en installant spiPDF. J’ai résolu le conflit avec le plugin spip_bonux grâce à des conseils trouvés dans les commentaires, mais par contre le plugin ne me crée toujours aucun fichier pdf. A la place, il me crée ce qui me semble être une page html vide :
    http://jbouffand.free.fr/spip.php?page=spipdf&spipdf=spipdf_article&id_article=228&nom_fichier=article_228
    Comment faire pour résoudre ce problème ?
    J’utilise spip 3.1 et mpdf 6.0.

    merci !

    • Jérôme

      Bon, après plusieurs essais, je suis parvenu à produire un pdf. Je résume pour ceux que ça pourrait intéresser.

      Ma configuration :
      SPIP 3.1
      Escal V3
      spipdf 1.0.3
      Je n’ai réussi à faire fonctionner le plugin qu’avec la version 0.6.2 de dompdf. Pour l’instant je n’ai pas chercher plus loin.

      J’aimerai quand même savoir comment faire fonctionner le plugin avec la librairie mpdf, car j’ai l’impression a priori que tous les éléments avec la balise « float » ont disparu !
      Merci !

    Répondre à ce message

  • 2
    Julien

    PDF TRONQUE

    Sur SPIP 3.1, le PDF généré est tronqué dès la première image dans le texte...

    Voici un exemple : http://reporterre.net/Quand-les-enfants-imaginent-un-monde-sans-voitures

    Cliquez sur le PDF, vous verrez que seule l’image LOGO (la première ) est visible, le premier paragraphe, et quand on doit voir la première image jointe, plus rien !!

    Alors que le modèle spip pour le PDF est normal : http://reporterre.net/spip.php?page=article_pdf&id_article=8891&var_mode=calcul

    Une idée ? Quelle serait la balise qu’il n’aime pas avec MPDF ?

    Merci de votre aide,
    Julien

    • Yves Tannier

      Bonjour Julien,

      Ca à l’air de fonctionner ?!

    • Julien

      Non cela ne fonctionne pas sur mon poste : dans le PDF, on ne voit que la première image (avec l’enfant), et pas la deuxième avec l’assemblée, et donc ni le texte à la suite...

      Vous me confirmez que dans le PDF vous avez tout ?

      Julien

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

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