paul@0 | 1 | Introduction
|
paul@0 | 2 | ------------
|
paul@0 | 3 |
|
paul@0 | 4 | The ExportPDF action enables the export of MoinMoin wiki pages as PDF
|
paul@0 | 5 | documents using XSLT, DocBook and XSL-FO external tools.
|
paul@0 | 6 |
|
paul@0 | 7 | Installation
|
paul@0 | 8 | ------------
|
paul@0 | 9 |
|
paul@0 | 10 | The following configuration settings are present in the ExportPDF.py module:
|
paul@0 | 11 |
|
paul@0 | 12 | XSLT_PROCESSOR Path to the xsltproc program
|
paul@0 | 13 | FO_PROCESSOR Path to the fop program
|
paul@0 | 14 | DOCBOOK_STYLESHEET_BASE Path to the directory containing DocBook resources
|
paul@0 | 15 |
|
paul@0 | 16 | Another setting that should not need modifying is the following:
|
paul@0 | 17 |
|
paul@0 | 18 | DOCBOOK_TO_FO_STYLESHEET Relative path to the docbook.xsl stylesheet file
|
paul@0 | 19 | from the DOCBOOK_STYLESHEET_BASE path (putting
|
paul@0 | 20 | them together should reference the file with an
|
paul@0 | 21 | absolute path)
|
paul@0 | 22 |
|
paul@0 | 23 | Once configured, copy the ExportPDF.py module into your wiki's actions
|
paul@0 | 24 | directory.
|
paul@0 | 25 |
|
paul@0 | 26 | With moinsetup and a suitable configuration file (see "Recommended Software"
|
paul@0 | 27 | below), you can perform this last step as follows, with $EPDIR referring to
|
paul@0 | 28 | the ExportPDF distribution directory:
|
paul@0 | 29 |
|
paul@0 | 30 | python moinsetup.py -f moinsetup.cfg -m install_actions $EPDIR/actions
|
paul@0 | 31 |
|
paul@0 | 32 | Basic Usage
|
paul@0 | 33 | -----------
|
paul@0 | 34 |
|
paul@0 | 35 | Select the ExportPDF action from the actions menu; a PDF document should be
|
paul@0 | 36 | offered for download.
|
paul@0 | 37 |
|
paul@0 | 38 | Recommended Software
|
paul@0 | 39 | --------------------
|
paul@0 | 40 |
|
paul@0 | 41 | See the "Dependencies" section below for essential software.
|
paul@0 | 42 |
|
paul@0 | 43 | The moinsetup tool is recommended for installation since it aims to support
|
paul@0 | 44 | all versions of MoinMoin that are supported for use with this software.
|
paul@0 | 45 |
|
paul@0 | 46 | See the following page for information on moinsetup:
|
paul@0 | 47 |
|
paul@0 | 48 | http://moinmo.in/ScriptMarket/moinsetup
|
paul@0 | 49 |
|
paul@0 | 50 | Dependencies
|
paul@0 | 51 | ------------
|
paul@0 | 52 |
|
paul@0 | 53 | The ExportPDF action has the following basic dependencies:
|
paul@0 | 54 |
|
paul@0 | 55 | Packages Release Information
|
paul@0 | 56 | -------- -------------------
|
paul@0 | 57 |
|
paul@0 | 58 | xsltproc Tested with 1.1.26
|
paul@0 | 59 | Debian package: xsltproc
|
paul@0 | 60 | Source: http://www.xmlsoft.org/XSLT.html
|
paul@0 | 61 |
|
paul@0 | 62 | Apache FOP Tested with 1.0
|
paul@0 | 63 | Debian package: fop
|
paul@0 | 64 | Source: http://xmlgraphics.apache.org/fop/
|
paul@0 | 65 |
|
paul@0 | 66 | DocBook XSL Tested with 1.76.1
|
paul@0 | 67 | Debian package: docbook-xsl
|
paul@0 | 68 | Source: http://docbook.sourceforge.net/
|
paul@0 | 69 |
|
paul@0 | 70 | Java Tested with a Java 6 runtime
|
paul@0 | 71 | Debian package: openjdk-6-jre-headless
|
paul@0 | 72 | Source: http://www.oracle.com/technetwork/java/index.html
|
paul@0 | 73 |
|
paul@0 | 74 | The Java dependency is unfortunate and would ideally be avoided by using
|
paul@0 | 75 | something other than Apache FOP.
|
paul@0 | 76 |
|
paul@0 | 77 | Contact, Copyright and Licence Information
|
paul@0 | 78 | ------------------------------------------
|
paul@0 | 79 |
|
paul@0 | 80 | See the following Web page for more information about this work:
|
paul@0 | 81 |
|
paul@0 | 82 | http://moinmo.in/ActionMarket/ExportPDF
|
paul@0 | 83 |
|
paul@0 | 84 | The author of this packaging of the original work can be contacted at the
|
paul@0 | 85 | following e-mail address:
|
paul@0 | 86 |
|
paul@0 | 87 | paul@boddie.org.uk
|
paul@0 | 88 |
|
paul@0 | 89 | Copyright and licence information can be found in the docs directory - see
|
paul@0 | 90 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@0 | 91 |
|
paul@0 | 92 | Release Procedures
|
paul@0 | 93 | ------------------
|
paul@0 | 94 |
|
paul@0 | 95 | Update the actions/ExportPDF.py __version__ attribute.
|
paul@0 | 96 | Change the version number and package filename/directory in the documentation.
|
paul@0 | 97 | Update the release notes (see above).
|
paul@0 | 98 | Tag, export.
|
paul@0 | 99 | Archive, upload.
|
paul@0 | 100 | Update the ActionMarket and ActionMarket/ExportPDF page.
|