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

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

[1Depuis la version 0.2.0

Discussion

96 discussions

  • 1
    Benoît Labourdette

    Savez-vous où se trouve le cache des fichiers PDF générés ? Car, après avoir fait des modifications dans mon article, quand je génère le PDF, il sort la version ancienne de l’article en PDF. Je pourrais vider le cache du site entier, mais j’aimerais pouvoir vider uniquement le cache des fichiers PDF. Car vider le cache de l’article ne suffit pas.

    J’utilise aussi les plugins Cache Cool et Memoization, c’est peut-être plutôt de ce côté là qu’il faut aller voir. Mais j’ai cherché sur le serveur où diable pourraient être ces fichiers PDF en cache, et je ne les trouve pas. Merci pour votre aide !

    Répondre à ce message

  • Bonjour,
    merci pour ce super plugin. J’ai cependant un petit souci : lors de la création du pdf, les styles de mon fichier perso.css ne sont pour la plupart pas appliqués, et je n’arrive pas à comprendre pourquoi.

    Je précise que je n’ai apporté aucune modification aux fichiers du plugin ni au fichier de mon squelette (Escal).

    Quelqu’un peut-il m’aider ? merci !

    Répondre à ce message

  • Bonjour

    Avec SpiPDF v2.0.2 et spip v426, je souhaite utiliser la librairie html2pdf .
    PHP Version 8.2 et MySQL v8.0 via l’extension PHP MySQLi.
    J’installe la librairie à la racine du site à l’aide de composer require spipu/html2pdf.

    Et ça me répond :
    « Echec generation PDF avec html2pdf : Impossible de trouver le répertoire lib/html2pdf/ de la librairie HTML2Pdf »
    Effectivement il n’y a rien dans lib/ ...

    D’où ma question : comment donc installer cette librairie pour le plugin puisse s’en servir ?

    Merci d’avance de votre réponse

    Répondre à ce message

  • 1

    Les liens vers les ancres internes ne sont pas supportés.

    Cela peut être gênant notamment avec des plugins comme sommaire automatique.

    Pour que cela fonctionne, il faut « corriger » le HTML avec des filtres maisons (voir spipdf/inc/spipdf_nettoyer_html.php#193)

    <a id="alice"></a>  doit s'écrire <a name="alice"></a>
    <h2 class="h2" id="bob">... doit s'écrire  <h2 class="h2"><a name="bob"></a>...
    • Bonjour

      Ça m’intéresserait aussi de pouvoir rendre actifs les liens générés par « Sommaire automatique »...

      Par ailleurs, dans les pdf générés, le « nettoyage » des appels de notes présent dans « spipdf_nettoyer_html » ne fonctionne pas par chez moi : l’appel de note reste inactif.

      Merci

    Répondre à ce message

  • J’essaie ce plugin en spip 4.2 et de passer en export sous différentes tailles.

    Je modifie donc spipdf_article.html par exemple en remplaçant format=« A4 » par format=« A3 » mais je reste en A4.

    Une idée de comment tester des exports en différents formats ? Merci !

    Répondre à ce message

  • Si jamais, pour ceux qui ont une erreur à l’ouverture des PDF générés avec la librairie mpdf dans Adobe Acrobat. J’ai trouvé une solution dans un forum (https://stackoverflow.com/questions/72739829/mpdf-file-only-works-in-browser-not-in-adobe-acrobat-format-error).

    Dans le fichier mpdf.php il suffit de changer la ligne :

    $errorlevel=error_reporting($errorlevel & ~E_NOTICE);

    par

    $errorlevel=error_reporting(E_ERROR | E_PARSE);

    Répondre à ce message

  • 3

    Bonjour à tous, Merci pour ce plugin.
    J’utilise la librairie par défaut MPDF.
    Ce que j’ai besoin de mettre en place c’est un sommaire / index reconnu par un lecteur PDF.

    Sur le site de la librairie j’ai :
    https://mpdf.github.io/reference/mpdf-functions/insertindex.html

    Par contre je ne comprends pas comment ajouter ce paramétrage dans le plugin / dans mon article.

    Quelqu’un aurait-il une idée ?

    Merci,
    JG.

    • Idée (non testée) : surcharger le squelettes spipdf_article.html avec la balise #SOMMAIRE du plugin Sommaire automatique ?

    • Bonjour Peetdu,

      Merci pour ta proposition.
      En fait ce n’est pas un sommaire que je souhaite en début de PDF, mais c’est bien le volet a gauche qui est généré sur un PDF. Et pour cela il faut des options spécifiques lors de la constitution du PDF.

      Et du coup, comment passer ces fameux paramètre de la librairie MPDF pour générer cet index reconnu par les readers PDF....

    • Benoît Labourdette

      Désolé pour la question de débutant : où télécharges tu la librairie mpdf ?
      Sur cette page (https://packagist.org/packages/mpdf/mpdf#v8.1.1) je ne trouves pas où on le télécharge.
      Et dans quel dossier tu l’installes ? (dans www/lib, je pense, mais quel nom de dossier mets-tu ? )
      Merci !!

    Répondre à ce message

  • 2
    Benoît Labourdette

    Bonjour,
    Le plugin fonctionnait parfaitement avec la librairie mpdf et PHP 7.4.
    Je suis passé à PHP 8.1.
    J’ai mis à jour la dernière version de mpdf, qui fonctionne avec PHP 8.1, mais pas avec le plugin. J’ai aussi essayé avec la librairie dompdf, mais idem, la dernière version ne fonctionne pas avec le plugin. Et j’ai aussi essayé avec la dernière version de HTML2PDF, mais idem, le plugin ne veut pas fonctionner, il dit :
    Erreur d’exécution plugins/auto/spipdf/v1.2.6/spipdf.html
    Est-ce que quelqu’un a réussi à faire fonctionner ce plugin avec PHP 8.1 ?
    Merci !!

    Répondre à ce message

  • 1

    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

  • 2

    Bonjour,
    Je suis passé à spip 3.2 et php 7.1.3, du coup j’ai plein d’erreurs !
    Il est indiqué que ce plugin fonctionne avec php 5, mais dans les commentaires certains l’utilisent avec php 7, que faire pour cela ?
    Merci de votre aide,
    Chris.

    • A première vue ce n’est pas le plugin qui est en cause, mais mPDF.
      En php 7.1, il faut sans doute remettre une lib à jour, mais maintenant c’est via composer.
      Et est-ce que SPIDF va bien trouver la lib si install via composer ? A tester...

    • Après avoir installer mPDF 7.0 via composer, SPIPDF ne marche toujours pas, car il cherche une librairie dans /lib... qui n’existe pas via composer !
      Il faudrait adapter SPIPDF à mPDF 7.0...

    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