DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:dw2pdf:pdftemplate

dw2pdf plugin

PDF Templates

PDF Templates define the design of the created PDF files and are a good way to easily customize them to your Corporate Identity.

The default PDF template which is shipped with the dw2pdf plugin is shown below. It has simple headers, footers and citation box.

The default shipped PDF template To create a new template, just create a new folder within the plugin's lib/plugins/dw2pdf/tpl/ folder and put your header, footers, cover page, and style definitions in it. See lib/plugins/dw2pdf/tpl/default for an example. Do not modify the template default, this template will be overwritten on updates, so you will lose your changes.

After creation, you set in the Configuration Manager that your template should be used for exports. Eventually, if you like to change template incidentally, you can use the URL parameter &tpl=<foldername>.

Headers and Footers

The following files can be created and will be used to set headers and footers on odd or even pages. Special headers/footers can be used on the first page of a document. If a file does not exist the next more generic one will be tried. E.g. if you don't differ between even and odd pages, just the header.html is used.

  • header.html – Header for all pages
  • header_odd.html – Header for odd pages
  • header_even.html – Header for even pages
  • header_first.html – Header for the first page
  • footer.html – Footer for all pages
  • footer_odd.html – Footer for odd pages
  • footer_even.html – Footer for even pages
  • footer_first.html – Footer for the first page
  • citation.html – Citationbox to be printed after each article
  • cover.html – If exists, added once before first page
  • back.html – If exists, added once after last page

You can use all HTML that is understood by mPDF (See mpdf.github.io)

If you reference image files from your pdf-template file, be sure to prefix them with the @TPLBASE@ (or for some cases @TPLINC@) parameter (See Replacements below).

Replacements

The following replacement patterns can be used within the header and footer files.

  • @PAGE@ – current page number in the PDF
  • @PAGES@ – number of all pages in the PDF (excluded a ToC)
  • @TITLE@ – the article's title
  • @WIKI@ – the wiki's title
  • @WIKIURL@URL to the wiki
  • @DATE@ – time when the PDF was created (might be in the past if cached)
  • @BASE@ – the wiki base directory
  • @TPLBASE@ – the URL base of PDF-template directory (use to reference images) (e.g. /[wikiURLbase]/lib/plugins/dw2pdf/tpl/<yourtplfolder>/ )
  • @TPLINC@ – the absolute path to the PDF template directory on the filesystem (e.g. /var/www/dokuwiki/lib/plugins/dw2pdf/tpl/<yourtplfolder>/)
  • @INC@ – the absolute wiki install directory on the filesystem
  • @DATE(<date>[, <format>])@ – formats the given date with dformat or with the given format such as %Y-%m-%e, e.g. this would give just the current year @DATE(@DATE@,%Y)@

Remark about Bookcreator: The next page dependent replacements are only for citation.html updated for every page. In the headers and footers the ID of the bookmanager page of the Bookcreator is applied.

  • @ID@ – The article's pageID
  • @PAGEURL@URL to the article
  • @UPDATE@ – Time of the last update of the article
  • @QRCODE@ – QR code image pointing to the original page url (requires an online generator, see config setting)

Styles

Custom stylings can be provided in the following file of your pdf-template folder:

  • [wikibase]/lib/plugins/dw2pdf/tpl/<yourpdftplfolder>/style.css

You can use all the CSS that is understood by mPDF
(See https://mpdf.github.io/css-stylesheets/supported-css.html)

plugin/dw2pdf/pdftemplate.txt · Last modified: 2017-11-20 23:04 by Klap-in