====== XSLFO Plugin ======

---- plugin ----
description: Export DokuWiki pages to PDF with an XSL-FO processor
author     : Sam Wilson 
email      : sam@samwilson.id.au 
type       : render
lastupdate : 2016-02-03
compatible : Weatherwax
depends    : xml
conflicts  : 
similar    : dw2pdf
tags       : pdf, export

downloadurl: https://github.com/samwilson/dokuwiki-plugin-xslfo/archive/2014-01-29.zip
bugtracker : https://github.com/samwilson/dokuwiki-plugin-xslfo/issues
sourcerepo : https://github.com/samwilson/dokuwiki-plugin-xslfo
donationurl: 

screenshot_img : 
----

===== Installation =====

**External requirements:** This plugin requires a XSL processor such as [[https://xmlgraphics.apache.org/fop/|Apache FOP]] to be installed separately.

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

To add a link to your site template, add the following code somewhere appropriate:

<code html>
<a id='export-pdf-link' href="<?= wl($ID, array('do'=>'export_xslfo','rev'=>$REV)) ?>" title='Get a PDF copy of this document'>
  <img src="<?= DOKU_BASE ?>lib/images/fileicons/pdf.png" alt='PDF file type icon' />
  Printable PDF version
</a>
</code>

===== Configuration and settings =====

^ Option   ^ Description ^ Default ^
| output   | Display the PDF file in the browser, or prompt to download it? | Browser |
| usecache | Cache the PDF? | Yes |
| template | XSL template to use by default. Explained below. | ''default.xsl'' |
| command  | The processor command. | ''%%fop -xml "{xml}" -xsl "{xsl}" -pdf "{pdf}"%%'' |

==== XSL-FO templates ====
The plugin comes with a ''default.xsl'' template, which produces a basic PDF. Site templates (i.e. in the ''/lib/tpl'' directory) can supply their own XSL files. These will be available to be selected from a dropdown menu on the main site configuration page. All ''.xsl'' files in the current site template's directory will be available.

This template can be overridden for individual pages by adding ''&tpl=name.xsl'' to the end of the URL.

:!: The default template is not yet complete and does not handle all Dokuwiki syntax. It's got the basics, but if you find any problems please [[https://github.com/samwilson/dokuwiki-plugin-xslfo/issues/new|raise an issue]] on Github, and we'll get it sorted.

==== Processor command ====
The processor command will have ''{xml}'', ''{xsl}'', and ''{pdf}'' replaced by the correct filesystem paths.

For example, on Windows this might be:<code>C:\Progra~1\fop\fop.bat -xml "{xml}" -xsl "{xsl}" "{pdf}"</code>
===== Development =====

==== Change Log ====
{{rss>https://github.com/samwilson/dokuwiki-plugin-xslfo/commits/master.atom author date}}

==== Bugs and other issues ====
Please report all bugs on [[https://github.com/samwilson/dokuwiki-plugin-xslfo/issues|the plugin's Github issue-tracker]], and not on this page.