Differences

This shows you the differences between two versions of the page.

--- plugin:dw2pdf [2018-04-23 13:39] – Klap-in
+++ plugin:dw2pdf [2023-11-25 23:50] (current) – version upped andi
@@ Line 6: / Line 6: @@
 email      : andi@splitbrain.org, klapinklapin@gmail.com
 type       : action, renderer
-lastupdate : 2018-04-23
+lastupdate : 2023-11-25
-compatible : 2016-06-26, Weatherwax, Binky, Ponder Stibbons, Hrun,Detritus, Frusterick Manners
+compatible : !Greebo, Hogfather, Igor, Jack Jackrum
 depends    :
 conflicts  :
@@ Line 22: / Line 22: @@
 ===== Download and Installation =====
-Download and install the plugin using the bundled Extension Manager using the URL given above. Refer to [[:Plugins]] on how to install plugins manually.
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
-:!: The plugin **can't be installed through the plugin manager on pre-Angua releases**, because it's too big and the plugin manager will fail while downloading. Please install it manually and make sure the installed directory is named ''dw2pdf''.
+Only **PHP 7.4 up to PHP 8.1** are supported by dw2pdf plugin. At rather short term support for PHP 7.4 will be dropped.
-Only **PHP 5.6 and newer** are supported by dw2pdf plugin.
+To export (png) images with an alpha channel (used for transparency), you need to install the GD library for PHP. For example on Debian systems:
-To export images with an alpha channel (used for transparency), you need to install the GD library for PHP. For example on Debian systems:
+  sudo apt-get install php-gd
-  sudo apt-get install php5-gd
 Also see the [[:tips:phpwithgd|PHP with gd]] tips page.
@@ Line 44: / Line 42: @@
 ===== Features =====
-  * Uses the [[http://www.mpdf1.com/|mPDF]] PHP library.
+  * Uses the [[https://mpdf.github.io|mPDF]] PHP library.
   * Handles different languages (it bundles the large, but relatively complete Unicode font).
   * Easy customizing through headers, footers and CSS
@@ Line 59: / Line 57: @@
 There are three ways to export:
   * **Export one page**\\ You simply need to call the page with an additional ''do=export_pdf'' URL parameter. This starts the PDF export of the page. Some templates let the plugin extend the [[plugin:dw2pdf:pagetools]] automatically. For other templates you need to implement this yourself to add a button or similar somewhere in your template design.
-  * **Export an entire namespace**\\ There is the URL parameter ''do=export_pdfns'' which let you export a chosen entire namespace as one PDF (e.g. use ''&do=export_pdfns&book_ns=my:namespace&book_title=Mytitle''. Or create a link with the [[#Syntax|syntax]]).
+  * **Export an entire namespace**\\ There is the URL parameter ''do=export_pdfns'' which let you export a chosen entire namespace as one PDF (e.g. use ''&do=export_pdfns&book_ns=my:namespace&book_title=Mytitle'' (See [[plugin:dw2pdf:configuration|Configuration options]] on how to exclude specific pages). Or create a link with the [[#Syntax|syntax]]).
   * **Export selection of pages**\\ If you need to select just some pages to export to one PDF, you can use [[plugin:Bookcreator]] plugin, which offers an interface for the dw2pdf plugin.
@@ Line 67: / Line 65: @@
   * [[plugin:dw2pdf:pagetool|How to add export button in pagetools/menu's]]
   * [[plugin:dw2pdf:pdftemplates|Layout and Customize the exported PDF for your (corporate) identity]]
-  * Plugin developers: [[plugin:dw2pdf:exportsupport|How to support export to PDF in your plugin]]
+  * Plugin developers: [[plugin:dw2pdf:exportsupport|How to support export to PDF in your plugin]], including creating your own replacement patterns for use in HTML templates
@@ Line 106: / Line 104: @@
 Feel free to add yours here:
-  * [[http://www.practico.org|Practico Framework]]
-  * [[http://wiki.gain250.com/wiki/doku.php?id=start:start|Gain250]]
-  * [[http://ageulen.de|AG Eulen (german)]]
   * [[http://www.blesk.ca/wiki/|BLËSK User Guide (English)]]
-  * [[http://wiki.hiorg-server.de/|Handbuch HiOrg-Server (german)]]
+  * [[http://wiki.fibu-schnittstelle.de|Financial accounting - webshop - interface (German)]]
-  * [[http://www.pkuinfo.it|PKUinfo: Informazioni, domande e risposte sulla fenilchetonuria]]
+  * [[http://wiki.hiorg-server.de/|Handbuch HiOrg-Server (German)]]
-  * [[http://davidak.de/wiki/|davidak wiki (german)]]
-  * [[http://weizhong-lab.ucsd.edu/cd-hit/wiki/|CD-HIT Wiki]]
-  * [[http://weizhong-lab.ucsd.edu/frhit/wiki/|FR-HIT Wiki]]
-  * [[http://www.anngon-wiki.info]] (Vietnamese)
-  * [[http://www.bluemel.eu|Versuch macht klug! Entdecke die Welt der Experimente mit A.Blümel]]
-  * [[http://sm.ingenieriamultimedia.org|course on Multimedia Engineering at University of Alicante]]
-  * [[http://dokuwiki.nausch.org|Djangos DokuWiki]] [[user>Django]]
   * [[http://manuals.lacie.com/en/manuals/bladerunner/|LaCie user manuals]]
-  * [[http://wiki.aeroseed.org/|AeroSeeD wiki]]
+  * [[http://mundoaz.com/wiki|Mundoaz - Satellite Decoders (Portuguese)]]
+  * [[http://www.pkuinfo.it|PKUinfo: Informazioni, domande e risposte sulla fenilchetonuria]]
+  * [[http://pe.hillschmidt.de|Prinz Eisenherz - Prince Valiant - Lexikon - Encyclopedia]]
+  * [[http://www.qem.eu/doku/doku.php|QEM srl manuals (Italian)]]
   * [[http://kantuz.esponde.net/|Wiki Kantuz]]
-  * [[http://www.estechnical.co.uk/docs|ESTechnical Documentation (English)]]
+  * [[https://webge.fr/dokuwiki|WEBGE wikis (french)]]
-  * [[http://pe.hillschmidt.de|Prinz Eisenherz - Prince Valiant - Lexikon - Encyclopedia]].
-  * [[http://www.qem.eu/doku/doku.php|QEM srl manuals (italian)]]
-  * [[http://www.laricetteria.net|LaRicetteria Recipes (italian)]]
-  * [[http://wiki.fibu-schnittstelle.de|financial accounting - webshop - interface (german)]]
 ===== Other info =====
@@ Line 141: / Line 128: @@
 To set fixed password for generated documents, edit:
-''dokuwiki/lib/plugins/dw2pdf/mpdf/config.php''
+''dokuwiki/lib/plugins/dw2pdf/mpdf/config.php'' (warning: each plugin update overwrites these changes)
 and add following lines:
@@ Line 153: / Line 140: @@
+==== Hyphenation ====
+With the following setting in ''style.css'' it is possible to enable automatic hyphenation:
+<code>
+body {
+   hyphens: auto;
+}
+</code>
+The hyphenation is of course language dependent. Normally, the wiki login language is used. If the [[translation|translation plugin]] is installed, the language selected here is used for hyphenation when creating the PDF.
+==== Rendering Limitations ====
+Because the rendering is done on the server side, plugins that rely on the client side to render might not do so correctly in the generated PDF.  Example: [[plugin:mermaid]]