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 ContentTypeSupport, DateSupport, GeneralSupport,
7 LocationSupport and ViewSupport modules which do not themselves import any
8 MoinMoin functionality.
9
10 Installation
11 ------------
12
13 To install the support library, consider using the moinsetup tool. See the
14 "Recommended Software" section below for more information.
15
16 With moinsetup and a suitable configuration file, the installation is done as
17 follows with $MSDIR referring to the MoinSupport distribution directory
18 containing this README.txt file:
19
20 python moinsetup.py -f moinsetup.cfg -m install_extension_package $MSDIR
21
22 The command above uses the setup.py script provided as follows:
23
24 python setup.py install --prefix=path-to-moin-prefix
25
26 Recommended Software
27 --------------------
28
29 See the "Dependencies" section below for essential software.
30
31 The moinsetup tool is recommended for installation since it aims to support
32 all versions of MoinMoin that are supported for use with this software.
33
34 See the following page for information on moinsetup:
35
36 http://moinmo.in/ScriptMarket/moinsetup
37
38 Contact, Copyright and Licence Information
39 ------------------------------------------
40
41 See the following Web pages for more information about this work:
42
43 http://hgweb.boddie.org.uk/MoinSupport
44
45 The author can be contacted at the following e-mail address:
46
47 paul@boddie.org.uk
48
49 Copyright and licence information can be found in the docs directory - see
50 docs/COPYING.txt and docs/LICENCE.txt for more information.
51
52 Dependencies
53 ------------
54
55 MoinSupport has the following basic dependencies:
56
57 Packages Release Information
58 -------- -------------------
59
60 pytz Tested with 2007k (specifically 2007k-0ubuntu2)
61 Source: http://pytz.sourceforge.net/
62
63 If time zone handling is not required, pytz need not be installed. It is,
64 however, highly recommended that pytz be installed.
65
66 New in MoinSupport 0.5 (Changes since MoinSupport 0.4.1)
67 --------------------------------------------------------
68
69 * Moved ItemStore and related functionality into ItemSupport.
70 * Added support for subpage-based item stores.
71 * Added groupHasMember from ApproveChanges.
72 * Added the TokenSupport module to try and have a reliable shell-like
73 tokeniser.
74 * Added RFC 2822 datetime formatting.
75 * Added a "raw" parser which just formats its input as text.
76 * Added page-related caching functions.
77
78 New in MoinSupport 0.4.1 (Changes since MoinSupport 0.4)
79 --------------------------------------------------------
80
81 * Introduced an explicit error condition where pytz is not installed and an
82 attempt is made to inspect Olson time zone information.
83 * Fixed DateSupport to handle NonExistentTimeError.
84 * Added macro argument quoting functions.
85 * Fixed the quoting of text presented as an argument to the Verbatim macro.
86 * Fixed the extraction of "verbatim" text in getSimpleWikiText.
87
88 New in MoinSupport 0.4 (Changes since MoinSupport 0.3)
89 ------------------------------------------------------
90
91 * Added a function to MoinRemoteSupport to read and return cached item
92 metadata.
93 * Fixed the ISO 8601 representations of datetimes and added ISO 8601
94 datetime parsing support.
95 * Fixed the time zone information associated with page revisions.
96 * Added RFC 2822 datetime parsing with help from the email.utils module.
97 * Added a common wikidict entry parsing function.
98 * Added a superuser parameter to getWikiDict to make the function usable by
99 auth handlers.
100 * Added various parsing and formatting utility methods for enhanced parsers.
101 * Introduced conversion to Unicode around StringIO usage, such as in the
102 formatting of output not immediately sent in response to a request.
103
104 New in MoinSupport 0.3 (Changes since MoinSupport 0.2)
105 ------------------------------------------------------
106
107 * Added macro argument parsing from MoinForms and a function to find parsers
108 by content type.
109 * Introduced support for reverse iteration over stored items.
110 * Expanded the stored metadata for cached remote resources in
111 MoinRemoteSupport.
112 * Changed DateSupport to permit identical timespan instants (whose start and
113 end times are identical) to be recognised as such when compared.
114
115 New in MoinSupport 0.2 (Changes since MoinSupport 0.1)
116 ------------------------------------------------------
117
118 * Added section argument processing functions from the ImprovedTableParser
119 distribution to MoinSupport.
120 * Added region/section parsing functions to MoinSupport.
121 * Changed region/section argument/attribute parsing to consider "-" (dash)
122 as a word character and not a separator.
123 * Added heading extraction functionality from ImprovedMoinSearch.
124 * Added parsing/formatting-related functions from EventAggregator and
125 ImprovedTableParser to MoinSupport.
126 * Added category-, WikiDict- and various parsing/encoding-related functions
127 from EventAggregator to MoinSupport.
128 * Added a header-writing function to MoinSupport.
129 * Added a getCurrentTime function to DateSupport.
130 * Added remote resource management from EventAggregator to
131 MoinRemoteSupport.
132 * Added general utility functions from EventAggregator as GeneralSupport.
133 * Added view-related functions from EventAggregator as ViewSupport.
134 * Added form field dictionary manipulation in the 1.9 compatibility class.
135 * Added parameterisation of the formatText function so that paragraphs may
136 be generated for formatted text.
137 * Added various content/media type functions from EventAggregator and other
138 projects to ContentTypeSupport.
139 * Added support for page-specific item storage in MoinSupport.
140
141 Release Procedures
142 ------------------
143
144 Update the __version__ attributes in the modules and the setup.py version
145 details.
146 Change the version number and package filename/directory in the documentation.
147 Update the setup.py and PKG-INFO files.
148 Update the release notes (see above).
149 Tag, export.
150 Archive, upload.