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 – 265 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

  • Sorensen

    Bonjour
    Excellent plugin, le rendu pdf est vraiment propre.
    Je cherche cependant à le personnaliser, et je n’ai pas trouvé comment faire pour que le texte de l’article ne soit pas centré (visuellement ce n’est pas très heureux).
    A quel endroit faut-il gérer cela ?

    Merci d’avance pour votre aide.

    Répondre à ce message

  • 2
    Alain7159

    Bonjour,

    Très bon plugin !!

    Dans la version 0.2.11, comme dans la version 1.0.1, la feuille de style personnalisée n’est pas prise en compte, alors qu’avec les feuilles de spip, il n’y a pas de souci. Avez-vous des retours identiques ?

    En utilisant un squelette personnalisé, j’obtiens dans le pdf une partie de la balise « page » : df« orientation= »L« format= »A4-L« backtop= »4mm« backbottom= »4mm« backleft= »5mm« backright= »5mm">, et pas de prise en compte de l’orientation paysage). J’ai réussi à feinter ce problème en insérant des espaces avant cette balise...

    Version spip : 3.017 en local Lamp

    • Alain7159

      Le fichier css personnalisé ne pouvait pas être pris en compte puisque j’avais mal fourni le chemin d’accès

      (#CHEMIN{perso.css} au lieu de #CHEMIN{css/perso.css}

      -  Après cette rectification, je me retrouve avec ce message si j’utilise mpdf :
      « Can’t open file lib/mpdf/ttfontdata/dejavusanscondensedB.GSUBGPOStables.dat ».
      -  Si j’utilise html2pdf : « Le type de fichier document texte brut (text/plain) n’est pas pris en charge ».

      Je ne vois rien dans mes fichiers (particulièrement le css perso) qui puissent engendrer ce type de message.

      Si quelqu’un a une idée, je suis preneur. Merci.

    • Yohooo

      Bonjour Alain,

      Le dossier lib/mpdf/ttfontdata sert à placer les fichiers relatifs aux typographies visibles dans test pdf

      Il faut tout simplement donner un acces en écriture à ce dossier pour voir disparaître ce message d’erreur.

    Répondre à ce message

  • 2
    Jean-Jacques

    Bonjour,
    J’aimerais que le pdf généré soit « protégé ».
    La doc de la librairie mpdf stipule qu’il faut employer SetProtection
    void SetProtection ( array $permissions [, string $user_password [, string $owner_password [, integer $length ]]])

    Est ce qu’il est possible d’agir sur le plugin, au moment ou il passe les paramètres à la libraire ?
    Enfin bref comment faire svp ?
    Merci !

    • Yves Tannier

      Bonjour,

      Dans le fichier spipdf_fonctions.php avant $mpdf->WriteHTML($html) ; vous pouvez essayer ajouter $mpdf->SetProtection(vos options) ;

      Je n’ai pas testé ;)

    • Jean-Jacques

      Bonjour,
      Merci beaucoup. Ci dessous un copier coller du code modifé

       // la classe mPDF
                $mpdf = new mPDF(SPIPDF_CHARSET, $format_page, 0, "", $backleft, $backright, $backtop, $backbottom, $margin_header, $margin_footer);
                $mpdf->SetProtection(array());
                $mpdf->WriteHTML($html);

      Sans options supplémentaires on peut ouvrir le pdf, mais pas l’imprimer, pas le copier, etc,
      donc c’est génial et cela correspond avec ce que le client (un peu parano .. ) m’a demandé
      En cas de mise à jour du plugin, j’imagine que mes modifications seront perdues ?
      Est ce qu’il y a un mécanisme de surcharge du code du plugin ?
      Encore merci !

    Répondre à ce message

  • 1
    Julien

    TEXTE TOUJOURS CENTRE !

    Désolé de demander ceci mais je ne vois pas :
    -  voici le modèle HTML :
    http://ussolidaires.fr/spip.php?page=pdf_attestation&id_inscription=25&nom_fichier=attestation_Koita

    -  Voici le résultat :
    http://ussolidaires.fr/spip.php?page=spipdf&spipdf=pdf_attestation&id_inscription=25&nom_fichier=attestation_Koita

    Pourquoi donc le texte est-il centré dans le PDF ??

    Merci de votre aide.
    Julien

    • Julien

      Je ferme le ticket ! Le contenu dans un TD est centré...

      Ceci dit je n’arrive pas à l’aligner à gauche : align=left, style=« text-align:left » pour le TD garde le texte centré...

      Je supprime le tableau !

    Répondre à ce message

  • Ysabeau

    Le plugin, très bien rien à dire. Merci.
    En revanche mon hébergeur m’a signalé un malware dans le librairie mpdf !

    Répondre à ce message

  • maurice

    salut
    pour moi, ça ne fonctionne toujours pas, il y a encore des problèmes
    j’aurai bien voulu poster deux pdf d’articles.
    mais ne sachant où poster
    vous pouvez essayer de sauvegarder l’article, ici :

    http://fractuscontrarius.fr/spip.php?article37&lang=fr
    ou
    http://fractuscontrarius.fr/spip.php?article35&lang=fr

    amicalement, momo

    Répondre à ce message

  • 1
    momo

    bonjour

    spiPDF

    j’ai donc toujours dans mon espace privé

    Erreur dans les plugins : /var/www/clients/client0/web1/web/plugins/svn/spipdf/spipdf.php
    et les caches vidés, via ssh, ou ftp et sur le site, et dans le navigateur

    et ce matin j’ai donc sauvegardé quelques articles en pdf via ce plugin
    es codes informatiques n’apparaissent pas
    ce sont les textes avec

    <cadre>et


    on a juste un petit rectangle blanc de 4 mm
    idem pour les liens informatiques
    voir article pour faire un essais de sauvegarde

    http://fractuscontrarius.fr/spip.php?article32&lang=fr
    bonne journée à tous

    Répondre à ce message

  • Pierre KUHN

    Bonjour,

    Comment faire un changement de page avec ce plugins ?
    Si je veux passer 2 articles et obliger le second a être sur une autre page.

    Répondre à ce message

  • 2
    Manu

    Pb de path dans le cadre d’une mutualisation SPIP ?
    Bonjour,
    J’ai droit au message Impossible de trouver la librairie de génération de PDF mpdf. vérifiez que vous l’avez bien téléchargée et installée dans /lib
    Pourtant, le répertoire mpdf existe bien dans /lib
    => Est-ce dû au fait que ce plugin soit utilisé dans le cadre d’une mutualisation SPIP que la détection de la présence des librairies échoue ? Au contraire, quelles sont les autres pistes à explorer (ou quelque chose que je n’ai pas bien fait) ?
    Merci (beaucoup) d’avance...

    • Francky

      Bonjour :-)
      Sans connaître la réponse à ton problème, tu devrais regarder la version de la lib mpdf que tu dis avoir.
      Dans l’article, il est dit que des essais on été fait avec la version 5.3 !
      http://mpdf1.com/repos/MPDF53.zip

      Mais la dernière version de la lib est la : 5.7.4, donc possible que qu’il a des changements dans la lib qui demanderaient des modifs dans le plug.
      http://www.mpdf1.com/mpdf/index.php?page=Download

    • Manu

      Bon, je suis revenu à la version 5.3
      Mais, aïe, page blanche (erreur 500)

      mon url : spip.php?page=spipdf&spipdf=toto_pdf&nom_fichier=toto_pdf

      pourtant j’ai un « template » toto_pdf.html minimaliste :

      <page lib_pdf="mpdf" orientation="P" format="A4" backtop="7mm" backbottom="7mm" backleft="10mm" backright="10mm">
Hello world !
</page>

      Qu’est-ce qui peut être en cause ? Quelque chose que je fais mal ?

    Répondre à ce message

  • RealET

    Bonjour,

    Pour information, le plugin fonctionne avec la version 6.0 de mPDF : http://www.mpdf1.com/mpdf/index.php?page=Download

    Merci pour ce plugin !

    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