1 Introduction
2 ------------
3
4 The MoinSupport distribution provides support libraries for use by MoinMoin
5 extensions. Some of the provided modules can be used independently of
6 MoinMoin, such as the DateSupport and LocationSupport modules which do not
7 themselves import any MoinMoin functionality.
8
9 Installation
10 ------------
11
12 To install the support library, consider using the moinsetup tool. See the
13 "Recommended Software" section below for more information.
14
15 With moinsetup and a suitable configuration file, the installation is done as
16 follows with $MSDIR referring to the MoinSupport distribution directory
17 containing this README.txt file:
18
19 python moinsetup.py -f moinsetup.cfg -m install_extension_package $MSDIR
20
21 The command above uses the setup.py script provided as follows:
22
23 python setup.py install --prefix=path-to-moin-prefix
24
25 Recommended Software
26 --------------------
27
28 See the "Dependencies" section below for essential software.
29
30 The moinsetup tool is recommended for installation since it aims to support
31 all versions of MoinMoin that are supported for use with this software.
32
33 See the following page for information on moinsetup:
34
35 http://moinmo.in/ScriptMarket/moinsetup
36
37 Contact, Copyright and Licence Information
38 ------------------------------------------
39
40 See the following Web pages for more information about this work:
41
42 http://hgweb.boddie.org.uk/MoinSupport
43
44 The author can be contacted at the following e-mail address:
45
46 paul@boddie.org.uk
47
48 Copyright and licence information can be found in the docs directory - see
49 docs/COPYING.txt and docs/LICENCE.txt for more information.
50
51 Dependencies
52 ------------
53
54 MoinSupport has the following basic dependencies:
55
56 Packages Release Information
57 -------- -------------------
58
59 pytz Tested with 2007k (specifically 2007k-0ubuntu2)
60 Source: http://pytz.sourceforge.net/
61
62 If time zone handling is not required, pytz need not be installed. It is,
63 however, highly recommended that pytz be installed.
64
65 New in MoinSupport 0.2 (Changes since MoinSupport 0.1)
66 ------------------------------------------------------
67
68 * Added section argument processing functions from the ImprovedTableParser
69 distribution to MoinSupport.
70 * Added region/section parsing functions to MoinSupport.
71 * Added heading extraction functionality from ImprovedMoinSearch.
72 * Added parsing/formatting-related functions from EventAggregator and
73 ImprovedTableParser to MoinSupport.
74 * Added category-, WikiDict- and various parsing/encoding-related functions
75 from EventAggregator to MoinSupport.
76 * Added a header-writing function to MoinSupport.
77 * Added a getCurrentTime function to DateSupport.
78 * Added remote resource management from EventAggregator to
79 MoinRemoteSupport.
80 * Added general utility functions from EventAggregator as GeneralSupport.
81 * Added view-related functions from EventAggregator as ViewSupport.
82
83 Release Procedures
84 ------------------
85
86 Update the __version__ attributes in the modules and the setup.py version
87 details.
88 Change the version number and package filename/directory in the documentation.
89 Update the setup.py and PKG-INFO files.
90 Update the release notes (see above).
91 Tag, export.
92 Archive, upload.
