1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Thu Oct 31 23:46:00 2013 +0100
1.3 @@ -0,0 +1,100 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The ExportPDF action enables the export of MoinMoin wiki pages as PDF
1.8 +documents using XSLT, DocBook and XSL-FO external tools.
1.9 +
1.10 +Installation
1.11 +------------
1.12 +
1.13 +The following configuration settings are present in the ExportPDF.py module:
1.14 +
1.15 +XSLT_PROCESSOR Path to the xsltproc program
1.16 +FO_PROCESSOR Path to the fop program
1.17 +DOCBOOK_STYLESHEET_BASE Path to the directory containing DocBook resources
1.18 +
1.19 +Another setting that should not need modifying is the following:
1.20 +
1.21 +DOCBOOK_TO_FO_STYLESHEET Relative path to the docbook.xsl stylesheet file
1.22 + from the DOCBOOK_STYLESHEET_BASE path (putting
1.23 + them together should reference the file with an
1.24 + absolute path)
1.25 +
1.26 +Once configured, copy the ExportPDF.py module into your wiki's actions
1.27 +directory.
1.28 +
1.29 +With moinsetup and a suitable configuration file (see "Recommended Software"
1.30 +below), you can perform this last step as follows, with $EPDIR referring to
1.31 +the ExportPDF distribution directory:
1.32 +
1.33 + python moinsetup.py -f moinsetup.cfg -m install_actions $EPDIR/actions
1.34 +
1.35 +Basic Usage
1.36 +-----------
1.37 +
1.38 +Select the ExportPDF action from the actions menu; a PDF document should be
1.39 +offered for download.
1.40 +
1.41 +Recommended Software
1.42 +--------------------
1.43 +
1.44 +See the "Dependencies" section below for essential software.
1.45 +
1.46 +The moinsetup tool is recommended for installation since it aims to support
1.47 +all versions of MoinMoin that are supported for use with this software.
1.48 +
1.49 +See the following page for information on moinsetup:
1.50 +
1.51 +http://moinmo.in/ScriptMarket/moinsetup
1.52 +
1.53 +Dependencies
1.54 +------------
1.55 +
1.56 +The ExportPDF action has the following basic dependencies:
1.57 +
1.58 +Packages Release Information
1.59 +-------- -------------------
1.60 +
1.61 +xsltproc Tested with 1.1.26
1.62 + Debian package: xsltproc
1.63 + Source: http://www.xmlsoft.org/XSLT.html
1.64 +
1.65 +Apache FOP Tested with 1.0
1.66 + Debian package: fop
1.67 + Source: http://xmlgraphics.apache.org/fop/
1.68 +
1.69 +DocBook XSL Tested with 1.76.1
1.70 + Debian package: docbook-xsl
1.71 + Source: http://docbook.sourceforge.net/
1.72 +
1.73 +Java Tested with a Java 6 runtime
1.74 + Debian package: openjdk-6-jre-headless
1.75 + Source: http://www.oracle.com/technetwork/java/index.html
1.76 +
1.77 +The Java dependency is unfortunate and would ideally be avoided by using
1.78 +something other than Apache FOP.
1.79 +
1.80 +Contact, Copyright and Licence Information
1.81 +------------------------------------------
1.82 +
1.83 +See the following Web page for more information about this work:
1.84 +
1.85 +http://moinmo.in/ActionMarket/ExportPDF
1.86 +
1.87 +The author of this packaging of the original work can be contacted at the
1.88 +following e-mail address:
1.89 +
1.90 +paul@boddie.org.uk
1.91 +
1.92 +Copyright and licence information can be found in the docs directory - see
1.93 +docs/COPYING.txt and docs/LICENCE.txt for more information.
1.94 +
1.95 +Release Procedures
1.96 +------------------
1.97 +
1.98 +Update the actions/ExportPDF.py __version__ attribute.
1.99 +Change the version number and package filename/directory in the documentation.
1.100 +Update the release notes (see above).
1.101 +Tag, export.
1.102 +Archive, upload.
1.103 +Update the ActionMarket and ActionMarket/ExportPDF page.