MoinSupport

README.txt

47:20debfa748c8
2013-04-19 Paul Boddie Reverted the change to using path tuples in item store initialisation. Added a last-modified time method to item directory stores.
     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. The ItemSupport module only imports file-locking
     9 functionality from MoinMoin and could potentially be used independently.
    10 
    11 Installation
    12 ------------
    13 
    14 To install the support library, consider using the moinsetup tool. See the
    15 "Recommended Software" section below for more information.
    16 
    17 With moinsetup and a suitable configuration file, the installation is done as
    18 follows with $MSDIR referring to the MoinSupport distribution directory
    19 containing this README.txt file:
    20 
    21   python moinsetup.py -f moinsetup.cfg -m install_extension_package $MSDIR
    22 
    23 The command above uses the setup.py script provided as follows:
    24 
    25   python setup.py install --prefix=path-to-moin-prefix
    26 
    27 Recommended Software
    28 --------------------
    29 
    30 See the "Dependencies" section below for essential software.
    31 
    32 The moinsetup tool is recommended for installation since it aims to support
    33 all versions of MoinMoin that are supported for use with this software.
    34 
    35 See the following page for information on moinsetup:
    36 
    37 http://moinmo.in/ScriptMarket/moinsetup
    38 
    39 Contact, Copyright and Licence Information
    40 ------------------------------------------
    41 
    42 See the following Web pages for more information about this work:
    43 
    44 http://hgweb.boddie.org.uk/MoinSupport
    45 
    46 The author can be contacted at the following e-mail address:
    47 
    48 paul@boddie.org.uk
    49 
    50 Copyright and licence information can be found in the docs directory - see
    51 docs/COPYING.txt and docs/LICENCE.txt for more information.
    52 
    53 Dependencies
    54 ------------
    55 
    56 MoinSupport has the following basic dependencies:
    57 
    58 Packages                    Release Information
    59 --------                    -------------------
    60 
    61 pytz                        Tested with 2007k (specifically 2007k-0ubuntu2)
    62                             Source: http://pytz.sourceforge.net/
    63 
    64 If time zone handling is not required, pytz need not be installed. It is,
    65 however, highly recommended that pytz be installed.
    66 
    67 New in MoinSupport 0.3 (Changes since MoinSupport 0.2)
    68 ------------------------------------------------------
    69 
    70   * Added macro argument parsing from MoinForms and a function to find parsers
    71     by content type.
    72   * Introduced support for reverse iteration over stored items.
    73 
    74 New in MoinSupport 0.2 (Changes since MoinSupport 0.1)
    75 ------------------------------------------------------
    76 
    77   * Added section argument processing functions from the ImprovedTableParser
    78     distribution to MoinSupport.
    79   * Added region/section parsing functions to MoinSupport.
    80   * Changed region/section argument/attribute parsing to consider "-" (dash)
    81     as a word character and not a separator.
    82   * Added heading extraction functionality from ImprovedMoinSearch.
    83   * Added parsing/formatting-related functions from EventAggregator and
    84     ImprovedTableParser to MoinSupport.
    85   * Added category-, WikiDict- and various parsing/encoding-related functions
    86     from EventAggregator to MoinSupport.
    87   * Added a header-writing function to MoinSupport.
    88   * Added a getCurrentTime function to DateSupport.
    89   * Added remote resource management from EventAggregator to
    90     MoinRemoteSupport.
    91   * Added general utility functions from EventAggregator as GeneralSupport.
    92   * Added view-related functions from EventAggregator as ViewSupport.
    93   * Added form field dictionary manipulation in the 1.9 compatibility class.
    94   * Added parameterisation of the formatText function so that paragraphs may
    95     be generated for formatted text.
    96   * Added various content/media type functions from EventAggregator and other
    97     projects to ContentTypeSupport.
    98   * Added support for page-specific item storage in MoinSupport.
    99 
   100 Release Procedures
   101 ------------------
   102 
   103 Update the __version__ attributes in the modules and the setup.py version
   104 details.
   105 Change the version number and package filename/directory in the documentation.
   106 Update the setup.py and PKG-INFO files.
   107 Update the release notes (see above).
   108 Tag, export.
   109 Archive, upload.