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