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