1 .. -*- mode: rst; coding: utf-8 -*-
3 ======================================================================
4 mwlib.rl - reportlab pdf writer
5 ======================================================================
9 ======================================================================
10 mwlib.rl provides a library for writing pdf documents from mediawiki_
11 articles which were parsed by the mwlib library.
15 ======================================================================
16 You need to have setuptools/easy_install installed. Installation
17 should be as easy as typing::
19 $ easy_install mwlib.rl
21 If you don't have setuptools installed, download the source package,
24 $ python setup.py install
26 (this will also install setuptools)
29 You have to make sure that *texvc* is in your system PATH. *texvc*
30 is supplied by the mediawiki installation. It should be located in
31 the following directory: mediawiki_install_path/math
36 * AMS* packages for LaTeX (maybe included in LaTex distribution)
41 mwlib parses mediawiki articles
44 for source code formatting
45 http://pygments.org/ (debian packet: python-pygments)
48 package for handling bidirectional (right-to-left / left-to-right) text. gnu freebidi and the python bindings are needed
49 http://fribidi.freedesktop.org/wiki/ (debian packages: libfribidi0 and libfribidi-dev)
50 http://pyfribidi.sourceforge.net/index.html (debian packages: python-pyfribidi)
55 ======================================================================
57 Customizing the resulting PDFs is possible by adding a custom configuration file.
58 The file needs to named customconfig.py and should reside next to the pdfstyles.py file.
59 Basically you can override anything in the pdfstyles.py file with your custom configuration.
60 Any changes need to be done with care in order not to break things!
61 Check the pdfstyles.py file for more information.
64 Contact/Further Information
65 ======================================================================
66 For further information please visit our trac instance running at
67 http://code.pediapress.com
68 The current development version can also be found there.
72 ======================================================================
73 Copyright (c) 2007, 2008 PediaPress GmbH
77 Redistribution and use in source and binary forms, with or without
78 modification, are permitted provided that the following conditions are
81 * Redistributions of source code must retain the above copyright
82 notice, this list of conditions and the following disclaimer.
84 * Redistributions in binary form must reproduce the above
85 copyright notice, this list of conditions and the following
86 disclaimer in the documentation and/or other materials provided
87 with the distribution.
89 * Neither the name of PediaPress GmbH nor the names of its
90 contributors may be used to endorse or promote products derived
91 from this software without specific prior written permission.
93 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
94 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
95 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
96 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
97 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
98 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
99 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
100 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
101 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
102 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
103 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
105 .. _mediawiki: http://www.mediawiki.org